agi.foundation.coordinates

(agi.foundation.core-2024r3.jar)

Enum EulerSequenceIndicator

java.lang.Object

java.lang.Enum<EulerSequenceIndicator>

agi.foundation.coordinates.EulerSequenceIndicator

All Implemented Interfaces:

Enumeration, Serializable, Comparable<EulerSequenceIndicator>

public enum EulerSequenceIndicator
extends Enum<EulerSequenceIndicator>
implements Enumeration

Indicates the order of the axes rotations in an Euler sequence.

See Also:

EulerSequence

Enum Constant Summary

Enum Constants

Enum Constant and Description
EULER121 The first axes, followed by the second and then first axes.
EULER123 The first axes, followed by the second and then third axes.
EULER131 The first axes, followed by the third and then first axes.
EULER132 The first axes, followed by the third and then second axes.
EULER212 The second axes, followed by the first and then second axes.
EULER213 The second axes, followed by the first and then third axes.
EULER231 The second axes, followed by the third and then first axes.
EULER232 The second axes, followed by the third and then second axes.
EULER312 The third axes, followed by the first and then second axes.
EULER313 The third axes, followed by the first and then third axes.
EULER321 The third axes, followed by the second and then first axes.
EULER323 The third axes, followed by the second and then third axes.

Method Summary

Modifier and Type	Method and Description
static EulerSequenceIndicator	getDefault() Get the enum constant that is considered to be the default.
static EulerSequenceIndicator	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static EulerSequenceIndicator	valueOf(String name) Returns the enum constant of this type with the specified name.
static EulerSequenceIndicator[]	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

EULER123

public static final EulerSequenceIndicator EULER123

The first axes, followed by the second and then third axes.

EULER321

public static final EulerSequenceIndicator EULER321

The third axes, followed by the second and then first axes.

EULER231

public static final EulerSequenceIndicator EULER231

The second axes, followed by the third and then first axes.

EULER132

public static final EulerSequenceIndicator EULER132

The first axes, followed by the third and then second axes.

EULER312

public static final EulerSequenceIndicator EULER312

The third axes, followed by the first and then second axes.

EULER213

public static final EulerSequenceIndicator EULER213

The second axes, followed by the first and then third axes.

EULER212

public static final EulerSequenceIndicator EULER212

The second axes, followed by the first and then second axes.

EULER313

public static final EulerSequenceIndicator EULER313

The third axes, followed by the first and then third axes.

EULER121

public static final EulerSequenceIndicator EULER121

The first axes, followed by the second and then first axes.

EULER323

public static final EulerSequenceIndicator EULER323

The third axes, followed by the second and then third axes.

EULER131

public static final EulerSequenceIndicator EULER131

The first axes, followed by the third and then first axes.

EULER232

public static final EulerSequenceIndicator EULER232

The second axes, followed by the third and then second axes.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static EulerSequenceIndicator getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nullable
public static EulerSequenceIndicator getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.