agi.foundation.coordinates

(agi.foundation.core-2025r1.jar)

Enum AxisIndicator

java.lang.Object

java.lang.Enum<AxisIndicator>

agi.foundation.coordinates.AxisIndicator

All Implemented Interfaces:

Enumeration, Serializable, Comparable<AxisIndicator>

public enum AxisIndicator
extends Enum<AxisIndicator>
implements Enumeration

Specifies one of the three Cartesian axes.

See Also:

ElementaryRotation

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST The first axis (commonly the x-axis).
SECOND The second axis (commonly the y-axis).
THIRD The third axis (commonly the z-axis).

Method Summary

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

FIRST

public static final AxisIndicator FIRST

The first axis (commonly the x-axis).

SECOND

public static final AxisIndicator SECOND

The second axis (commonly the y-axis).

THIRD

public static final AxisIndicator THIRD

The third axis (commonly the z-axis).

Method Detail

values

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

Returns:

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

valueOf

public static AxisIndicator 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 AxisIndicator 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 AxisIndicator getDefault()

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

Returns:

The default enum constant.