Package rekit.primitives.geometry

Enum Class Direction

java.lang.Object

java.lang.Enum<Direction>

rekit.primitives.geometry.Direction

All Implemented Interfaces:

Serializable, Comparable<Direction>, Constable

public enum Direction
extends Enum<Direction>

Representation of the 4 directions there are.

Author:

Angelo Aracri

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	Represents the Direction down with the Vector (0|1).
LEFT	Represents the Direction left with the Vector (-1|0).
RIGHT	Represents the Direction right with the Vector (1|0).
UP	Represents the Direction up with the Vector (0|-1).

Method Summary

Modifier and Type	Method	Description
double	getAngle()	Get the angle to a corresponding direction relative to direction up.
Direction	getNextAntiClockwise()	Get the next direction to a direction (anticlockwise).
Direction	getNextClockwise()	Get the next direction to a direction (clockwise).
Direction	getOpposite()	Get the opposite direction.
static Direction	getOpposite(Direction dir)	Get the opposite direction to a direction.
static Direction	getRandom()	Get a random Direction.
Vec	getVector()	Get the vector to a corresponding direction.
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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UP

public static final Direction UP

Represents the Direction up with the Vector (0|-1).

RIGHT

public static final Direction RIGHT

Represents the Direction right with the Vector (1|0).

DOWN

public static final Direction DOWN

Represents the Direction down with the Vector (0|1).

LEFT

public static final Direction LEFT

Represents the Direction left with the Vector (-1|0).

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

getVector

public Vec getVector()

Get the vector to a corresponding direction.

Returns:

the vector

getAngle

public double getAngle()

Get the angle to a corresponding direction relative to direction up.

Returns:

the angle

getOpposite

public static Direction getOpposite(Direction dir)

Get the opposite direction to a direction.

Parameters:

dir - the direction

Returns:

the direction or random if dir == null

getNextClockwise

public Direction getNextClockwise()

Get the next direction to a direction (clockwise).

Returns:

the direction or null if none defined

getNextAntiClockwise

public Direction getNextAntiClockwise()

Get the next direction to a direction (anticlockwise).

Returns:

the direction or null if none defined

getRandom

public static Direction getRandom()

Get a random Direction.

Returns:

the direction or null if none defined

getOpposite

public Direction getOpposite()

Get the opposite direction.

Returns:

the opposite direction