agi.foundation.graphics.advanced

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

Enum ConstrainedUpAxis

java.lang.Object

java.lang.Enum<ConstrainedUpAxis>

agi.foundation.graphics.advanced.ConstrainedUpAxis

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ConstrainedUpAxis>

public enum ConstrainedUpAxis
extends Enum<ConstrainedUpAxis>
implements Enumeration

When setting the Camera's Axes (get), this defines which axis of the axes is up in screen space, where up is from the bottom to the top of the screen.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEGATIVE_X The negative X axis is constrained.
NEGATIVE_Y The negative Y axis is constrained.
NEGATIVE_Z The negative Z axis is constrained.
NONE No axis is contained.
X The X axis is constrained.
Y The Y axis is constrained.
Z The Z axis is constrained.

Method Summary

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

X

public static final ConstrainedUpAxis X

The X axis is constrained.

Y

public static final ConstrainedUpAxis Y

The Y axis is constrained.

Z

public static final ConstrainedUpAxis Z

The Z axis is constrained.

NEGATIVE_X

public static final ConstrainedUpAxis NEGATIVE_X

The negative X axis is constrained.

NEGATIVE_Y

public static final ConstrainedUpAxis NEGATIVE_Y

The negative Y axis is constrained.

NEGATIVE_Z

public static final ConstrainedUpAxis NEGATIVE_Z

The negative Z axis is constrained.

NONE

public static final ConstrainedUpAxis NONE

No axis is contained.

Method Detail

values

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

Returns:

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

valueOf

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

@Nonnull
public static ConstrainedUpAxis getDefault()

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

Returns:

The default enum constant.