A B C D E F G H N O P R S T V

A

addHexagon(AxialCoordinate) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Adds a new Hexagon at the given coordinate.

addHexagon(AxialCoordinate) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

AxialCoordinate - Class in org.codetome.hexameter.api

Represents an axial coorinate pair.

B

build() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Builds a HexagonalGrid using the parameters supplied.

buildCalculatorFor(HexagonalGrid) - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Creates a HexagonalGridCalculator for your HexagonalGrid.

C

calculateDistanceBetween(Hexagon, Hexagon) - Method in interface org.codetome.hexameter.api.HexagonalGridCalculator

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

calculateDistanceBetween(Hexagon, Hexagon) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridCalculatorImpl

calculateMovementRangeFrom(Hexagon, int) - Method in interface org.codetome.hexameter.api.HexagonalGridCalculator

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

calculateMovementRangeFrom(Hexagon, int) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridCalculatorImpl

checkParameters(int, int) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.EmptyGridLayoutStrategy

checkParameters(int, int) - Method in interface org.codetome.hexameter.internal.impl.layoutstrategy.GridLayoutStrategy

Checks whether the supplied parameters are valid for the given strategy.

checkParameters(int, int) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.HexagonalGridLayoutStrategy

checkParameters(int, int) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.RectangularGridLayoutStrategy

checkParameters(int, int) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.TrapezoidGridLayoutStrategy

checkParameters(int, int) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.TriangularGridLayoutStrategy

clearSatelliteData() - Method in interface org.codetome.hexameter.api.Hexagon

Clears the satellite data of this Hexagon.

clearSatelliteData() - Method in interface org.codetome.hexameter.api.HexagonalGrid

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

clearSatelliteData() - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

clearSatelliteData() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

containsAxialCoordinate(AxialCoordinate) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Tells whether the given axial coordinate is on the grid or not.

containsAxialCoordinate(AxialCoordinate) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

convertOffsetCoordinatesToAxialX(int, int, HexagonOrientation) - Static method in class org.codetome.hexameter.api.CoordinateConverter

Calculates the axial X coordinate based on an offset coordinate pair.

convertOffsetCoordinatesToAxialZ(int, int, HexagonOrientation) - Static method in class org.codetome.hexameter.api.CoordinateConverter

Calculates the axial Z coordinate based on an offset coordinate pair.

CoordinateConverter - Class in org.codetome.hexameter.api

Utility class for converting coordinated from the offset system to the axial one (the library uses the latter).

CoordinateConverter() - Constructor for class org.codetome.hexameter.api.CoordinateConverter

createHexagons(HexagonalGridBuilder) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.EmptyGridLayoutStrategy

createHexagons(HexagonalGridBuilder) - Method in interface org.codetome.hexameter.internal.impl.layoutstrategy.GridLayoutStrategy

Creates the Hexagon objects which fit in the shape of the requested layout.

createHexagons(HexagonalGridBuilder) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.HexagonalGridLayoutStrategy

createHexagons(HexagonalGridBuilder) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.RectangularGridLayoutStrategy

createHexagons(HexagonalGridBuilder) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.TrapezoidGridLayoutStrategy

createHexagons(HexagonalGridBuilder) - Method in class org.codetome.hexameter.internal.impl.layoutstrategy.TriangularGridLayoutStrategy

D

distanceFrom(Point) - Method in class org.codetome.hexameter.api.Point

Calculates a distance between two points.

E

EmptyGridLayoutStrategy - Class in org.codetome.hexameter.internal.impl.layoutstrategy

This strategy is responsible for generating a HexagonalGrid which has a triangular shape.

EmptyGridLayoutStrategy() - Constructor for class org.codetome.hexameter.internal.impl.layoutstrategy.EmptyGridLayoutStrategy

F

fromCoordinates(int, int) - Static method in class org.codetome.hexameter.api.AxialCoordinate

Creates an instance of AxialCoordinate from an x and a z coordinate.

fromKey(String) - Static method in class org.codetome.hexameter.api.AxialCoordinate

Tries to create an AxialCoordinate from a key which has the format: %gridX%,%gridZ%.

fromPosition(double, double) - Static method in class org.codetome.hexameter.api.Point

Creates a point from x and y positions.

G

getAxialCoordinate() - Method in interface org.codetome.hexameter.api.Hexagon

Returns the AxialCoordinate of this Hexagon.

getAxialCoordinate() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getByAxialCoordinate(AxialCoordinate) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Returns a Hexagon by its axial coordinate.

getByAxialCoordinate(AxialCoordinate) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

