org.kynosarges.tektosyne.geometry

Enum PolygonLocation

java.lang.Object

java.lang.Enum<PolygonLocation>

org.kynosarges.tektosyne.geometry.PolygonLocation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PolygonLocation>

public enum PolygonLocation
extends java.lang.Enum<PolygonLocation>

Specifies the location of a point relative to an arbitrary polygon. Specifies the possible return values of the GeoUtils.pointInPolygon(org.kynosarges.tektosyne.geometry.PointD, org.kynosarges.tektosyne.geometry.PointD[]) algorithm.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDGE Specifies that the point coincides with an edge of the polygon.
INSIDE Specifies that the point is inside the polygon.
OUTSIDE Specifies that the point is outside the polygon.
VERTEX Specifies that the point coincides with a vertex of the polygon.

Method Summary

Modifier and Type	Method and Description
static PolygonLocation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PolygonLocation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSIDE

public static final PolygonLocation INSIDE

Specifies that the point is inside the polygon.

OUTSIDE

public static final PolygonLocation OUTSIDE

Specifies that the point is outside the polygon.

EDGE

public static final PolygonLocation EDGE

Specifies that the point coincides with an edge of the polygon.

VERTEX

public static final PolygonLocation VERTEX

Specifies that the point coincides with a vertex of the polygon.

Method Detail

values

public static PolygonLocation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PolygonLocation c : PolygonLocation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PolygonLocation valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null