edu.ucdavis.cstars.client.geometry

Class Polyline

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.geometry.Geometry

edu.ucdavis.cstars.client.geometry.Polyline

public class Polyline
extends Geometry

An array of paths where each path is an array of points.

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
Polyline	addPath(Ring path) Adds a path to the Polyline.
static Polyline	create(com.google.gwt.core.client.JavaScriptObject json) Creates a new Polyline object using a JSON object.
static Polyline	create(SpatialReference sr) Creates a new Polyline object.
Extent	getExtent() Returns the extent of the Polyline.
RingGroup	getPaths() An array of paths.
Point	getPoint(int pathIndex, int pointIndex) Returns a point specified by a path and point in the path.
Polyline	insertPoint(int pathIndex, int pointIndex, Point point) Inserts a new point into a polyline.
com.google.gwt.core.client.JsArray<Point>	removePath(int pathIndex) Removes a path from the Polyline.
Point	removePoint(int pathIndex, int pointIndex) Remove a point from the polyline at the given pointIndex within the path identified by the given pathIndex.
Polyline	setPoint(int pathIndex, int pointIndex, Point point) Updates a point in a polyline.

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 Polyline create(SpatialReference sr)

Creates a new Polyline object.

Parameters:

sr - - Spatial reference of the geometry.

Returns:

Polyline

create

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

Creates a new Polyline object using a JSON object.

Parameters:

json - - JSON object representing the geometry.

Returns:

Polyline

getPaths

public final RingGroup getPaths()

An array of paths. Each path is made up of an array of two or more points.

Returns:

RingGroup

addPath

public final Polyline addPath(Ring path)

Adds a path to the Polyline.

Parameters:

path - - An array of x,y coordinate pairs to create a path.

Returns:

Polyline

getExtent

public final Extent getExtent()

Returns the extent of the Polyline.

Returns:

Extent

getPoint

public final Point getPoint(int pathIndex,
             int pointIndex)

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

Parameters:

pathIndex - - The index of a path in a polyline.

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

Returns:

Point

insertPoint

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

Inserts a new point into a polyline.

Parameters:

pathIndex - - Path index to insert point.

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

point - - Point to insert into the path.

Returns:

Polyline

removePath

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

Removes a path from the Polyline. The index specifies which path to remove.

Parameters:

pathIndex - - The index of a path to remove.

Returns:

JsArray

removePoint

public final Point removePoint(int pathIndex,
                int pointIndex)

Remove a point from the polyline at the given pointIndex within the path identified by the given pathIndex.

Parameters:

pathIndex - - The index of the path containing the point.

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

Returns:

Point

setPoint

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

Updates a point in a polyline.

Parameters:

pathIndex - - Path index for updated point.

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

point - - Point to update in the path.

Returns:

Polyline