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

Interface GridLayoutStrategy

All Known Implementing Classes:

EmptyGridLayoutStrategy, HexagonalGridLayoutStrategy, RectangularGridLayoutStrategy, TrapezoidGridLayoutStrategy, TriangularGridLayoutStrategy

public interface GridLayoutStrategy

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

Method Summary

Modifier and Type	Method and Description
default boolean	checkParameters(int gridHeight, int gridWidth) Checks whether the supplied parameters are valid for the given strategy.
Set<AxialCoordinate>	fetchGridCoordinates(HexagonalGridBuilder builder) Fetches a monotonically increasing (from left to right, top to bottom) Set of grid coordinates corresponding to the shape of the requested grid layout.

Method Detail

fetchGridCoordinates

Set<AxialCoordinate> fetchGridCoordinates(HexagonalGridBuilder builder)

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

checkParameters

default boolean checkParameters(int gridHeight,
                                int gridWidth)

Checks whether the supplied parameters are valid for the given strategy. For example a hexagonal grid layout only works if the width equals to the height

Returns:

valid?