remixlab.dandelion.constraint

Enum AxisPlaneConstraint.Type

java.lang.Object

java.lang.Enum<AxisPlaneConstraint.Type>

remixlab.dandelion.constraint.AxisPlaneConstraint.Type

All Implemented Interfaces:

Serializable, Comparable<AxisPlaneConstraint.Type>

Enclosing class:

AxisPlaneConstraint

public static enum AxisPlaneConstraint.Type
extends Enum<AxisPlaneConstraint.Type>

Type lists the different types of translation and rotation constraints that are available.

It specifies the meaning of the constraint direction (see AxisPlaneConstraint.translationConstraintDirection() and AxisPlaneConstraint.rotationConstraintDirection() ): as an axis direction or a plane normal. FREE means no constraint while FORBIDDEN completely forbids the translation and/or the rotation. Attention: The PLANE Type is not valid for rotational constraint.

New derived classes can use their own extended enum for specific constraints.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AXIS
FORBIDDEN
FREE
PLANE

Method Summary

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

FREE

public static final AxisPlaneConstraint.Type FREE

AXIS

public static final AxisPlaneConstraint.Type AXIS

PLANE

public static final AxisPlaneConstraint.Type PLANE

FORBIDDEN

public static final AxisPlaneConstraint.Type FORBIDDEN

Method Detail

values

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

Returns:

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

valueOf

public static AxisPlaneConstraint.Type valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null