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

A

addCustomData(String, T) - Method in class org.codetome.hexameter.core.api.DefaultSatelliteData

addCustomData(String, T) - Method in interface org.codetome.hexameter.core.api.SatelliteData

Adds custom data to this SatelliteData.

AxialCoordinate - Class in org.codetome.hexameter.core.api

Represents an axial coorinate pair.

B

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

Builds a HexagonalGrid using the parameters supplied.

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

Creates a HexagonalGridCalculator for your HexagonalGrid.

C

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

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

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

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

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

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

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

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

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

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

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

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

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

Clears the satellite data of this Hexagon.

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

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

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

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

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

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

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

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

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

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

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

CoordinateConverter - Class in org.codetome.hexameter.core.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.core.api.CoordinateConverter

D

DefaultSatelliteData - Class in org.codetome.hexameter.core.api

Convenience class implementing SatelliteData.

DefaultSatelliteData() - Constructor for class org.codetome.hexameter.core.api.DefaultSatelliteData

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

Calculates a distance between two points.

E

empty() - Static method in class org.codetome.hexameter.core.backport.Optional

Returns an empty Optional instance.

equals(Object) - Method in class org.codetome.hexameter.core.backport.Optional

Indicates whether some other object is "equal to" this Optional.

F

fetchGridCoordinates(HexagonalGridBuilder) - Method in class org.codetome.hexameter.core.internal.impl.layoutstrategy.GridLayoutStrategy

Fetches a monotonically increasing (from left to right, top to bottom) Set of grid coordinates corresponding to the shape of the requested grid layout.

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

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

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

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

filter(Predicate<? super T>) - Method in class org.codetome.hexameter.core.backport.Optional

If a value is present, and the value matches the given predicate, return an Optional describing the value, otherwise return an empty Optional.

flatMap(Function<? super T, Optional<U>>) - Method in class org.codetome.hexameter.core.backport.Optional

If a value is present, apply the provided Optional-bearing mapping function to it, return that result, otherwise return an empty Optional.

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

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

fromKey(String) - Static method in class org.codetome.hexameter.core.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.core.api.Point

Creates a point from coordinateX and coordinateY positions.

G

get() - Method in class org.codetome.hexameter.core.backport.Optional

If a value is present in this Optional, returns the value, otherwise throws NoSuchElementException.

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

Returns the AxialCoordinate of this Hexagon.

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

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

Returns a Hexagon by its axial coordinate.

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

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

Returns a Hexagon by a pixel coordinate.

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

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

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

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

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

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

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

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

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

getCustomData(String) - Method in class org.codetome.hexameter.core.api.DefaultSatelliteData

getCustomData(String) - Method in interface org.codetome.hexameter.core.api.SatelliteData

Retrieves custom data stored in this SatelliteData.

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

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

Returns this HexagonalGrid's GridData.

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

Returns the GridData.

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

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

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

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

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

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

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

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

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

Returns this Hexagon's y coordinate on the HexagonalGrid.

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

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

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

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

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

Returns all Hexagons contained in this grid.

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

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

Returns all Hexagons contained in the given axial coordinate range.

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

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

Returns all Hexagons contained in the given offset coordinate range.

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

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

Returns an unique String representing this Hexagon.

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

getMovementCost() - Method in interface org.codetome.hexameter.core.api.SatelliteData

Returns the movement cost when moving over the Hexagon.

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

Returns all neighbors of a Hexagon.

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

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

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

Returns a list containing the Points of this Hexagon.

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

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

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

Returns this Hexagon's satellite data.

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

GridData - Class in org.codetome.hexameter.core.internal

Immutable class which holds the shared data between the Hexagons of a HexagonalGrid and the HexagonalGrid's own immutable properties.

GridData(HexagonOrientation, HexagonalGridLayout, double, int, int) - Constructor for class org.codetome.hexameter.core.internal.GridData

Creates a new GridData based on orientation and radius.

