org.openmali.spatial
Enum PlaneIndicator

java.lang.Object
  extended by java.lang.Enum<PlaneIndicator>
      extended by org.openmali.spatial.PlaneIndicator
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<PlaneIndicator>

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

Abstraction of the planes of a coordinate system.


Enum Constant Summary
X_Y_PLANE
           
X_Z_PLANE
           
Z_Y_PLANE
           
 
Method Summary
 AxisIndicator getNormalAxis()
           
 Vector3f getNormalVector()
           
static PlaneIndicator valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static PlaneIndicator[] 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

X_Y_PLANE

public static final PlaneIndicator X_Y_PLANE

X_Z_PLANE

public static final PlaneIndicator X_Z_PLANE

Z_Y_PLANE

public static final PlaneIndicator Z_Y_PLANE
Method Detail

values

public static PlaneIndicator[] 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 (PlaneIndicator c : PlaneIndicator.values())
    System.out.println(c);

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

valueOf

public static PlaneIndicator 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

getNormalAxis

public final AxisIndicator getNormalAxis()

getNormalVector

public final Vector3f getNormalVector()