getByPixelCoordinate(double, double) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Returns a Hexagon by a pixel coordinate.

getByPixelCoordinate(double, double) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

getCenterX() - Method in interface org.codetome.hexameter.api.Hexagon

Returns the center x (pixel) coordinate of this Hexagon.

getCenterX() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getCenterY() - Method in interface org.codetome.hexameter.api.Hexagon

Returns the center y (pixel) coordinate of this Hexagon.

getCenterY() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getCoordinateOffset() - Method in enum org.codetome.hexameter.api.HexagonOrientation

This is because the flat/pointy shape of a hexagon.

getCustomStorage() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

getGridHeight() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

getGridLayoutStrategy() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

getGridLayoutStrategy() - Method in enum org.codetome.hexameter.api.HexagonalGridLayout

getGridWidth() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

getGridX() - Method in class org.codetome.hexameter.api.AxialCoordinate

getGridX() - Method in interface org.codetome.hexameter.api.Hexagon

Returns this Hexagon's x (axial) coordinate on the HexagonalGrid.

getGridX() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getGridY() - Method in interface org.codetome.hexameter.api.Hexagon

Returns this Hexagon's y coordinate on the HexagonalGrid.

getGridY() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getGridZ() - Method in class org.codetome.hexameter.api.AxialCoordinate

getGridZ() - Method in interface org.codetome.hexameter.api.Hexagon

Returns this Hexagon's z (axial) coordinate on the HexagonalGrid.

getGridZ() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getHeight() - Method in class org.codetome.hexameter.internal.SharedHexagonData

getHexagons() - Method in interface org.codetome.hexameter.api.HexagonalGrid

Returns all Hexagons contained in this grid.

getHexagons() - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

getHexagonsByAxialRange(AxialCoordinate, AxialCoordinate) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Returns all Hexagons contained in the given axial coordinate range.

getHexagonsByAxialRange(AxialCoordinate, AxialCoordinate) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

getHexagonsByOffsetRange(int, int, int, int) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Returns all Hexagons contained in the given offset coordinate range.

getHexagonsByOffsetRange(int, int, int, int) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

getId() - Method in interface org.codetome.hexameter.api.Hexagon

Returns an unique String representing this Hexagon.

getId() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getNeighborsOf(Hexagon) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Returns all neighbors of a Hexagon.

getNeighborsOf(Hexagon) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

getOrientation() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

getOrientation() - Method in class org.codetome.hexameter.internal.SharedHexagonData

getPoints() - Method in interface org.codetome.hexameter.api.Hexagon

Returns a list containing the Points of this Hexagon.

getPoints() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getRadius() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

getRadius() - Method in class org.codetome.hexameter.internal.SharedHexagonData

getSatelliteData() - Method in interface org.codetome.hexameter.api.Hexagon

Returns this Hexagon's satellite data.

getSatelliteData() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

getSharedHexagonData() - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

getWidth() - Method in class org.codetome.hexameter.internal.SharedHexagonData

getX() - Method in class org.codetome.hexameter.api.Point

getY() - Method in class org.codetome.hexameter.api.Point

GridLayoutStrategy - Interface in org.codetome.hexameter.internal.impl.layoutstrategy

Represents the method of creating a HexagonalGrid corresponding to a given shape.

H

Hexagon - Interface in org.codetome.hexameter.api

Represents a Hexagon.

HexagonalGrid - Interface in org.codetome.hexameter.api

Represents a hexagonal grid.

HexagonalGridBuilder - Class in org.codetome.hexameter.api

Builder for a HexagonalGrid.

HexagonalGridBuilder() - Constructor for class org.codetome.hexameter.api.HexagonalGridBuilder

HexagonalGridCalculator - Interface in org.codetome.hexameter.api

Supports advanced operations on a HexagonalGrid.

HexagonalGridCalculatorImpl - Class in org.codetome.hexameter.internal.impl

HexagonalGridCalculatorImpl(HexagonalGrid) - Constructor for class org.codetome.hexameter.internal.impl.HexagonalGridCalculatorImpl

HexagonalGridCreationException - Exception in org.codetome.hexameter.api.exception

HexagonalGridCreationException(String) - Constructor for exception org.codetome.hexameter.api.exception.HexagonalGridCreationException

HexagonalGridImpl - Class in org.codetome.hexameter.internal.impl

HexagonalGridImpl(HexagonalGridBuilder) - Constructor for class org.codetome.hexameter.internal.impl.HexagonalGridImpl

HexagonalGridLayout - Enum in org.codetome.hexameter.api

This enum represents the possible shapes a HexagonalGrid can have.

