Direction

java.lang.Object
- java.lang.Enum<Direction>
- - de.smits_net.games.framework.sprite.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>
```
public enum Direction
extends java.lang.Enum<Direction>
```
Enumeration to indicate the direction of an object.

Author:

Thomas Smits

Enum Constant Summary

Enum Constants
Enum Constant and Description
`EAST` Direction East.
`NONE` No direction.
`NORTH` Direction North.
`NORTHEAST` Direction North East.
`NORTHWEST` Direction North West.
`SOUTH` Direction South.
`SOUTHEAST` Direction South East.
`SOUTHWEST` Direction South West.
`WEST` Direction West.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getX()` Get the x component of the direction vector.
`double`	`getY()` Get the y component of the direction vector.
`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
  - EAST
```
public static final Direction EAST
```
    Direction East.
  - NONE
```
public static final Direction NONE
```
    No direction.
  - NORTH
```
public static final Direction NORTH
```
    Direction North.
  - NORTHEAST
```
public static final Direction NORTHEAST
```
    Direction North East.
  - NORTHWEST
```
public static final Direction NORTHWEST
```
    Direction North West.
  - SOUTH
```
public static final Direction SOUTH
```
    Direction South.
  - SOUTHEAST
```
public static final Direction SOUTHEAST
```
    Direction South East.
  - SOUTHWEST
```
public static final Direction SOUTHWEST
```
    Direction South West.
  - WEST
```
public static final Direction WEST
```
    Direction West.
- Method Detail
  - getX
```
public double getX()
```
    Get the x component of the direction vector.
    
    Returns:
    
    x component
  - getY
```
public double getY()
```
    Get the y component of the direction vector.
    
    Returns:
    
    y component
  - 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
  - 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

Enum Direction

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EAST

NONE

NORTH

NORTHEAST

NORTHWEST

SOUTH

SOUTHEAST

SOUTHWEST

WEST

Method Detail

getX

getY

valueOf

values