Package megamek.common.board

Enum Class CardinalDirection

java.lang.Object

java.lang.Enum<CardinalDirection>

megamek.common.board.CardinalDirection

All Implemented Interfaces:

Serializable, Comparable<CardinalDirection>, Constable

public enum CardinalDirection
extends Enum<CardinalDirection>

Represents a set of cube coordinates in a hex grid. Cube Coordinate allows for more precise manipulation of distances, movements, and other operations.

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
NORTH
NORTHEAST
NORTHWEST
SOUTH
SOUTHEAST
SOUTHWEST

Method Summary

Modifier and Type	Method	Description
int	getAngle()	Returns the angle of this CardinalDirection in degrees.
CubeCoords	getDirection()	Returns the direction of this CardinalDirection as CubeCoords.
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

NORTH

public static final CardinalDirection NORTH

NORTHEAST

public static final CardinalDirection NORTHEAST

SOUTHEAST

public static final CardinalDirection SOUTHEAST

SOUTH

public static final CardinalDirection SOUTH

SOUTHWEST

public static final CardinalDirection SOUTHWEST

NORTHWEST

public static final CardinalDirection NORTHWEST

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

getDirection

public CubeCoords getDirection()

Returns the direction of this CardinalDirection as CubeCoords.

Returns:

the CubeCoords representing the direction

getAngle

public int getAngle()

Returns the angle of this CardinalDirection in degrees.

Returns:

the angle in degrees