Class DMCPolygon

Object
   |
   +--DMCPoly
         |
         +--DMCPolygon

class DMCPolygon

extends DMCPoly

DMCPolygon is a class that represents a polygon
Defined in APIJS.js

Constructor Detail

DMCPolygon

DMCPolygon( pointArray )

Constructs a DMCPolygon

Parameters:
DMCPoint - [] } pointArray Array of DMCPoints that represent the polygon. The last point should equal the first point.

base

Object base(pointArray, type)

contains

bool contains( <DMCPoint> p)

Returns true if the point is contained in the geometry

Parameters:
p - A DMCPoint

Returns:
true if the point is contained in the geometry

getArea

int getArea()

Returns the area of the line string. Always 0

Returns:
the area of the line string. Always 0

getAreaForInput

Object getAreaForInput( inPoints )

getAveragePosition

Object getAveragePosition()

getCenter

DMCPoint getCenter()

Returns a center point guaranteed to be inside the polygon

Returns:
a center point guaranteed to be inside the polygon

getCentroid

DMCPoint getCentroid()

Returns the centroid of the polygon

Returns:
the centroid of the polygon

getClone

Object getClone()

getVertex

DMCPoint getVertex( <int> index)

Returns the vertex at the specified index

Parameters:
index - Index of vertex

Returns:
the vertex

getVertexCount

int getVertexCount()

Returns the vertex count

Returns:
the vertex count

horizontalSegments

Object horizontalSegments( inPointArray, segWidths, segCenters, y, hei )

intersects

bool intersects( <DMCPoint> geometry)

Returns true if the geometry intersects this geometry.

Parameters:
geometry - A DMCPoint

Returns:
true if the geometry intersects this geometry.

isClockWise

Object isClockWise()

Retrun a boolean value to indicate whether this polygon is clockwise

Parameters:
poly - an input polygon Note: This function is not currently in use (it should be correct though)

toString

string toString()

Returns the WKT representation

Returns:
the WKT representation