com.github.gwtd3.api.geom

Class Polygon

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

com.github.gwtd3.api.arrays.Array<Array<Double>>

com.github.gwtd3.api.geom.Polygon

public class Polygon
extends Array<Array<Double>>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Polygon()

Method Summary

Methods

Modifier and Type	Method and Description
double	area() Returns the signed area of this polygon.
Array<?>	centroid() Returns a two-element array representing the centroid of this polygon.
Array<?>	centroid(double k) Returns a two-element array representing the centroid of this polygon.
Polygon	clip(Array<Array<Double>> subject) Clips the subject polygon against this polygon.

Methods inherited from class com.github.gwtd3.api.arrays.Array

asIterable, asList, concat, concat, concat, concat, concat, create, every, every, filter, filter, forEach, forEach, fromBytes, fromChars, fromDoubles, fromFloats, fromInts, fromIterable, fromJavaArray, fromLongs, fromObjects, fromShorts, get, getBoolean, getInt, getNumber, getObject, getString, getValue, indexOf, indexOf, join, join, lastIndexOf, lastIndexOf, length, map, map, map, pop, popBoolean, popNumber, popObject, popString, push, push, push, push, reverse, set, set, set, set, set, setLength, shiftBoolean, shiftNumber, shiftObject, shiftString, slice, slice, some, some, sortAlphaAsc, sortAlphaDesc, sortNumericAsc, sortNumericDesc, splice, splice, splice, splice, splice, splice, unshift, unshift, unshift, unshift

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

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

Constructor Detail

Polygon

protected Polygon()

Method Detail

area

public final double area()

Returns the signed area of this polygon.

If the vertices are in counterclockwise order, the area is positive, otherwise it is negative.

Returns:

the signed area

centroid

public final Array<?> centroid()

Returns a two-element array representing the centroid of this polygon.

Returns:

a two-element array representing the centroid of this polygon.

centroid

public final Array<?> centroid(double k)

Returns a two-element array representing the centroid of this polygon.

Parameters:

k - a scale factor

Returns:

a two-element array representing the centroid of this polygon.

clip

public final Polygon clip(Array<Array<Double>> subject)

Clips the subject polygon against this polygon.

In other words, returns a polygon representing the intersection of this polygon and the subject polygon.

Assumes the clip polygon is counterclockwise and convex.

Parameters:

subject - the polygon to clip against

Returns:

the clip polygon