inf112.fiasko.roborally.objects.properties

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

inf112.fiasko.roborally.objects.properties.Direction

All Implemented Interfaces:

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

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

This enum represents all possible directions for an element on the board

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST The east direction
NORTH The north direction
NORTH_EAST The north-east direction
NORTH_WEST The north-west direction
SOUTH The south direction
SOUTH_EAST The south-east direction
SOUTH_WEST The south-west direction
WEST The west direction

Method Summary

Modifier and Type	Method and Description
static boolean	arePerpendicular(Direction direction1, Direction direction2) Checks whether two directions are perpendicular
static Direction	getDirectionFromID(int directionID) Gets a direction from its numerical id
int	getDirectionID() Gets the numerical identifier used for alternate identification of a direction
static Direction	getLeftRotatedDirection(Direction direction) Gets the direction if something rotated to the left A rotation is assumed to be a ninety degrees rotation, so NORTH would become WEST and so on.
static Direction	getReverseDirection(Direction direction) Gets the reverse of a direction
static Direction	getRightRotatedDirection(Direction direction) Gets the direction if something rotated to the right A rotation is assumed to be a ninety degrees rotation, so NORTH would become EAST and so on.
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

NORTH

public static final Direction NORTH

The north direction

NORTH_EAST

public static final Direction NORTH_EAST

The north-east direction

EAST

public static final Direction EAST

The east direction

SOUTH_EAST

public static final Direction SOUTH_EAST

The south-east direction

SOUTH

public static final Direction SOUTH

The south direction

SOUTH_WEST

public static final Direction SOUTH_WEST

The south-west direction

WEST

public static final Direction WEST

The west direction

NORTH_WEST

public static final Direction NORTH_WEST

The north-west direction

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

getDirectionFromID

public static Direction getDirectionFromID(int directionID)

Gets a direction from its numerical id

Parameters:

directionID - The numerical representation of a direction

Returns:

The enum value representing the direction, or null if the id is invalid

arePerpendicular

public static boolean arePerpendicular(Direction direction1,
                                       Direction direction2)

Checks whether two directions are perpendicular

Parameters:

direction1 - The first direction

direction2 - The second direction

Returns:

True if the directions are perpendicular

getReverseDirection

public static Direction getReverseDirection(Direction direction)

Gets the reverse of a direction

Parameters:

direction - A direction

Returns:

The reverse direction

getLeftRotatedDirection

public static Direction getLeftRotatedDirection(Direction direction)

Gets the direction if something rotated to the left

A rotation is assumed to be a ninety degrees rotation, so NORTH would become WEST and so on.

Parameters:

direction - A direction

Returns:

The left rotated direction

getRightRotatedDirection

public static Direction getRightRotatedDirection(Direction direction)

Gets the direction if something rotated to the right

A rotation is assumed to be a ninety degrees rotation, so NORTH would become EAST and so on.

Parameters:

direction - A direction

Returns:

The left rotated direction

getDirectionID

public int getDirectionID()

Gets the numerical identifier used for alternate identification of a direction

Returns:

The numerical id of the direction