org.codetome.hexameter.core.api

Interface HexagonalGridCalculator<T extends SatelliteData>

All Known Implementing Classes:

HexagonalGridCalculatorImpl

public interface HexagonalGridCalculator<T extends SatelliteData>

Supports advanced operations on a HexagonalGrid. Operations supported:

• Calculating distance between 2 Hexagons.
• Calculating movement range from a Hexagon using an arbitrary distance.

Not implemented yet, but are on the roadmap:

• Calculating movement range with obstacles
• Calculating field of view
• Path finding between two Hexagons (using obstacles)

Method Summary

Modifier and Type	Method and Description
int	calculateDistanceBetween(Hexagon<T> hex0, Hexagon<T> hex1) Calculates the distance (in hexagons) between two Hexagon objects on the grid.
Set<Hexagon<T>>	calculateMovementRangeFrom(Hexagon<T> hexagon, int distance) Returns all Hexagons which are within distance (inclusive) from the Hexagon.
Set<Hexagon<T>>	calculateRingFrom(Hexagon<T> centerHexagon, int radius) Returns the Set of Hexagons which are radius distance from centerHexagon.
List<Hexagon<T>>	drawLine(Hexagon<T> from, Hexagon<T> to) Returns a List of Hexagons which must be traversed in the given order to go from the from Hexagon to the to Hexagon.
boolean	isVisible(Hexagon<T> from, Hexagon<T> to) Returns true if the from Hexagon is visible from the to Hexagon.
Optional<Hexagon<T>>	rotateHexagon(Hexagon<T> originalHex, Hexagon<T> targetHex, RotationDirection rotationDirection) Returns the Hexagon on the grid which is at the point resulted by rotating the targetHex's coordinates around the originalHex by rotationDirection degrees.

Method Detail

calculateDistanceBetween

int calculateDistanceBetween(Hexagon<T> hex0,
                             Hexagon<T> hex1)

Calculates the distance (in hexagons) between two Hexagon objects on the grid.

Parameters:

hex0 - hex 0

hex1 - hex 1

Returns:

distance

calculateMovementRangeFrom

Set<Hexagon<T>> calculateMovementRangeFrom(Hexagon<T> hexagon,
                                           int distance)

Returns all Hexagons which are within distance (inclusive) from the Hexagon.

Parameters:

hexagon - Hexagon

distance - distance

Returns:

Hexagons within distance (inclusive)

rotateHexagon

Optional<Hexagon<T>> rotateHexagon(Hexagon<T> originalHex,
                                   Hexagon<T> targetHex,
                                   RotationDirection rotationDirection)

Returns the Hexagon on the grid which is at the point resulted by rotating the targetHex's coordinates around the originalHex by rotationDirection degrees.

Parameters:

originalHex - center hex

targetHex - hex to rotate

rotationDirection - direction of the rotation

Returns:

result

calculateRingFrom

Set<Hexagon<T>> calculateRingFrom(Hexagon<T> centerHexagon,
                                  int radius)

Returns the Set of Hexagons which are radius distance from centerHexagon.

Parameters:

centerHexagon - center

radius - radius

Returns:

Set of hexagons or empty set if not applicable

drawLine

List<Hexagon<T>> drawLine(Hexagon<T> from,
                          Hexagon<T> to)

Returns a List of Hexagons which must be traversed in the given order to go from the from Hexagon to the to Hexagon.

Parameters:

from - starting hexagon

to - target hexagon

Returns:

List of hexagons containing the line

isVisible

boolean isVisible(Hexagon<T> from,
                  Hexagon<T> to)

Returns true if the from Hexagon is visible from the to Hexagon.

Parameters:

from - the Hexagon that we are testing the visibility from

to - the Hexagon from which we are testing the visibility to

Returns:

true if hexagon is visible, false otherwise