com.explodingbacon.bcnlib.controllers

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

com.explodingbacon.bcnlib.controllers.Direction

All Implemented Interfaces:

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

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

An enum for DPad directions on GameControllers.

Enum Constant Summary

Enum Constants

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

Field Summary

Fields

Modifier and Type	Field and Description
int	angle

Method Summary

Modifier and Type	Method and Description
boolean	isDown() Checks if the down button on the DPad is pressed.
boolean	isLeft() Checks if the left button on the DPad is pressed.
boolean	isRight() Checks if the right button on the DPad is pressed.
boolean	isUp() Checks if the up button on the DPad is pressed.
static Direction	toDirection(int angle) Converts an angle to a Direction.
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

UP_RIGHT

public static final Direction UP_RIGHT

RIGHT

public static final Direction RIGHT

DOWN_RIGHT

public static final Direction DOWN_RIGHT

DOWN

public static final Direction DOWN

DOWN_LEFT

public static final Direction DOWN_LEFT

LEFT

public static final Direction LEFT

UP_LEFT

public static final Direction UP_LEFT

NONE

public static final Direction NONE

Field Detail

angle

public int angle

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

isUp

public boolean isUp()

Checks if the up button on the DPad is pressed.

Returns:

If the up button on the DPad is pressed.

isRight

public boolean isRight()

Checks if the right button on the DPad is pressed.

Returns:

If the right button on the DPad is pressed.

isDown

public boolean isDown()

Checks if the down button on the DPad is pressed.

Returns:

If the down button on the DPad is pressed.

isLeft

public boolean isLeft()

Checks if the left button on the DPad is pressed.

Returns:

If the left button on the DPad is pressed.

toDirection

public static Direction toDirection(int angle)

Converts an angle to a Direction.

Parameters:

angle - The angle.

Returns:

The Direction.