Package com.openinventor.inventor.nodes

Enum SoBBox.Modes

java.lang.Object

java.lang.Enum<SoBBox.Modes>

com.openinventor.inventor.nodes.SoBBox.Modes

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoBBox.Modes>

Enclosing class:

SoBBox

public static enum SoBBox.Modes
extends java.lang.Enum<SoBBox.Modes>
implements IntegerValuedEnum

This enum specifies how the node interacts with OpenInventor during a traversal.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLE	The node doesn't do anything.
NO_BOUNDING_BOX	SoGetBoundingBoxAction will ignore subsequent nodes in this portion of the scene graph (as if the nodes don't exist).
USER_DEFINED	SoGetBoundingBoxAction will ignore subsequent nodes in this portion of the scene graph and use the box specified in the boundingBox field as the bounding box of those nodes.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLE

public static final SoBBox.Modes DISABLE

The node doesn't do anything.

NO_BOUNDING_BOX

public static final SoBBox.Modes NO_BOUNDING_BOX

SoGetBoundingBoxAction will ignore subsequent nodes in this portion of the scene graph (as if the nodes don't exist).

USER_DEFINED

public static final SoBBox.Modes USER_DEFINED

SoGetBoundingBoxAction will ignore subsequent nodes in this portion of the scene graph and use the box specified in the boundingBox field as the bounding box of those nodes. When the complexity type is BOUNDING_BOX (see SoComplexity), SoGLRenderAction will ignore subsequent nodes in this portion of the scene graph and render the box specified in the boundingBox field.

Method Detail

values

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

Returns:

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

valueOf

public static SoBBox.Modes 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

valueOf

public static SoBBox.Modes valueOf(int val)

Returns the enum constant of this type with the specified integer value

Returns:

the enum constant of this type with the specified integer value.

getValue

public int getValue()

Description copied from interface: IntegerValuedEnum

Returns the integer value of the enum constant.

Specified by:

getValue in interface IntegerValuedEnum

Returns:

the integer value of the enum constant.