public final class HexagonalGridBuilder extends Object
Builder for a HexagonalGrid.
Can be used to build a HexagonalGrid.
Mandatory parameters are:
Hexagon| Constructor and Description |
|---|
HexagonalGridBuilder() |
public HexagonalGridBuilder setGridLayout(HexagonalGridLayout gridLayout)
HexagonalGridLayout which will be used when creating the HexagonalGrid.
If it is not set RECTANGULARwill be assumed.
gridLayout - HexagonalGridBuilder.public HexagonalGrid build()
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.HexagonalGridpublic HexagonalGridCalculator buildCalculatorFor(HexagonalGrid hexagonalGrid)
HexagonalGridCalculator for your HexagonalGrid.hexagonalGrid - public double getRadius()
public HexagonalGridBuilder setRadius(double radius)
Hexagons contained in the resulting HexagonalGrid.radius - in pixelsHexagonalGridBuilderpublic int getGridWidth()
public HexagonalGridBuilder setGridWidth(int gridWidth)
Hexagons in the horizontal direction.gridWidth - HexagonalGridBuilderpublic int getGridHeight()
public HexagonalGridBuilder setGridHeight(int gridHeight)
Hexagons in the vertical direction.gridHeight - HexagonalGridBuilderpublic HexagonOrientation getOrientation()
public HexagonalGridBuilder setOrientation(HexagonOrientation orientation)
HexagonOrientation used in the resulting HexagonalGrid.
If it is not set HexagonOrientation.POINTY will be used.orientation - HexagonalGridBuilderpublic GridLayoutStrategy getGridLayoutStrategy()
public HexagonalGridBuilder setCustomStorage(Map<String,Hexagon> customStorage)
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()AbstractMap if you need help.customStorage - HexagonalGridBuilder.public SharedHexagonData getSharedHexagonData()
Copyright © 2016. All rights reserved.