org.codetome.hexameter.api

Class HexagonalGridBuilder

java.lang.Object

org.codetome.hexameter.api.HexagonalGridBuilder

public final class HexagonalGridBuilder
extends Object

Builder for a HexagonalGrid. Can be used to build a HexagonalGrid. Mandatory parameters are:

• width of the grid
• height of the grid
• radius of a Hexagon

Defaults for orientation and grid layout are POINTY_TOP and RECTANGULAR.

Constructor Summary

Constructors

Constructor and Description
HexagonalGridBuilder()

Method Summary

Modifier and Type	Method and Description
HexagonalGrid	build() Builds a HexagonalGrid using the parameters supplied.
HexagonalGridCalculator	buildCalculatorFor(HexagonalGrid hexagonalGrid) Creates a HexagonalGridCalculator for your HexagonalGrid.
Map<String,Hexagon>	getCustomStorage()
int	getGridHeight()
GridLayoutStrategy	getGridLayoutStrategy()
int	getGridWidth()
HexagonOrientation	getOrientation()
double	getRadius()
SharedHexagonData	getSharedHexagonData()
HexagonalGridBuilder	setCustomStorage(Map<String,Hexagon> customStorage) Sets a custom storage object to the HexagonalGrid.
HexagonalGridBuilder	setGridHeight(int gridHeight) Mandatory parameter.
HexagonalGridBuilder	setGridLayout(HexagonalGridLayout gridLayout) Sets the HexagonalGridLayout which will be used when creating the HexagonalGrid.
HexagonalGridBuilder	setGridWidth(int gridWidth) Mandatory parameter.
HexagonalGridBuilder	setOrientation(HexagonOrientation orientation) Sets the HexagonOrientation used in the resulting HexagonalGrid.
HexagonalGridBuilder	setRadius(double radius) Sets the radius of the Hexagons contained in the resulting HexagonalGrid.

Methods inherited from class java.lang.Object

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

Constructor Detail

HexagonalGridBuilder

public HexagonalGridBuilder()

Method Detail

setGridLayout

public HexagonalGridBuilder setGridLayout(HexagonalGridLayout gridLayout)

Sets the HexagonalGridLayout which will be used when creating the HexagonalGrid. If it is not set

RECTANGULAR

will be assumed.

Parameters:

gridLayout -

Returns:

this HexagonalGridBuilder.

build

public HexagonalGrid build()

Builds a HexagonalGrid using the parameters supplied. Throws HexagonalGridCreationException if not all mandatory parameters are filled and/or they are not valid. In both cases you will be supplied with a HexagonalGridCreationException detailing the cause of failure.

Returns:

HexagonalGrid

buildCalculatorFor

public HexagonalGridCalculator buildCalculatorFor(HexagonalGrid hexagonalGrid)

Creates a HexagonalGridCalculator for your HexagonalGrid.

Parameters:

hexagonalGrid -

Returns:

calculator

getRadius

public double getRadius()

setRadius

public HexagonalGridBuilder setRadius(double radius)

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

Parameters:

radius - in pixels

Returns:

this HexagonalGridBuilder

getGridWidth

public int getGridWidth()

setGridWidth

public HexagonalGridBuilder setGridWidth(int gridWidth)

Mandatory parameter. Sets the number of Hexagons in the horizontal direction.

Parameters:

gridWidth -

Returns:

this HexagonalGridBuilder

getGridHeight

public int getGridHeight()

setGridHeight

public HexagonalGridBuilder setGridHeight(int gridHeight)

Mandatory parameter. Sets the number of Hexagons in the vertical direction.

Parameters:

gridHeight -

Returns:

this HexagonalGridBuilder

getOrientation

public HexagonOrientation getOrientation()

setOrientation

public HexagonalGridBuilder setOrientation(HexagonOrientation orientation)

Sets the HexagonOrientation used in the resulting HexagonalGrid. If it is not set HexagonOrientation.POINTY will be used.

Parameters:

orientation -

Returns:

this HexagonalGridBuilder

getGridLayoutStrategy

public GridLayoutStrategy getGridLayoutStrategy()

getCustomStorage

public Map<String,Hexagon> getCustomStorage()

setCustomStorage

public HexagonalGridBuilder setCustomStorage(Map<String,Hexagon> customStorage)

Sets a custom storage object to the HexagonalGrid. It will be used instead of the internal storage. You can pass any custom storage object as long as it implements the Map interface. Refer to the swt example project for examples. Please note that if you supply a Map which is not empty the HexagonalGrid will overwrite its contents. Methods you must implement:

• Map.containsKey(Object)
• Map.get(Object)
• Map.putAll(Map)
• Map.put(Object, Object)
• Map.remove(Object)
• Map.keySet()

Others are not necessary but highly recommended. Refer to the javadoc of AbstractMap if you need help.

Parameters:

customStorage -

Returns:

this HexagonalGridBuilder.

getSharedHexagonData

public SharedHexagonData getSharedHexagonData()