MultiPolygon (Groovy Documentation)

geoscript.geom.MultiPolygon

class MultiPolygon
extends GeometryCollection

A MultiPolygon Geometry.

You can create a MultiPolygon from a variable List of Polygons:

 MultiPolygon mp = new MultiPolygon(new Polygon([1,2],[3,4],[5,6],[1,2]), new Polygon([7,8],[9,10],[11,12],[7,8]))

Or from a variable List of List of Doubles:

 MultiPolygon mp = new MultiPolygon([[[1,2],[3,4],[5,6],[1,2]]], [[[7,8],[9,10],[11,12],[7,8]]])

Or from a List of Polygons:

 MultiPolygon mp = new MultiPolygon([new Polygon([1,2],[3,4],[5,6],[1,2]), new Polygon([7,8],[9,10],[11,12],[7,8])])

Or form a List of List of List of Doubles:

 MultiPolygon mp = new MultiPolygon([[[[1,2],[3,4],[5,6],[1,2]]], [[[7,8],[9,10],[11,12],[7,8]]]])

Authors:: Jared Erickson

Constructor Summary

Constructors
Constructor and description
`MultiPolygon (MultiPolygon multiPolygon)` Create a MultiPolygon that wraps a JTS MultiPolygon
`MultiPolygon (Polygon[] polygons)` Create a MultiPolygon from a variable List of Polygons
`MultiPolygon (java.util.List<java.util.List<java.util.List<java.lang.Double>>>[] polygons)` Create a MultiPolygon from a variable List of List of List of Doubles
`MultiPolygon (java.util.List polygons)` Create a MultiPolygon from a List of Polygons or a List of List of List of Doubles

Methods Summary

Methods
Type Params	Return Type	Name and description
	`MultiPolygon`	`plus(Polygon poly)` Add a Polygon to this MultiPolygon to create another MultiPolygon
	`Geometry`	`split(LineString lineString)` Split a Polygon with a LineString
	`Geometry`	`split(MultiLineString multiLineString)` Split a Polygon with a MultiLineString

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GeometryCollection`	`narrow, plus, slice`
`class Geometry`	asType, buffer, cascadedUnion, contains, coveredBy, covers, createFromText, createKochSnowflake, createRandomPoints, createRandomPointsInGrid, createSierpinskiCarpet, crosses, densify, difference, disjoint, distance, equals, equalsNorm, equalsTopo, fromString, getArea, getAt, getBoundary, getBounds, getCentroid, getConvexHull, getCoordinates, getDelaunayTriangleDiagram, getDimension, getEnvelope, getEnvelopeInternal, getGeometries, getGeometryN, getGeometryType, getInteriorPoint, getLargestEmptyCircle, getLength, getMaximumInscribedCircle, getMinimumBoundingCircle, getMinimumClearance, getMinimumDiameter, getMinimumRectangle, getNearestPoints, getNorm, getNumGeometries, getNumPoints, getOctagonalEnvelope, getPoints, getValidReason, getVoronoiDiagram, hashCode, intersection, intersects, isCurved, isEmpty, isRectangle, isSimple, isValid, isWithinDistance, normalize, offset, overlaps, prepare, prepare, reducePrecision, reflect, reflect, relate, relate, rotate, rotate, rotate, rotate, scale, scale, shear, simplify, simplifyPreservingTopology, singleSidedBuffer, smooth, snap, symDifference, toString, touches, translate, union, union, variableBuffer, within, wrap

- Constructor Detail
  - MultiPolygon(MultiPolygon multiPolygon)
    
    Create a MultiPolygon that wraps a JTS MultiPolygon
    Parameters:
    multiPolygon - The JTS MultiPolygon
  - MultiPolygon(Polygon[] polygons)
    
    Create a MultiPolygon from a variable List of Polygons
```
 MultiPolygon mp = new MultiPolygon(new Polygon([1,2],[3,4],[5,6],[1,2]), new Polygon([7,8],[9,10],[11,12],[7,8]))
 
```
    Parameters:
    polygons - A variable List of Polygons
  - MultiPolygon(java.util.List<java.util.List<java.util.List<java.lang.Double>>>[] polygons)
    
    Create a MultiPolygon from a variable List of List of List of Doubles
```
 MultiPolygon mp = new MultiPolygon([[[1,2],[3,4],[5,6],[1,2]]], [[[7,8],[9,10],[11,12],[7,8]]])
 
```
    Parameters:
    polygons - A variable List of List of Doubles
  - MultiPolygon(java.util.List polygons)
    
    Create a MultiPolygon from a List of Polygons or a List of List of List of Doubles
```
 MultiPolygon mp = new MultiPolygon([new Polygon([1,2],[3,4],[5,6],[1,2]), new Polygon([7,8],[9,10],[11,12],[7,8])])
 MultiPolygon mp = new MultiPolygon([[[[1,2],[3,4],[5,6],[1,2]]], [[[7,8],[9,10],[11,12],[7,8]]]])
 
```
    Parameters:
    polygons - A List of Polygons or a List of List of List of Doubles
- Method Detail
  - MultiPolygon plus(Polygon poly)
    
    Add a Polygon to this MultiPolygon to create another MultiPolygon
```
 def mp1 = new MultiPolygon(new Polygon([1,2],[3,4],[5,6],[1,2]), new Polygon([7,8],[9,10],[11,12],[7,8]))
 def mp2 = mp1 + new Polygon([11,12],[13,14],[15,16],[11,12])

 MULTIPOLYGON (((1 2, 3 4, 5 6, 1 2)), ((7 8, 9 10, 11 12, 7 8)), ((11 12, 13 14, 15 16, 11 12)))
 
```
    Parameters:
    poly - The Polygon to add to this Polygon
    Returns:
    A new MultiPolygon containing this Polygon and the other Polygon
  - Geometry split(LineString lineString)
    
    Split a Polygon with a LineString
    Parameters:
    lineString - The LineString
    Returns:
    The split Geometry
  - Geometry split(MultiLineString multiLineString)
    
    Split a Polygon with a MultiLineString
    Parameters:
    multiLineString - The MultiLineString
    Returns:
    The split Geometry

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class MultiPolygon

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

MultiPolygon(MultiPolygon multiPolygon)

MultiPolygon(Polygon[] polygons)

MultiPolygon(java.util.List<java.util.List<java.util.List<java.lang.Double>>>[] polygons)

MultiPolygon(java.util.List polygons)

Method Detail

MultiPolygon plus(Polygon poly)

Geometry split(LineString lineString)

Geometry split(MultiLineString multiLineString)