com.esri.core.geometry
Class Polygon

java.lang.Object
  com.esri.core.geometry.Geometry
      com.esri.core.geometry.MultiPath
          com.esri.core.geometry.Polygon

All Implemented Interfaces:

Serializable

public final class Polygon
extends MultiPath
implements Serializable

A polygon is a collection of one or many interior or exterior rings.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.esri.core.geometry.Geometry

Geometry.Type

Field Summary

Fields inherited from class com.esri.core.geometry.MultiPath

m_impl

Fields inherited from class com.esri.core.geometry.Geometry

m_description, m_touchFlag

Constructor Summary

Polygon()
Creates a polygon.

Method Summary

double	calculateRingArea2D(int ringIndex) Calculates the ring area for this ring.
Geometry	createInstance() Creates an instance of an empty geometry of the same type.
boolean	equals(Object other) Returns TRUE when this geometry has exactly same type, properties, and coordinates as the other geometry.
int	getDimension() Returns the topological dimension of the geometry object based on the geometry's type.
void	getPoint(int index, Point ptOut) Returns given vertex of the Geometry by value.
Geometry.Type	getType() Returns the geometry type.
int	hashCode() Returns a hash code value for this polygon.
void	setXY(int i, double x, double y) Sets a new vertex for the polygon.

Methods inherited from class com.esri.core.geometry.MultiPath

_getImpl, add, addEnvelope, addPath, addSegment, applyTransformation, calculateArea2D, calculateLength2D, closeAllPaths, closePathWithLine, copyTo, getPathCount, getPathEnd, getPathIndexFromPointIndex, getPathSize, getPathStart, getPoint, getPointCount, getSegmentCount, getSegmentCount, getStateFlag, insertPath, insertPoint, insertPoints, isClosedPath, isEmpty, lineTo, lineTo, queryEnvelope, querySegmentIterator, querySegmentIteratorAtVertex, removePath, removePoint, reverseAllPaths, reversePath, setEmpty, setPoint, startPath, startPath

Methods inherited from class com.esri.core.geometry.Geometry

copy, getDimensionFromType, isArea, isLinear, isMultiPath, isMultiVertex, isPoint, isSegment

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Polygon

public Polygon()

Creates a polygon.

Since:

1.0

Method Detail

createInstance

public Geometry createInstance()

Description copied from class: Geometry

Creates an instance of an empty geometry of the same type.

Since:

1.0

getDimension

public int getDimension()

Description copied from class: Geometry

Returns the topological dimension of the geometry object based on the geometry's type.

Returns 0 for point and multipoint.

Returns 1 for lines and polylines.

Returns 2 for polygons and envelopes

Returns 3 for objects with volume

Specified by:

getDimension in class Geometry

Returns:

Returns the integer value of the dimension of geometry.

Since:

1.0

getType

public Geometry.Type getType()

Description copied from class: Geometry

Returns the geometry type.

Specified by:

getType in class Geometry

Returns:

Returns the geometry type.

Since:

1.0

calculateRingArea2D

public double calculateRingArea2D(int ringIndex)

Calculates the ring area for this ring.

Parameters:

ringIndex - The index of this ring.

Returns:

The ring area for this ring.

Since:

1.0

equals

public boolean equals(Object other)

Returns TRUE when this geometry has exactly same type, properties, and coordinates as the other geometry.

Overrides:

equals in class Object

Since:

1.0

hashCode

public int hashCode()

Returns a hash code value for this polygon.

Overrides:

hashCode in class MultiPath

Since:

1.0

setXY

public void setXY(int i,
                  double x,
                  double y)

Sets a new vertex for the polygon.

Parameters:

i - The index of the new vertex.

x - The X coordinate for the new vertex.

y - The Y coordinate for the new vertex.

Since:

1.0

getPoint

public void getPoint(int index,
                     Point ptOut)

Returns given vertex of the Geometry by value.