com.acarter.scenemonitor.textdescriptor.definitions
Enum SpatialDescriptor.E_BoundingVolume

java.lang.Object
  extended by java.lang.Enum<SpatialDescriptor.E_BoundingVolume>
      extended by com.acarter.scenemonitor.textdescriptor.definitions.SpatialDescriptor.E_BoundingVolume
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SpatialDescriptor.E_BoundingVolume>
Enclosing class:
SpatialDescriptor

protected static enum SpatialDescriptor.E_BoundingVolume
extends java.lang.Enum<SpatialDescriptor.E_BoundingVolume>

Enumerates the permissible bounding volume types.

Author:
Andrew Carter

Enum Constant Summary
BOX
           
CAPSULE
           
NONE
           
ORIENTEDBOX
           
SPHERE
           
 
Method Summary
static SpatialDescriptor.E_BoundingVolume getConstant(java.lang.String name)
          Returns the enum constant matching the name string.
 java.lang.String getType()
          Returns the integer value of the constant.
 java.lang.String toString()
          Returns the string value of the constant.
static SpatialDescriptor.E_BoundingVolume valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SpatialDescriptor.E_BoundingVolume[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

NONE

public static final SpatialDescriptor.E_BoundingVolume NONE

BOX

public static final SpatialDescriptor.E_BoundingVolume BOX

CAPSULE

public static final SpatialDescriptor.E_BoundingVolume CAPSULE

SPHERE

public static final SpatialDescriptor.E_BoundingVolume SPHERE

ORIENTEDBOX

public static final SpatialDescriptor.E_BoundingVolume ORIENTEDBOX
Method Detail

values

public static final SpatialDescriptor.E_BoundingVolume[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(SpatialDescriptor.E_BoundingVolume c : SpatialDescriptor.E_BoundingVolume.values())
        System.out.println(c);

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

valueOf

public static SpatialDescriptor.E_BoundingVolume 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

getConstant

public static SpatialDescriptor.E_BoundingVolume getConstant(java.lang.String name)
Returns the enum constant matching the name string.

Parameters:
name - string value of enum constant
Returns:
matching enum constant or null

toString

public java.lang.String toString()
Returns the string value of the constant.

Overrides:
toString in class java.lang.Enum<SpatialDescriptor.E_BoundingVolume>

getType

public java.lang.String getType()
Returns the integer value of the constant.

Returns: