org.codetome.hexameter.core.internal.impl

Class HexagonalGridCalculatorImpl<T extends SatelliteData>

java.lang.Object

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

All Implemented Interfaces:

HexagonalGridCalculator<T>

public final class HexagonalGridCalculatorImpl<T extends SatelliteData>
extends Object
implements HexagonalGridCalculator<T>

Constructor Summary

Constructors

Constructor and Description
HexagonalGridCalculatorImpl(HexagonalGrid hexagonalGrid)

Method Summary

Modifier and Type	Method and Description
int	calculateDistanceBetween(Hexagon hex0, Hexagon 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

HexagonalGridCalculatorImpl

public HexagonalGridCalculatorImpl(HexagonalGrid hexagonalGrid)

Method Detail

calculateDistanceBetween

public int calculateDistanceBetween(Hexagon hex0,
                                    Hexagon hex1)

Description copied from interface: HexagonalGridCalculator

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

Specified by:

calculateDistanceBetween in interface HexagonalGridCalculator<T extends SatelliteData>

Parameters:

hex0 - hex 0

hex1 - hex 1

Returns:

distance

calculateMovementRangeFrom

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

Description copied from interface: HexagonalGridCalculator

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

Specified by:

calculateMovementRangeFrom in interface HexagonalGridCalculator<T extends SatelliteData>

Parameters:

hexagon - Hexagon

distance - distance

Returns:

Hexagons within distance (inclusive)

rotateHexagon

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

Description copied from interface: HexagonalGridCalculator

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

Specified by:

rotateHexagon in interface HexagonalGridCalculator<T extends SatelliteData>

Parameters:

originalHex - center hex

targetHex - hex to rotate

rotationDirection - direction of the rotation

Returns:

result

calculateRingFrom

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

Description copied from interface: HexagonalGridCalculator

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

Specified by:

calculateRingFrom in interface HexagonalGridCalculator<T extends SatelliteData>

Parameters:

centerHexagon - center

radius - radius

Returns:

Set of hexagons or empty set if not applicable

drawLine

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

Description copied from interface: HexagonalGridCalculator

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

Specified by:

drawLine in interface HexagonalGridCalculator<T extends SatelliteData>

Parameters:

from - starting hexagon

to - target hexagon

Returns:

List of hexagons containing the line

isVisible

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

Description copied from interface: HexagonalGridCalculator

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

Specified by:

isVisible in interface HexagonalGridCalculator<T extends SatelliteData>

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