Package nz.org.riskscape.engine.geo

Enum Class HalfPlane

java.lang.Object

java.lang.Enum<HalfPlane>

nz.org.riskscape.engine.geo.HalfPlane

All Implemented Interfaces:

Serializable, Comparable<HalfPlane>, Constable

public enum HalfPlane
extends Enum<HalfPlane>

The 'sides' of each axis. A pair of sides that share an axis form the 2d plane, a pair on different axis form a quadrant

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM
LEFT
RIGHT
TOP

Method Summary

Modifier and Type	Method	Description
HalfPlane	flip()
Axis	getAxis()	The axis that bisects the 2d plane to form our side
boolean	isPositive()	Is this side the positive or negative one, e.g.
static HalfPlane	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HalfPlane[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOP

public static final HalfPlane TOP

RIGHT

public static final HalfPlane RIGHT

BOTTOM

public static final HalfPlane BOTTOM

LEFT

public static final HalfPlane LEFT

Method Details

values

public static HalfPlane[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static HalfPlane valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

flip

public HalfPlane flip()

Returns:

our opposite plane

getAxis

public Axis getAxis()

The axis that bisects the 2d plane to form our side

isPositive

public boolean isPositive()

Is this side the positive or negative one, e.g. coordinates lying in the positive side are all greater than those in the negative side