org.codetome.hexameter.internal.impl

Class HexagonalGridImpl

java.lang.Object

org.codetome.hexameter.internal.impl.HexagonalGridImpl

All Implemented Interfaces:

HexagonalGrid

public final class HexagonalGridImpl
extends Object
implements HexagonalGrid

Constructor Summary

Constructors

Constructor and Description
HexagonalGridImpl(HexagonalGridBuilder builder)

Method Summary

Modifier and Type	Method and Description
Hexagon	addHexagon(AxialCoordinate coordinate) Adds a new Hexagon at the given coordinate.
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 x, double y) 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.
Hexagon	removeHexagon(AxialCoordinate coordinate) Removes the Hexagon at the given coordinate.

Methods inherited from class java.lang.Object

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

Constructor Detail

HexagonalGridImpl

public HexagonalGridImpl(HexagonalGridBuilder builder)

Method Detail

getHexagons

public Iterable<Hexagon> getHexagons()

Description copied from interface: HexagonalGrid

Returns all Hexagons contained in this grid.

Specified by:

getHexagons in interface HexagonalGrid

Returns:

hexagons

getHexagonsByAxialRange

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

Description copied from interface: HexagonalGrid

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.

Specified by:

getHexagonsByAxialRange in interface HexagonalGrid

Returns:

Hexagons in the given range.

getHexagonsByOffsetRange

public Iterable<Hexagon> 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

Parameters:

gridXFrom - from x inclusive

gridXTo - to x inclusive

gridYFrom - from z inclusive

gridYTo - to z inclusive

Returns:

Hexagons in the given range.

addHexagon

public Hexagon addHexagon(AxialCoordinate coordinate)

Description copied from interface: HexagonalGrid

Adds a new Hexagon at the given coordinate. If there is already a Hexagon at the given position it is overwritten.

Specified by:

addHexagon in interface HexagonalGrid

Returns:

new Hexagon created.

removeHexagon

public Hexagon removeHexagon(AxialCoordinate coordinate)

Description copied from interface: HexagonalGrid

Removes the Hexagon at the given coordinate.

Specified by:

removeHexagon in interface HexagonalGrid

Returns:

the removed Hexagon

containsAxialCoordinate

public boolean containsAxialCoordinate(AxialCoordinate coordinate)

Description copied from interface: HexagonalGrid

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

Specified by:

containsAxialCoordinate in interface HexagonalGrid

Returns:

is it on the grid?

getByAxialCoordinate

public Optional<Hexagon> getByAxialCoordinate(AxialCoordinate coordinate)

Description copied from interface: HexagonalGrid

Returns a Hexagon by its axial coordinate.

Specified by:

getByAxialCoordinate in interface HexagonalGrid

Returns:

Optional with a Hexagon if it is present

getByPixelCoordinate

public Optional<Hexagon> getByPixelCoordinate(double x,
                                              double y)

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

Parameters:

x - pixel x coordinate

y - pixel y coordinate

Returns:

Optional with a Hexagon if it is present

getNeighborsOf

public Iterable<Hexagon> getNeighborsOf(Hexagon hexagon)

Description copied from interface: HexagonalGrid

Returns all neighbors of a Hexagon.

Specified by:

getNeighborsOf in interface HexagonalGrid

Parameters:

hexagon - Hexagon

Returns:

the Hexagon's neighbors

clearSatelliteData

public void clearSatelliteData()

Description copied from interface: HexagonalGrid

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

Specified by:

clearSatelliteData in interface HexagonalGrid