GridLayoutStrategy - Class in org.codetome.hexameter.core.internal.impl.layoutstrategy

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

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

H

hashCode() - Method in class org.codetome.hexameter.core.backport.Optional

Returns the hash code value of the present value, if any, or 0 (zero) if no value is present.

Hexagon - Interface in org.codetome.hexameter.core.api

Represents a Hexagon.

HexagonalGrid - Interface in org.codetome.hexameter.core.api

Represents a hexagonal grid.

HexagonalGridBuilder - Class in org.codetome.hexameter.core.api

Builder for a HexagonalGrid.

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

HexagonalGridCalculator - Interface in org.codetome.hexameter.core.api

Supports advanced operations on a HexagonalGrid.

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

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

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

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

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

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

Creates a new HexagonalGrid based on the provided HexagonalGridBuilder.

HexagonalGridLayout - Enum in org.codetome.hexameter.core.api

This enum represents the possible shapes a HexagonalGrid can have.

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

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

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

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

Default implementation of the Hexagon interface.

HexagonOrientation - Enum in org.codetome.hexameter.core.api

Enum representing the possible orientations of a Hexagon.

I

ifPresent(Consumer<? super T>) - Method in class org.codetome.hexameter.core.backport.Optional

If a value is present, invoke the specified consumer with the value, otherwise do nothing.

isPassable() - Method in interface org.codetome.hexameter.core.api.SatelliteData

Tells whether the Hexagon can be passed over when moving around the map or not.

isPresent() - Method in class org.codetome.hexameter.core.backport.Optional

Return true if there is a value present, otherwise false.

M

map(Function<? super T, ? extends U>) - Method in class org.codetome.hexameter.core.backport.Optional

If a value is present, apply the provided mapping function to it, and if the result is non-null, return an Optional describing the result.

N

newHexagon(GridData, AxialCoordinate, Map<AxialCoordinate, Object>) - Static method in class org.codetome.hexameter.core.internal.impl.HexagonImpl

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

O

of(T) - Static method in class org.codetome.hexameter.core.backport.Optional

Returns an Optional with the specified present non-null value.

ofNullable(T) - Static method in class org.codetome.hexameter.core.backport.Optional

Returns an Optional describing the specified value, if non-null, otherwise returns an empty Optional.

Optional<T> - Class in org.codetome.hexameter.core.backport

A container object which may or may not contain a non-null value.

orElse(T) - Method in class org.codetome.hexameter.core.backport.Optional

Return the value if present, otherwise return other.

orElseGet(Supplier<? extends T>) - Method in class org.codetome.hexameter.core.backport.Optional

Return the value if present, otherwise invoke other and return the result of that invocation.

orElseThrow(Supplier<? extends X>) - Method in class org.codetome.hexameter.core.backport.Optional

Return the contained value, if present, otherwise throw an exception to be created by the provided supplier.

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

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

org.codetome.hexameter.core.backport - package org.codetome.hexameter.core.backport

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

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

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

P

Point - Class in org.codetome.hexameter.core.api

Represents a point.

R

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

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

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

S

SatelliteData - Interface in org.codetome.hexameter.core.api

Represents arbitrary data which can be attached to a Hexagon.

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

Mandatory parameter.

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

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

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

Mandatory parameter.

setMovementCost(double) - Method in interface org.codetome.hexameter.core.api.SatelliteData

Sets the movement cost.

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

Sets the HexagonOrientation used in the resulting HexagonalGrid.

setPassable(boolean) - Method in interface org.codetome.hexameter.core.api.SatelliteData

Sets whether the Hexagon is passable or not.

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

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

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

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

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

T

toKey() - Method in class org.codetome.hexameter.core.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.core.backport.Optional

Returns a non-empty string representation of this Optional suitable for debugging.

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

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

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

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

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

V

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

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

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

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

values() - Static method in enum org.codetome.hexameter.core.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.core.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 I M N O P R S T V