net.sf.freecol.common.model

Enum Map.Direction

java.lang.Object

java.lang.Enum<Map.Direction>

net.sf.freecol.common.model.Map.Direction

All Implemented Interfaces:

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

Enclosing class:

Map

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

The directions a Unit can move to. Includes deltas for moving to adjacent squares, which are required due to the isometric map. Starting north and going clockwise.

Enum Constant Summary

Enum Constants

Enum Constant and Description
E
N
NE
NW
S
SE
SW
W

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<Map.Direction>	allDirections
static java.util.List<Map.Direction>	corners
private int	evenDX
private int	evenDY
static java.util.List<Map.Direction>	longSides
static int	NUMBER_OF_DIRECTIONS
private int	oddDX The direction increments.
private int	oddDY

Method Summary

Modifier and Type	Method and Description
static Map.Direction	angleToDirection(double angle) Convert an angle (radians) to a direction.
Map.Direction[]	getClosestDirections(java.lang.String logMe, java.util.Random random) Creates an array of the directions in an order that favours a supplied one.
java.lang.String	getNameKey() Get the name key for this direction.
Map.Direction	getNextDirection() Get the next direction after this one (clockwise).
Map.Direction	getPreviousDirection() Get the previous direction after this one (anticlockwise).
static Map.Direction	getRandomDirection(java.lang.String logMe, java.util.Random random) Gets a random Direction.
static Map.Direction[]	getRandomDirections(java.lang.String logMe, java.util.Random random) Creates an array of the eight directions in a random order.
Map.Direction	getReverseDirection() Gets the reverse direction of this one.
private Map.Direction	rotate(int n) Gets this direction rotated by n places.
int	stepX(int x, int y) Step an x coordinate in this direction.
int	stepY(int x, int y) Step a y coordinate in this direction.
static Map.Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Map.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

N

public static final Map.Direction N

NE

public static final Map.Direction NE

E

public static final Map.Direction E

SE

public static final Map.Direction SE

S

public static final Map.Direction S

SW

public static final Map.Direction SW

W

public static final Map.Direction W

NW

public static final Map.Direction NW

Field Detail

NUMBER_OF_DIRECTIONS

public static final int NUMBER_OF_DIRECTIONS

allDirections

public static final java.util.List<Map.Direction> allDirections

longSides

public static final java.util.List<Map.Direction> longSides

corners

public static final java.util.List<Map.Direction> corners

oddDX

private final int oddDX

The direction increments.

oddDY

private final int oddDY

evenDX

private final int evenDX

evenDY

private final int evenDY

Method Detail

values

public static Map.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 (Map.Direction c : Map.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 Map.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

getNameKey

public java.lang.String getNameKey()

Get the name key for this direction.

Returns:

The name key.

stepX

public int stepX(int x,
                 int y)

Step an x coordinate in this direction.

Parameters:

x - The x coordinate.

y - The y coordinate.

Returns:

The x coordinate after the step.

stepY

public int stepY(int x,
                 int y)

Step a y coordinate in this direction.

Parameters:

x - The x coordinate.

y - The y coordinate.

Returns:

The y coordinate after the step.

rotate

private Map.Direction rotate(int n)

Gets this direction rotated by n places.

Parameters:

n - The number of places to rotate (-#directions <= n <= #directions).

Returns:

The rotated direction.

getNextDirection

public Map.Direction getNextDirection()

Get the next direction after this one (clockwise).

Returns:

The next Direction.

getPreviousDirection

public Map.Direction getPreviousDirection()

Get the previous direction after this one (anticlockwise).

Returns:

The previous Direction.

getReverseDirection

public Map.Direction getReverseDirection()

Gets the reverse direction of this one.

Returns:

The reverse Direction.

getRandomDirection

public static Map.Direction getRandomDirection(java.lang.String logMe,
                                               java.util.Random random)

Gets a random Direction.

Parameters:

logMe - A string to log with the random results.

random - A Random number source.

Returns:

A random Direction value.

getRandomDirections

public static Map.Direction[] getRandomDirections(java.lang.String logMe,
                                                  java.util.Random random)

Creates an array of the eight directions in a random order.

Parameters:

logMe - A string to log with the random results.

random - A Random number source.

Returns:

An array of the Directions in a random order.

getClosestDirections

public Map.Direction[] getClosestDirections(java.lang.String logMe,
                                            java.util.Random random)

Creates an array of the directions in an order that favours a supplied one. Entry 0 will be the supplied direction, entry 1+2 will be those immediately to the left and right of it (chosen randomly), and so on until the last entry will be the complete reverse of the supplied direction. Useful if we want to travel in a particular direction, but if this fails to be able to try the closest other directions to the original one in order.

Parameters:

logMe - A string to log with the random results.

random - A Random number source.

Returns:

An array of the Directions favouring this one.

angleToDirection

public static Map.Direction angleToDirection(double angle)

Convert an angle (radians) to a direction.

Parameters:

angle - The angle to convert.

Returns:

An equivalent Direction.