Package dev.prozilla.pine.common.math.vector

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

dev.prozilla.pine.common.math.vector.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Represents a 2-dimensional 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
DOWN
LEFT
RIGHT
UP

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COUNT
final float	degrees
final String	string
final int	x
final int	y

Method Summary

Modifier and Type	Method	Description
abstract Direction	opposite()
abstract Direction	rotateClockwise()
abstract Direction	rotateCounterclockwise()
Vector2f	toFloatVector()
Vector2i	toIntVector()
String	toString()
static Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Direction[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UP

public static final Direction UP

DOWN

public static final Direction DOWN

LEFT

public static final Direction LEFT

RIGHT

public static final Direction RIGHT

Field Details

x

public final int x

y

public final int y

degrees

public final float degrees

string

public final String string

COUNT

public static final int COUNT

See Also:

• Constant Field Values

Method Details

values

public static Direction[] 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 Direction 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

opposite

public abstract Direction opposite()

Returns:

The opposite direction.

rotateClockwise

public abstract Direction rotateClockwise()

Returns:

The next direction in clockwise rotation.

rotateCounterclockwise

public abstract Direction rotateCounterclockwise()

Returns:

The next direction in counterclockwise rotation.

toFloatVector

public Vector2f toFloatVector()

Returns:

This direction as a vector with float precision.

toIntVector

public Vector2i toIntVector()

Returns:

This direction as a vector with integer precision.

toString

public String toString()

Overrides:

toString in class Enum<Direction>