team.unnamed.creative.base

Enum Axis3D

java.lang.Object

java.lang.Enum<Axis3D>

team.unnamed.creative.base.Axis3D

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Axis3D>

public enum Axis3D
extends java.lang.Enum<Axis3D>

Enum of axis in a three-dimensional space, always X, Y and Z.

Since:

1.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
X The "X" axis or abscissa.
Y The "Y" axis or ordinate.
Z The "Z" axis or applicate.

Method Summary

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

The "X" axis or abscissa. It is the first element in our three-dimensional vectors.

Since:

1.0.0

Y

public static final Axis3D Y

The "Y" axis or ordinate. It is the second element in our three-dimensional vectors.

Since:

1.0.0

Z

public static final Axis3D Z

The "Z" axis or applicate. It is the third and last element in our three-dimensional vectors.

Since:

1.0.0

Method Detail

values

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

Returns:

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

valueOf

public static Axis3D valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null