org.codetome.hexameter.api

Interface Hexagon

All Superinterfaces:

Serializable

All Known Implementing Classes:

HexagonImpl

public interface Hexagon
extends Serializable

Represents a Hexagon.

Please note that all coordinates are relative to the HexagonalGrid containing this Hexagon.

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.
<T extends SatelliteData> void	setSatelliteData(T data) Can be used to add arbitrary satellite data to a Hexagon.

Method Detail

getId

String getId()

Returns an unique String representing this Hexagon.

Returns:

id

getPoints

List<Point> getPoints()

Returns a list containing the Points of this Hexagon.

Returns:

points array

getAxialCoordinate

AxialCoordinate getAxialCoordinate()

Returns the AxialCoordinate of this Hexagon.

Returns:

getGridX

int getGridX()

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

Returns:

x coordinate on the grid

getGridY

int getGridY()

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.

Returns:

y coordinate on the grid

getGridZ

int getGridZ()

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

Returns:

z coordinate on the grid

getCenterX

double getCenterX()

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

Returns:

center x

getCenterY

double getCenterY()

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

Returns:

center y

getSatelliteData

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

Returns this Hexagon's satellite data.

Returns:

optional satellite data

setSatelliteData

<T extends SatelliteData> void setSatelliteData(T data)

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

Parameters:

data -

clearSatelliteData

void clearSatelliteData()

Clears the satellite data of this Hexagon.