Package com.openinventor.inventor.actions

Enum Class SoAction.PathCodes

java.lang.Object

java.lang.Enum<SoAction.PathCodes>

com.openinventor.inventor.actions.SoAction.PathCodes

All Implemented Interfaces:

IntegerValuedEnum, Serializable, Comparable<SoAction.PathCodes>, Constable

Enclosing class:

SoAction

public static enum SoAction.PathCodes
extends Enum<SoAction.PathCodes>
implements IntegerValuedEnum

(Extender API) This enum may be used during traversal of nodes to indicate where the node is with respect to the path being traversed.

Extender API is dedicated to extend the toolkit. This api is available to programmers who wish to extend the toolkit. We strongly suggest to use it only in the cases described in the Toolmaker guide such as creating a new class inherited from SoNode. See Open Inventor Toolmaker.

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
BELOW_PATH	Tail node of path or below tail node.
IN_PATH	In middle of path chain (not tail node)
NO_PATH	Not traversing a path.
OFF_PATH	None of the above (Probably to the left)

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NO_PATH

public static final SoAction.PathCodes NO_PATH

Not traversing a path.

IN_PATH

public static final SoAction.PathCodes IN_PATH

In middle of path chain (not tail node)

BELOW_PATH

public static final SoAction.PathCodes BELOW_PATH

Tail node of path or below tail node.

OFF_PATH

public static final SoAction.PathCodes OFF_PATH

None of the above (Probably to the left)

Method Details

values

public static SoAction.PathCodes[] 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 SoAction.PathCodes 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

valueOf

public static SoAction.PathCodes 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.