Package org.cyclops.cyclopscore.client.model

Enum Class DirectionCorner

java.lang.Object

java.lang.Enum<DirectionCorner>

org.cyclops.cyclopscore.client.model.DirectionCorner

All Implemented Interfaces:

Serializable, Comparable<DirectionCorner>, Constable

public enum DirectionCorner
extends Enum<DirectionCorner>

An equivalent to Direction for being able to also refer to block positions that are at a euclidian distance of maximum 2.

See Also:

• Direction

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LOWER_EAST	+X;-Y
LOWER_NORTH	-Z;-Y
LOWER_SOUTH	+Z;-Y
LOWER_WEST	-X;-Y
MIDDLE_NORTHEAST	+Z;+Y
MIDDLE_NORTHWEST	-Z;+Y
MIDDLE_SOUTHEAST	-X;+Y
MIDDLE_SOUTHWEST	+X;+Y
UNKNOWN	Used only by getOrientation, for invalid inputs
UPPER_EAST	+X;+Y
UPPER_NORTH	-Z;+Y
UPPER_SOUTH	+Z;+Y
UPPER_WEST	-X;+Y

Field Summary

Fields

Modifier and Type	Field	Description
final int	flag	The bitwise identifier for this direction, used for bitwise toggling of directions.
final int	offsetX	The offset in the X axis.
final int	offsetY	The offset in the Y axis.
final int	offsetZ	The offset in the Z axis.
static final DirectionCorner[]	VALID_DIRECTIONS	All the valid directions.

Method Summary

Modifier and Type	Method	Description
net.minecraft.core.BlockPos	fromOffset(net.minecraft.core.BlockPos pos)	Offset from the given position with the current corner.
static DirectionCorner	getOrientation(int id)	Get the direction of the given value, inverse of the @see DirectionCorner#ordinal() method.
static DirectionCorner	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DirectionCorner[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UPPER_NORTH

public static final DirectionCorner UPPER_NORTH

-Z;+Y

UPPER_SOUTH

public static final DirectionCorner UPPER_SOUTH

+Z;+Y

UPPER_WEST

public static final DirectionCorner UPPER_WEST

-X;+Y

UPPER_EAST

public static final DirectionCorner UPPER_EAST

+X;+Y

MIDDLE_NORTHWEST

public static final DirectionCorner MIDDLE_NORTHWEST

-Z;+Y

MIDDLE_NORTHEAST

public static final DirectionCorner MIDDLE_NORTHEAST

+Z;+Y

MIDDLE_SOUTHEAST

public static final DirectionCorner MIDDLE_SOUTHEAST

-X;+Y

MIDDLE_SOUTHWEST

public static final DirectionCorner MIDDLE_SOUTHWEST

+X;+Y

LOWER_NORTH

public static final DirectionCorner LOWER_NORTH

-Z;-Y

LOWER_SOUTH

public static final DirectionCorner LOWER_SOUTH

+Z;-Y

LOWER_WEST

public static final DirectionCorner LOWER_WEST

-X;-Y

LOWER_EAST

public static final DirectionCorner LOWER_EAST

+X;-Y

UNKNOWN

public static final DirectionCorner UNKNOWN

Used only by getOrientation, for invalid inputs

Field Details

offsetX

public final int offsetX

The offset in the X axis.

offsetY

public final int offsetY

The offset in the Y axis.

offsetZ

public final int offsetZ

The offset in the Z axis.

flag

public final int flag

The bitwise identifier for this direction, used for bitwise toggling of directions.

VALID_DIRECTIONS

public static final DirectionCorner[] VALID_DIRECTIONS

All the valid directions.

Method Details

values

public static DirectionCorner[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DirectionCorner valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getOrientation

public static DirectionCorner getOrientation(int id)

Get the direction of the given value, inverse of the @see DirectionCorner#ordinal() method.

Parameters:

id - The ordinal value of a direction.

Returns:

The direction for the given ordinal value.

fromOffset

public net.minecraft.core.BlockPos fromOffset(net.minecraft.core.BlockPos pos)

Offset from the given position with the current corner.

Parameters:

pos - The position.

Returns:

The offsetted position.