org.codetome.hexameter.core.api

Class CubeCoordinate

java.lang.Object

org.codetome.hexameter.core.api.CubeCoordinate

All Implemented Interfaces:

Serializable

public final class CubeCoordinate
extends Object
implements Serializable

Represents a cube coorinate pair. See http://www.redblobgames.com/grids/hexagons/#coordinates to learn more. Note that the y coordinate is not stored in this object since it can be calculated.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEP

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
static CubeCoordinate	fromAxialKey(String axialKey) Tries to create an CubeCoordinate from a key which has the format: %gridX%,%gridZ%.
static CubeCoordinate	fromCoordinates(int gridX, int gridZ) Creates an instance of CubeCoordinate from an x and a z coordinate.
int	getGridX()
int	getGridY()
int	getGridZ()
int	hashCode()
String	toAxialKey() Creates an axial (x, z) key which can be used in key-value storage objects based on this CubeCoordinate.

Methods inherited from class java.lang.Object

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

Field Detail

SEP

public static final String SEP

See Also:

Constant Field Values

Method Detail

fromAxialKey

public static CubeCoordinate fromAxialKey(String axialKey)

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

Parameters:

axialKey - key

Returns:

coord

fromCoordinates

public static CubeCoordinate fromCoordinates(int gridX,
                                             int gridZ)

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

Parameters:

gridX - grid x

gridZ - grid z

Returns:

coord

toAxialKey

public String toAxialKey()

Creates an axial (x, z) key which can be used in key-value storage objects based on this CubeCoordinate.

Returns:

key

getGridY

public int getGridY()

getGridX

public int getGridX()

getGridZ

public int getGridZ()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object