nova.core.util

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

nova.core.util.Direction

All Implemented Interfaces:

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

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

Defines basic directions in world.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN
EAST
NORTH
SOUTH
UNKNOWN
UP
WEST

Field Summary

Fields

Modifier and Type	Field and Description
static Direction[]	FLAT_DIRECTIONS Directions in a 2 dimensional space.
org.apache.commons.math3.geometry.euclidean.threed.Rotation	rotation
static Direction[]	VALID_DIRECTIONS Contains all valid directions.
int	x
int	y
int	z

Method Summary

Modifier and Type	Method and Description
static Direction	fromOrdinal(int directionID) Turns direction number into Direction.
static Direction	fromVector(org.apache.commons.math3.geometry.euclidean.threed.Vector3D unitVector)
Direction	opposite()
org.apache.commons.math3.geometry.euclidean.threed.Vector3D	toVector()
static Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

DOWN

public static final Direction DOWN

UP

public static final Direction UP

NORTH

public static final Direction NORTH

SOUTH

public static final Direction SOUTH

WEST

public static final Direction WEST

EAST

public static final Direction EAST

UNKNOWN

public static final Direction UNKNOWN

Field Detail

VALID_DIRECTIONS

public static final Direction[] VALID_DIRECTIONS

Contains all valid directions.

FLAT_DIRECTIONS

public static final Direction[] FLAT_DIRECTIONS

Directions in a 2 dimensional space.

x

public final int x

y

public final int y

z

public final int z

rotation

public final org.apache.commons.math3.geometry.euclidean.threed.Rotation rotation

Method Detail

values

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

Returns:

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

valueOf

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

fromOrdinal

public static Direction fromOrdinal(int directionID)

Turns direction number into Direction.

Parameters:

directionID - Direction ID / number.

Returns:

Resulting Direction.

Throws:

java.lang.IllegalArgumentException - if the direction ID is invalid (greater than 6 or less than 0)

fromVector

public static Direction fromVector(org.apache.commons.math3.geometry.euclidean.threed.Vector3D unitVector)

Parameters:

unitVector - The unit vector representing the direction.

Returns:

The direction based on a unit vector

opposite

public Direction opposite()

Returns:

Direction opposite to this.

toVector

public org.apache.commons.math3.geometry.euclidean.threed.Vector3D toVector()

Returns:

This Direction represented as Vector3D