org.codetome.hexameter.core.api

Interface HexagonalGrid<T extends SatelliteData>

All Known Implementing Classes:

HexagonalGridImpl

public interface HexagonalGrid<T extends SatelliteData>

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 cube (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
boolean	containsCubeCoordinate(CubeCoordinate coordinate) Tells whether the given cube coordinate is on the grid or not.
Optional<Hexagon<T>>	getByCubeCoordinate(CubeCoordinate coordinate) Returns a Hexagon by its cube coordinate.
Optional<Hexagon<T>>	getByPixelCoordinate(double coordinateX, double coordinateY) Returns a Hexagon by a pixel coordinate.
GridData	getGridData() Returns this HexagonalGrid's GridData.
rx.Observable<Hexagon<T>>	getHexagons() Returns all Hexagons contained in this grid.
rx.Observable<Hexagon<T>>	getHexagonsByCubeRange(CubeCoordinate from, CubeCoordinate to) Returns all Hexagons contained in the given cube coordinate range.
rx.Observable<Hexagon<T>>	getHexagonsByOffsetRange(int gridXFrom, int gridXTo, int gridYFrom, int gridYTo) Returns all Hexagons contained in the given offset coordinate range.
Optional<Hexagon<T>>	getNeighborByIndex(Hexagon<T> hexagon, int index) Returns a neighbor of a Hexagon by its neighbor index.
Collection<Hexagon<T>>	getNeighborsOf(Hexagon<T> hexagon) Returns all neighbors of a Hexagon.

Method Detail

getGridData

GridData getGridData()

Returns this HexagonalGrid's GridData.

Returns:

grid data

getHexagons

rx.Observable<Hexagon<T>> getHexagons()

Returns all Hexagons contained in this grid.

Returns:

hexagons

getHexagonsByCubeRange

rx.Observable<Hexagon<T>> getHexagonsByCubeRange(CubeCoordinate from,
                                                 CubeCoordinate to)

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

Parameters:

from - from

to - to

Returns:

Hexagons in the given range.

getHexagonsByOffsetRange

rx.Observable<Hexagon<T>> 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.

containsCubeCoordinate

boolean containsCubeCoordinate(CubeCoordinate coordinate)

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

Parameters:

coordinate - coord

Returns:

is it on the grid?

getByCubeCoordinate

Optional<Hexagon<T>> getByCubeCoordinate(CubeCoordinate coordinate)

Returns a Hexagon by its cube coordinate.

Parameters:

coordinate - coord

Returns:

Optional with a Hexagon if it is present

getByPixelCoordinate

Optional<Hexagon<T>> 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

getNeighborByIndex

Optional<Hexagon<T>> getNeighborByIndex(Hexagon<T> hexagon,
                                        int index)

Returns a neighbor of a Hexagon by its neighbor index.

Returns:

neighbor or empty Optional if not applicable

getNeighborsOf

Collection<Hexagon<T>> getNeighborsOf(Hexagon<T> hexagon)

Returns all neighbors of a Hexagon.

Parameters:

hexagon - Hexagon

Returns:

the Hexagon's neighbors