Enum Class CardinalDirection

java.lang.Object

java.lang.Enum<CardinalDirection>

net.buildtheearth.terraminusminus.util.CardinalDirection

All Implemented Interfaces:

Serializable, Comparable<CardinalDirection>, Constable

public enum CardinalDirection
extends Enum<CardinalDirection>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static CardinalDirection	azimuthToFacing(float azimuth)
boolean	matches(float azimuth)
double	max()
double	min()
String	realName()
String	translationKey()
static CardinalDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CardinalDirection[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

N

public static final CardinalDirection N

S

public static final CardinalDirection S

E

public static final CardinalDirection E

W

public static final CardinalDirection W

NW

public static final CardinalDirection NW

SW

public static final CardinalDirection SW

SE

public static final CardinalDirection SE

NE

public static final CardinalDirection NE

UNKNOWN

public static final CardinalDirection UNKNOWN

Method Details

values

public static CardinalDirection[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CardinalDirection valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

azimuthToFacing

public static CardinalDirection azimuthToFacing(float azimuth)

Parameters:

azimuth - - an azimuth

Returns:

the CardinalDirection the given azimuth faces

matches

public boolean matches(float azimuth)

Parameters:

azimuth - - an azimuth

Returns:

true if the given azimuth faces this cardinal direction

min

public double min()

max

public double max()

realName

public String realName()

translationKey

public String translationKey()