org.codetome.hexameter.core.api

Enum RotationDirection

java.lang.Object

java.lang.Enum<RotationDirection>

org.codetome.hexameter.core.api.RotationDirection

All Implemented Interfaces:

Serializable, Comparable<RotationDirection>

public enum RotationDirection
extends Enum<RotationDirection>

Represents a right or left angle (60°) of a Hexagon rotation. See: http://www.redblobgames.com/grids/hexagons/#rotation

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEFT
RIGHT

Method Summary

Modifier and Type	Method and Description
CubeCoordinate	calculateRotation(CubeCoordinate coord) Calculates a rotation (right or left) of coord.
static RotationDirection	valueOf(String name) Returns the enum constant of this type with the specified name.
static RotationDirection[]	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

RIGHT

public static final RotationDirection RIGHT

LEFT

public static final RotationDirection LEFT

Method Detail

values

public static RotationDirection[] 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 (RotationDirection c : RotationDirection.values())
    System.out.println(c);

Returns:

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

valueOf

public static RotationDirection valueOf(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:

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

NullPointerException - if the argument is null

calculateRotation

public CubeCoordinate calculateRotation(CubeCoordinate coord)

Calculates a rotation (right or left) of coord.

Parameters:

coord - coordinate to rotate

Returns:

rotated coordinate