org.codetome.hexameter.api

Interface HexagonalGridCalculator

All Known Implementing Classes:

HexagonalGridCalculatorImpl

public interface HexagonalGridCalculator

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
• Pathfinding between two Hexagons (using obstacles)

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>	calculateMovementRangeFrom(Hexagon hexagon, int distance) Returns all Hexagons which are within distance (inclusive) from the Hexagon.

Method Detail

calculateDistanceBetween

int calculateDistanceBetween(Hexagon hex0,
                             Hexagon hex1)

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

Parameters:

hex0 -

hex1 -

Returns:

distance

calculateMovementRangeFrom

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

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

Parameters:

hexagon - Hexagon

distance -

Returns:

Hexagons within distance (inclusive)