org.codetome.hexameter.core.internal.impl

Class HexagonalGridImpl<T extends SatelliteData>

java.lang.Object

org.codetome.hexameter.core.internal.impl.HexagonalGridImpl<T>

All Implemented Interfaces:

HexagonalGrid<T>

public final class HexagonalGridImpl<T extends SatelliteData>
extends Object
implements HexagonalGrid<T>

Constructor Summary

Constructors

Constructor and Description
HexagonalGridImpl(HexagonalGridBuilder<T> builder) Creates a new HexagonalGrid based on the provided HexagonalGridBuilder.

Method Summary

Modifier and Type	Method and Description
boolean	containsCubeCoordinate(CubeCoordinate cubeCoordinate) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HexagonalGridImpl

public HexagonalGridImpl(HexagonalGridBuilder<T> builder)

Creates a new HexagonalGrid based on the provided HexagonalGridBuilder.

Parameters:

builder - builder

Method Detail

getGridData

public GridData getGridData()

Description copied from interface: HexagonalGrid

Returns this HexagonalGrid's GridData.

Specified by:

getGridData in interface HexagonalGrid<T extends SatelliteData>

Returns:

grid data

getHexagons

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

Description copied from interface: HexagonalGrid

Returns all Hexagons contained in this grid.

Specified by:

getHexagons in interface HexagonalGrid<T extends SatelliteData>

Returns:

hexagons

getHexagonsByCubeRange

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

Description copied from interface: HexagonalGrid

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.

Specified by:

getHexagonsByCubeRange in interface HexagonalGrid<T extends SatelliteData>

Parameters:

from - from

to - to

Returns:

Hexagons in the given range.

getHexagonsByOffsetRange

public rx.Observable<Hexagon<T>> getHexagonsByOffsetRange(int gridXFrom,
                                                          int gridXTo,
                                                          int gridYFrom,
                                                          int gridYTo)

Description copied from interface: HexagonalGrid

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.

Specified by:

getHexagonsByOffsetRange in interface HexagonalGrid<T extends SatelliteData>

Parameters:

gridXFrom - from x inclusive

gridXTo - to x inclusive

gridYFrom - from z inclusive

gridYTo - to z inclusive

Returns:

Hexagons in the given range.

containsCubeCoordinate

public boolean containsCubeCoordinate(CubeCoordinate cubeCoordinate)

Description copied from interface: HexagonalGrid

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

Specified by:

containsCubeCoordinate in interface HexagonalGrid<T extends SatelliteData>

Parameters:

cubeCoordinate - coord

Returns:

is it on the grid?

getByCubeCoordinate

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

Description copied from interface: HexagonalGrid

Returns a Hexagon by its cube coordinate.

Specified by:

getByCubeCoordinate in interface HexagonalGrid<T extends SatelliteData>

Parameters:

coordinate - coord

Returns:

Optional with a Hexagon if it is present

getByPixelCoordinate

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

Description copied from interface: HexagonalGrid

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

Specified by:

getByPixelCoordinate in interface HexagonalGrid<T extends SatelliteData>

Parameters:

coordinateX - pixel coordinateX coordinate

coordinateY - pixel coordinateY coordinate

Returns:

Optional with a Hexagon if it is present

getNeighborByIndex

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

Description copied from interface: HexagonalGrid

Returns a neighbor of a Hexagon by its neighbor index.

Specified by:

getNeighborByIndex in interface HexagonalGrid<T extends SatelliteData>

Returns:

neighbor or empty Optional if not applicable

getNeighborsOf

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

Description copied from interface: HexagonalGrid

Returns all neighbors of a Hexagon.

Specified by:

getNeighborsOf in interface HexagonalGrid<T extends SatelliteData>

Parameters:

hexagon - Hexagon

Returns:

the Hexagon's neighbors