edu.ucdavis.cstars.client.geometry

Class Polygon

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.geometry.Geometry

edu.ucdavis.cstars.client.geometry.Polygon

public class Polygon
extends Geometry

An array of rings where each ring is an array points. The first and last points of a ring must be the same.

Author:

Justin Merz

Nested Class Summary

Nested classes/interfaces inherited from class edu.ucdavis.cstars.client.geometry.Geometry

Geometry.GeometryType

Method Summary

Methods

Modifier and Type	Method and Description
Polygon	addRing(Ring ring) Adds a ring to the Polygon.
boolean	contains(Point point) Checks on the client if the specified point is inside the polygon.
static Polygon	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new Polygon object using a JSON object.
static Polygon	create(SpatialReference sr) Creates a new Polygon object.
Extent	getExtent() Returns the extent of the polygon.
Point	getPoint(int pathIndex, int pointIndex) Returns a point specified by a ring and point in the path.
RingGroup	getRings() An array of rings.
Polygon	insertPoint(int pathIndex, int pointIndex, Point point) Inserts a new point into a polygon.
Point	removePoint(int ringIndex, int pointIndex) Remove a point from the polygon at the given pointIndex within the ring identified by ringIndex.
com.google.gwt.core.client.JsArray<Point>	removeRing(int pathIndex) Removes a ring from the Polygon.
Polygon	setPoint(int pathIndex, int pointIndex, Point point) Updates a point in a polygon.

Methods inherited from class edu.ucdavis.cstars.client.geometry.Geometry

fromJson, geographicToWebMercator, getExtentForScale, getJson, getJsonType, getLength, getLineIntersection, getScale, getSpatialReference, getType, isClockwise, setSpatialReference, toJson, toMapGeometry, toMapPoint, toScreenGeometry, toScreenPoint, webMercatorToGeographic

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Polygon create(SpatialReference sr)

Creates a new Polygon object.

Parameters:

sr - - Spatial reference of the geometry.

Returns:

Polygon

create

public static Polygon create(com.google.gwt.core.client.JavaScriptObject json)

Creates a new Polygon object using a JSON object.

Parameters:

json - - JSON object representing the geometry.

Returns:

Polygon

getRings

public final RingGroup getRings()

An array of rings. Each ring is made up of three or more points.

Returns:

RingGroup

addRing

public final Polygon addRing(Ring ring)

Adds a ring to the Polygon.

Parameters:

ring -

Returns:

Polygon

contains

public final boolean contains(Point point)

Checks on the client if the specified point is inside the polygon. A point on the polygon line is considered in.

Parameters:

point - - The location defined by an X- and Y- coordinate in map units.

Returns:

boolean

getExtent

public final Extent getExtent()

Returns the extent of the polygon.

Returns:

Extent

getPoint

public final Point getPoint(int pathIndex,
             int pointIndex)

Returns a point specified by a ring and point in the path.

Parameters:

pathIndex - - The index of a ring.

pointIndex - - The index of a point in a ring.

Returns:

Point

insertPoint

public final Polygon insertPoint(int pathIndex,
                  int pointIndex,
                  Point point)

Inserts a new point into a polygon.

Parameters:

pathIndex - - Ring index to insert point.

pointIndex - - The index of the inserted point in the ring.

point - - Point to insert into the ring.

Returns:

Polygon

removePoint

public final Point removePoint(int ringIndex,
                int pointIndex)

Remove a point from the polygon at the given pointIndex within the ring identified by ringIndex.

Parameters:

ringIndex - - The index of the ring containing the point.

pointIndex - - The index of the point within the ring.

Returns:

Point

removeRing

public final com.google.gwt.core.client.JsArray<Point> removeRing(int pathIndex)

Removes a ring from the Polygon. The index specifies which ring to remove.

Parameters:

pathIndex - - The index of the ring to remove.

Returns:

JsArray

setPoint

public final Polygon setPoint(int pathIndex,
               int pointIndex,
               Point point)

Updates a point in a polygon.

Parameters:

pathIndex - - Ring index for updated point.

pointIndex - - The index of the updated point in the ring.

point - - Point to update in the ring.

Returns:

Polygon