org.codetome.hexameter.core.api

Class AxialCoordinate

java.lang.Object

org.codetome.hexameter.core.api.AxialCoordinate

All Implemented Interfaces:

Serializable

public final class AxialCoordinate
extends Object
implements Serializable

Represents an axial coorinate pair. See http://www.redblobgames.com/grids/hexagons/#coordinates to learn more.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static AxialCoordinate	fromCoordinates(int gridX, int gridZ) Creates an instance of AxialCoordinate from an x and a z coordinate.
static AxialCoordinate	fromKey(String key) Tries to create an AxialCoordinate from a key which has the format: %gridX%,%gridZ%.
String	toKey() Creates a key which can be used in key-value storage objects based on this AxialCoordinate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

fromKey

public static AxialCoordinate fromKey(String key)

Tries to create an AxialCoordinate from a key which has the format: %gridX%,%gridZ%.

Parameters:

key - key

Returns:

coord

fromCoordinates

public static AxialCoordinate fromCoordinates(int gridX,
                                              int gridZ)

Creates an instance of AxialCoordinate from an x and a z coordinate.

Parameters:

gridX - grid x

gridZ - grid z

Returns:

coord

toKey

public String toKey()

Creates a key which can be used in key-value storage objects based on this AxialCoordinate.

Returns:

key