Package com.ardor3d.math.type

Enum Class ReadOnlyPlane.Side

java.lang.Object

java.lang.Enum<ReadOnlyPlane.Side>

com.ardor3d.math.type.ReadOnlyPlane.Side

All Implemented Interfaces:

Serializable, Comparable<ReadOnlyPlane.Side>, Constable

Enclosing interface:

ReadOnlyPlane

public static enum ReadOnlyPlane.Side
extends Enum<ReadOnlyPlane.Side>

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
Inside	On the side of the plane opposite of the plane's normal vector.
Neither	Not on either side - in other words, on the plane itself.
Outside	On the same side of the plane as the plane's normal vector.

Method Summary

Modifier and Type	Method	Description
static ReadOnlyPlane.Side	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ReadOnlyPlane.Side[]	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

Inside

public static final ReadOnlyPlane.Side Inside

On the side of the plane opposite of the plane's normal vector.

Outside

public static final ReadOnlyPlane.Side Outside

On the same side of the plane as the plane's normal vector.

Neither

public static final ReadOnlyPlane.Side Neither

Not on either side - in other words, on the plane itself.

Method Details

values

public static ReadOnlyPlane.Side[] 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 ReadOnlyPlane.Side 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