org.codetome.hexameter.core.api

Enum HexagonOrientation

java.lang.Object

java.lang.Enum<HexagonOrientation>

org.codetome.hexameter.core.api.HexagonOrientation

All Implemented Interfaces:

Serializable, Comparable<HexagonOrientation>

public enum HexagonOrientation
extends Enum<HexagonOrientation>

Enum representing the possible orientations of a Hexagon. The names are self-explanatory.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLAT_TOP
POINTY_TOP

Method Summary

Modifier and Type	Method and Description
float	getCoordinateOffset() This is because the flat/pointy shape of a hexagon.
static HexagonOrientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static HexagonOrientation[]	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

POINTY_TOP

public static final HexagonOrientation POINTY_TOP

FLAT_TOP

public static final HexagonOrientation FLAT_TOP

Method Detail

values

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

Returns:

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

valueOf

public static HexagonOrientation 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

getCoordinateOffset

public final float getCoordinateOffset()

This is because the flat/pointy shape of a hexagon. It needs to be offset for pointy when calculating the coordinates of its points.

Returns:

offset