HexagonalGridLayoutStrategy - Class in org.codetome.hexameter.internal.impl.layoutstrategy

This strategy is responsible for generating a HexagonalGrid which has a hexagonal shape.

HexagonalGridLayoutStrategy() - Constructor for class org.codetome.hexameter.internal.impl.layoutstrategy.HexagonalGridLayoutStrategy

HexagonImpl - Class in org.codetome.hexameter.internal.impl

Default implementation of the Hexagon interface.

HexagonNotFoundException - Exception in org.codetome.hexameter.api.exception

HexagonNotFoundException(String, Throwable) - Constructor for exception org.codetome.hexameter.api.exception.HexagonNotFoundException

HexagonNotFoundException(String) - Constructor for exception org.codetome.hexameter.api.exception.HexagonNotFoundException

HexagonOrientation - Enum in org.codetome.hexameter.api

Enum representing the possible orientations of a Hexagon.

N

newHexagon(SharedHexagonData, AxialCoordinate) - Static method in class org.codetome.hexameter.internal.impl.HexagonImpl

Creates a new Hexagon object from shared data and a coordinate.

O

org.codetome.hexameter.api - package org.codetome.hexameter.api

org.codetome.hexameter.api.exception - package org.codetome.hexameter.api.exception

org.codetome.hexameter.internal - package org.codetome.hexameter.internal

org.codetome.hexameter.internal.impl - package org.codetome.hexameter.internal.impl

org.codetome.hexameter.internal.impl.layoutstrategy - package org.codetome.hexameter.internal.impl.layoutstrategy

P

Point - Class in org.codetome.hexameter.api

Represents a point.

R

RectangularGridLayoutStrategy - Class in org.codetome.hexameter.internal.impl.layoutstrategy

This strategy is responsible for generating a HexagonalGrid which has a rectangular shape.

RectangularGridLayoutStrategy() - Constructor for class org.codetome.hexameter.internal.impl.layoutstrategy.RectangularGridLayoutStrategy

removeHexagon(AxialCoordinate) - Method in interface org.codetome.hexameter.api.HexagonalGrid

Removes the Hexagon at the given coordinate.

removeHexagon(AxialCoordinate) - Method in class org.codetome.hexameter.internal.impl.HexagonalGridImpl

S

SatelliteData - Interface in org.codetome.hexameter.api

Represents arbitrary data which can be attached to a Hexagon.

setCustomStorage(Map<String, Hexagon>) - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Sets a custom storage object to the HexagonalGrid.

setGridHeight(int) - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Mandatory parameter.

setGridLayout(HexagonalGridLayout) - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Sets the HexagonalGridLayout which will be used when creating the HexagonalGrid.

setGridWidth(int) - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Mandatory parameter.

setOrientation(HexagonOrientation) - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Sets the HexagonOrientation used in the resulting HexagonalGrid.

setRadius(double) - Method in class org.codetome.hexameter.api.HexagonalGridBuilder

Sets the radius of the Hexagons contained in the resulting HexagonalGrid.

setSatelliteData(T) - Method in interface org.codetome.hexameter.api.Hexagon

Can be used to add arbitrary satellite data to a Hexagon.

setSatelliteData(T) - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

SharedHexagonData - Class in org.codetome.hexameter.internal

Immutable class which holds the shared data between the Hexagons of a HexagonalGrid.

SharedHexagonData(HexagonOrientation, double) - Constructor for class org.codetome.hexameter.internal.SharedHexagonData

T

toKey() - Method in class org.codetome.hexameter.api.AxialCoordinate

Creates a key which can be used in key-value storage objects based on this AxialCoordinate.

toString() - Method in class org.codetome.hexameter.internal.impl.HexagonImpl

TrapezoidGridLayoutStrategy - Class in org.codetome.hexameter.internal.impl.layoutstrategy

TrapezoidGridLayoutStrategy() - Constructor for class org.codetome.hexameter.internal.impl.layoutstrategy.TrapezoidGridLayoutStrategy

TriangularGridLayoutStrategy - Class in org.codetome.hexameter.internal.impl.layoutstrategy

This strategy is responsible for generating a HexagonalGrid which has a triangular shape.

TriangularGridLayoutStrategy() - Constructor for class org.codetome.hexameter.internal.impl.layoutstrategy.TriangularGridLayoutStrategy

V

valueOf(String) - Static method in enum org.codetome.hexameter.api.HexagonalGridLayout

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.codetome.hexameter.api.HexagonOrientation

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.codetome.hexameter.api.HexagonalGridLayout

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.codetome.hexameter.api.HexagonOrientation

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H N O P R S T V