team.unnamed.creative.base

Enum CubeFace

java.lang.Object

java.lang.Enum<CubeFace>

team.unnamed.creative.base.CubeFace

All Implemented Interfaces:

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

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

Enum of three-dimensional cube faces.

Every face has an axis and an orientation (positive or negative).

Note that the directions specified here are the same as the Minecraft ones.

Since:

1.0.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN The down face.
EAST The east face.
NORTH The north face.
SOUTH The south face.
UP The up face.
WEST The west face.

Method Summary

Modifier and Type	Method and Description
@NotNull Axis3D	axis() Returns the axis of this face.
int	factor() Returns the factor of this face direction.
static CubeFace	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CubeFace[]	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

WEST

public static final CubeFace WEST

The west face. It faces the negative X direction.

Since:

1.0.0

EAST

public static final CubeFace EAST

The east face. It faces the positive X direction.

Since:

1.0.0

DOWN

public static final CubeFace DOWN

The down face. It faces the negative Y direction.

Since:

1.0.0

UP

public static final CubeFace UP

The up face. It faces the positive Y direction.

Since:

1.0.0

NORTH

public static final CubeFace NORTH

The north face. It faces the negative Z direction.

Since:

1.0.0

SOUTH

public static final CubeFace SOUTH

The south face. It faces the positive Z direction.

Since:

1.0.0

Method Detail

values

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

Returns:

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

valueOf

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

axis

@NotNull
public @NotNull Axis3D axis()

Returns the axis of this face.

The axis is X for west and east, Y for down and up, and Z for north and south

Returns:

The face axis

Since:

1.0.0

factor

public int factor()

Returns the factor of this face direction.

The factor is 1 for positive directions and -1 for negative directions

Returns:

The face factor

Since:

1.0.0