Polygon (Groovy Documentation)

geoscript.geom.Polygon

A Polygon Geometry.

You can create a Polygon with no holes by providing a LinearRing:

 Polygon p = new Polygon(new LinearRing([[1,1],[4,1],[4,4],[1,1]]))

Or you can create a Polygon with an exterior LinearRing and a List of hole LinearRings:

 Polygon p = new Polygon(new LinearRing([1,1], [10,1], [10,10], [1,10], [1,1]), [new LinearRing([2,2], [4,2], [4,4], [2,4], [2,2]), new LinearRing([5,5], [6,5], [6,6], [5,6], [5,5])])

Or you can create a Polygon with no holes by providing a variable List of Doubles:

 Polygon p = new Polygon([1,2],[3,4],[5,6],[1,2])

Or you can create a Polygon a List of a List of a List of Doubles. The first List of List of Doubles is the exterior ring. Others are holes.

 Polygon p = new Polygon([[[1,2],[3,4],[5,6],[1,2]]])

Or you can create a Polygon a List LinearRings. The first List of List of Doubles is the exterior ring. Others are holes.

 Polygon p = new Polygon([new LinearRing([1,1], [10,1], [10,10], [1,10], [1,1]), new LinearRing([2,2], [4,2], [4,4], [2,4], [2,2]), new LinearRing([5,5], [6,5], [6,6], [5,6], [5,5])])

Authors:: Jared Erickson

Constructor Summary

Constructors
Constructor and description
`Polygon (Polygon poly)` Create a new Polygon by wrapping a JTS Polygon.
`Polygon (LinearRing ring)` Create a Polygon with no holes.
`Polygon (LinearRing ring, java.util.List<LinearRing> holes)` Create a new Polygon with an exterior ring and a List of holes.
`Polygon (java.util.List<java.lang.Double>... ring)` Create a new Polygon with an exterior ring as a List of List of Doubles
`Polygon (java.util.List rings)` Create a new Polygon from a List of a List of a List of Doubles or LinearRings.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`LineString`	`getExteriorRing()` Get the exterior ring or shell
	`LineString`	`getInteriorRingN(int n)` Get the nth interior ring or hole
	`java.util.List<LineString>`	`getInteriorRings()` Get a List of all interior rings
	`int`	`getNumInteriorRing()` Get the number of interior rings or holes
	`MultiPolygon`	`plus(Polygon poly)` Add this Polygon with another to create a 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 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, getLength, 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, within, wrap

- Constructor Detail
  - Polygon(Polygon poly)
    
    Create a new Polygon by wrapping a JTS Polygon.
    Parameters:
    poly - A JTS Polygon
  - Polygon(LinearRing ring)
    
    Create a Polygon with no holes.
```
 Polygon p = new Polygon(new LinearRing([[1,1],[4,1],[4,4],[1,1]]))
 
```
    Parameters:
    ring - A LinearRing
  - Polygon(LinearRing ring, java.util.List<LinearRing> holes)
    
    Create a new Polygon with an exterior ring and a List of holes.
```
 Polygon p = new Polygon(new LinearRing([1,1], [10,1], [10,10], [1,10], [1,1]), [new LinearRing([2,2], [4,2], [4,4], [2,4], [2,2]), new LinearRing([5,5], [6,5], [6,6], [5,6], [5,5])])
 
```
    Parameters:
    ring - A LinearRing for the exterior shell
    holes - A List of LinearRings for the holes
  - Polygon(java.util.List<java.lang.Double>... ring)
    
    Create a new Polygon with an exterior ring as a List of List of Doubles
```
 Polygon p = new Polygon([1,2],[3,4],[5,6],[1,2])
 
```
    Parameters:
    ring - A variable List of List of Doubles
  - Polygon(java.util.List rings)
    
    Create a new Polygon from a List of a List of a List of Doubles or LinearRings. The first List of List of Doubles is the exterior ring. Others are holes.
```
 Polygon p = new Polygon([[[1,2],[3,4],[5,6],[1,2]]])
 Polygon p = new Polygon([new LinearRing([1,1], [10,1], [10,10], [1,10], [1,1]), new LinearRing([2,2], [4,2], [4,4], [2,4], [2,2]), new LinearRing([5,5], [6,5], [6,6], [5,6], [5,5])])
 
```
    Parameters:
    rings - A List of LinearRings or a List of List of Doubles
- Method Detail
  - LineString getExteriorRing()
    
    Get the exterior ring or shell
    Returns:
    The exterior ring or shell
  - LineString getInteriorRingN(int n)
    
    Get the nth interior ring or hole
    Parameters:
    n - The index of a interior ring or hole
    Returns:
    The nth interior ring or hole
  - java.util.List<LineString> getInteriorRings()
    
    Get a List of all interior rings
    Returns:
    A List of all interior rings
  - int getNumInteriorRing()
    
    Get the number of interior rings or holes
    Returns:
    The number of interior rings or holes
  - MultiPolygon plus(Polygon poly)
    
    Add this Polygon with another to create a MultiPolygon.
    Parameters:
    poly - The other 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 Polygon

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Polygon(Polygon poly)

Polygon(LinearRing ring)

Polygon(LinearRing ring, java.util.List<LinearRing> holes)

Polygon(java.util.List<java.lang.Double>... ring)

Polygon(java.util.List rings)

Method Detail

LineString getExteriorRing()

LineString getInteriorRingN(int n)

java.util.List<LineString> getInteriorRings()

int getNumInteriorRing()

MultiPolygon plus(Polygon poly)

Geometry split(LineString lineString)

Geometry split(MultiLineString multiLineString)