org.codetome.hexameter.core.api

Interface HexagonalGrid

All Known Implementing Classes:

HexagonalGridImpl

public interface HexagonalGrid

Represents a hexagonal grid. Use HexagonalGridBuilder to generate a ready-to-use grid. This interface contains all common functionality for dealing with Hexagons. See HexagonalGridCalculator for more advanced features.

This HexagonalGrid uses an axial (trapezoidal) coordinate system for easier computation. This means that apart from the X axis a diagonal axis is used instead of the vertical Y axis.

Method Summary

Modifier and Type	Method and Description
void	clearSatelliteData() Clears all satellite data attached to the Hexagons in this grid.
boolean	containsAxialCoordinate(AxialCoordinate coordinate) Tells whether the given axial coordinate is on the grid or not.
Optional<Hexagon>	getByAxialCoordinate(AxialCoordinate coordinate) Returns a Hexagon by its axial coordinate.
Optional<Hexagon>	getByPixelCoordinate(double coordinateX, double coordinateY) Returns a Hexagon by a pixel coordinate.
Iterable<Hexagon>	getHexagons() Returns all Hexagons contained in this grid.
Iterable<Hexagon>	getHexagonsByAxialRange(AxialCoordinate from, AxialCoordinate to) Returns all Hexagons contained in the given axial coordinate range.
Iterable<Hexagon>	getHexagonsByOffsetRange(int gridXFrom, int gridXTo, int gridYfrom, int gridYTo) Returns all Hexagons contained in the given offset coordinate range.
Iterable<Hexagon>	getNeighborsOf(Hexagon hexagon) Returns all neighbors of a Hexagon.

Method Detail

getHexagons

Iterable<Hexagon> getHexagons()

Returns all Hexagons contained in this grid.

Returns:

hexagons

getHexagonsByAxialRange

Iterable<Hexagon> getHexagonsByAxialRange(AxialCoordinate from,
                                          AxialCoordinate to)

Returns all Hexagons contained in the given axial coordinate range. If the range contains coordinates which are not part of the grid they will be ignored.

Returns:

Hexagons in the given range.

getHexagonsByOffsetRange

Iterable<Hexagon> getHexagonsByOffsetRange(int gridXFrom,
                                           int gridXTo,
                                           int gridYfrom,
                                           int gridYTo)

Returns all Hexagons contained in the given offset coordinate range. If the range contains coordinates which are not part of the grid they will be ignored.

Parameters:

gridXFrom - from x inclusive

gridXTo - to x inclusive

gridYfrom - from z inclusive

gridYTo - to z inclusive

Returns:

Hexagons in the given range.

containsAxialCoordinate

boolean containsAxialCoordinate(AxialCoordinate coordinate)

Tells whether the given axial coordinate is on the grid or not. If you want to look up by offset coordinate use CoordinateConverter.

Returns:

is it on the grid?

getByAxialCoordinate

Optional<Hexagon> getByAxialCoordinate(AxialCoordinate coordinate)

Returns a Hexagon by its axial coordinate.

Returns:

Optional with a Hexagon if it is present

getByPixelCoordinate

Optional<Hexagon> getByPixelCoordinate(double coordinateX,
                                       double coordinateY)

Returns a Hexagon by a pixel coordinate. Please note that all pixel coordinates are relative to the containing HexagonalGrid.

Parameters:

coordinateX - pixel coordinateX coordinate

coordinateY - pixel coordinateY coordinate

Returns:

Optional with a Hexagon if it is present

getNeighborsOf

Iterable<Hexagon> getNeighborsOf(Hexagon hexagon)

Returns all neighbors of a Hexagon.

Parameters:

hexagon - Hexagon

Returns:

the Hexagon's neighbors

clearSatelliteData

void clearSatelliteData()

Clears all satellite data attached to the Hexagons in this grid.