org.andengine.util.algorithm.path

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

org.andengine.util.algorithm.path.Direction

All Implemented Interfaces:

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

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

(c) 2010 Nicolas Gramlich (c) 2011 Zynga Inc.

Since:

15:19:11 - 17.08.2010

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN
DOWN_LEFT
DOWN_RIGHT
LEFT
RIGHT
UP
UP_LEFT
UP_RIGHT

Method Summary

Modifier and Type	Method and Description
static Direction	fromDelta(int pDeltaX, int pDeltaY)
int	getDeltaX()
int	getDeltaY()
boolean	isHorizontal()
boolean	isVertical()
Direction	opposite()
Direction	rotateLeft()
Direction	rotateRight()
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

UP

public static final Direction UP

DOWN

public static final Direction DOWN

LEFT

public static final Direction LEFT

RIGHT

public static final Direction RIGHT

UP_LEFT

public static final Direction UP_LEFT

UP_RIGHT

public static final Direction UP_RIGHT

DOWN_LEFT

public static final Direction DOWN_LEFT

DOWN_RIGHT

public static final Direction DOWN_RIGHT

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

fromDelta

public static Direction fromDelta(int pDeltaX,
                                  int pDeltaY)

isHorizontal

public boolean isHorizontal()

isVertical

public boolean isVertical()

getDeltaX

public int getDeltaX()

getDeltaY

public int getDeltaY()

rotateLeft

public Direction rotateLeft()

rotateRight

public Direction rotateRight()

opposite

public Direction opposite()