org.codetome.hexameter.core.api

Interface Hexagon<T extends SatelliteData>

All Known Implementing Classes:

HexagonImpl

public interface Hexagon<T extends SatelliteData>

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.
double	getCenterX() Returns the center x (pixel) coordinate of this Hexagon.
double	getCenterY() Returns the center y (pixel) coordinate of this Hexagon.
CubeCoordinate	getCubeCoordinate() Returns the CubeCoordinate of this Hexagon.
int	getGridX() Returns this Hexagon's x (cube) coordinate on the HexagonalGrid.
int	getGridY() Returns this Hexagon's y coordinate on the HexagonalGrid.
int	getGridZ() Returns this Hexagon's z (cube) coordinate on the HexagonalGrid.
String	getId() Returns an unique String representing this Hexagon.
Collection<Point>	getPoints() Returns a list containing the Points of this Hexagon.
Optional<T>	getSatelliteData() Returns this Hexagon's satellite data.
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.

getPoints

Collection<Point> getPoints()

Returns a list containing the Points of this Hexagon.

getCubeCoordinate

CubeCoordinate getCubeCoordinate()

Returns the CubeCoordinate of this Hexagon.

getGridX

int getGridX()

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

getGridY

int getGridY()

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

getGridZ

int getGridZ()

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

getCenterX

double getCenterX()

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

getCenterY

double getCenterY()

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

Returns:

center y

getSatelliteData

Optional<T> getSatelliteData()

Returns this Hexagon's satellite data.

setSatelliteData

void setSatelliteData(T data)

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

clearSatelliteData

void clearSatelliteData()

Clears the satellite data of this Hexagon.