org.codetome.hexameter.internal.impl

Class HexagonImpl

java.lang.Object

org.codetome.hexameter.internal.impl.HexagonImpl

All Implemented Interfaces:

Serializable, Hexagon

public class HexagonImpl
extends Object
implements Hexagon

Default implementation of the Hexagon interface.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	clearSatelliteData() Clears the satellite data of this Hexagon.
AxialCoordinate	getAxialCoordinate() Returns the AxialCoordinate of this Hexagon.
double	getCenterX() Returns the center x (pixel) coordinate of this Hexagon.
double	getCenterY() Returns the center y (pixel) coordinate of this Hexagon.
int	getGridX() Returns this Hexagon's x (axial) coordinate on the HexagonalGrid.
int	getGridY() Returns this Hexagon's y coordinate on the HexagonalGrid.
int	getGridZ() Returns this Hexagon's z (axial) coordinate on the HexagonalGrid.
String	getId() Returns an unique String representing this Hexagon.
List<Point>	getPoints() Returns a list containing the Points of this Hexagon.
<T extends SatelliteData> Optional<T>	getSatelliteData() Returns this Hexagon's satellite data.
static Hexagon	newHexagon(SharedHexagonData sharedHexagonData, AxialCoordinate coordinate) Creates a new Hexagon object from shared data and a coordinate.
<T extends SatelliteData> void	setSatelliteData(T satelliteData) Can be used to add arbitrary satellite data to a Hexagon.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

newHexagon

public static Hexagon newHexagon(SharedHexagonData sharedHexagonData,
                                 AxialCoordinate coordinate)

Creates a new Hexagon object from shared data and a coordinate.

Parameters:

sharedHexagonData -

coordinate -

Returns:

getId

public String getId()

Description copied from interface: Hexagon

Returns an unique String representing this Hexagon.

Specified by:

getId in interface Hexagon

Returns:

id

toString

public String toString()

Overrides:

toString in class Object

getPoints

public final List<Point> getPoints()

Description copied from interface: Hexagon

Returns a list containing the Points of this Hexagon.

Specified by:

getPoints in interface Hexagon

Returns:

points array

getSatelliteData

public final <T extends SatelliteData> Optional<T> getSatelliteData()

Description copied from interface: Hexagon

Returns this Hexagon's satellite data.

Specified by:

getSatelliteData in interface Hexagon

Returns:

optional satellite data

setSatelliteData

public final <T extends SatelliteData> void setSatelliteData(T satelliteData)

Description copied from interface: Hexagon

Can be used to add arbitrary satellite data to a Hexagon.

Specified by:

setSatelliteData in interface Hexagon

clearSatelliteData

public void clearSatelliteData()

Description copied from interface: Hexagon

Clears the satellite data of this Hexagon.

Specified by:

clearSatelliteData in interface Hexagon

getAxialCoordinate

public AxialCoordinate getAxialCoordinate()

Description copied from interface: Hexagon

Returns the AxialCoordinate of this Hexagon.

Specified by:

getAxialCoordinate in interface Hexagon

Returns:

getGridX

public int getGridX()

Description copied from interface: Hexagon

Returns this Hexagon's x (axial) coordinate on the HexagonalGrid.

Specified by:

getGridX in interface Hexagon

Returns:

x coordinate on the grid

getGridY

public final int getGridY()

Description copied from interface: Hexagon

Returns this Hexagon's y coordinate on the HexagonalGrid. The Y coordinate is not present in the axial model but it is in the cube model. This method is just for convenience.

Specified by:

getGridY in interface Hexagon

Returns:

y coordinate on the grid

getGridZ

public int getGridZ()

Description copied from interface: Hexagon

Returns this Hexagon's z (axial) coordinate on the HexagonalGrid.

Specified by:

getGridZ in interface Hexagon

Returns:

z coordinate on the grid

getCenterX

public final double getCenterX()

Description copied from interface: Hexagon

Returns the center x (pixel) coordinate of this Hexagon.

Specified by:

getCenterX in interface Hexagon

Returns:

center x

getCenterY

public final double getCenterY()

Description copied from interface: Hexagon

Returns the center y (pixel) coordinate of this Hexagon.

Specified by:

getCenterY in interface Hexagon

Returns:

center y