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

Class GridLayoutStrategy

java.lang.Object

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

Direct Known Subclasses:

HexagonalGridLayoutStrategy, RectangularGridLayoutStrategy, TrapezoidGridLayoutStrategy, TriangularGridLayoutStrategy

public abstract class GridLayoutStrategy
extends Object

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

Constructor Summary

Constructors

Constructor and Description
GridLayoutStrategy()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkCommonCase(int gridHeight, int gridWidth)
abstract boolean	checkParameters(int gridHeight, int gridWidth) Checks whether the supplied parameters are valid for the given strategy.
abstract rx.Observable<CubeCoordinate>	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.

Methods inherited from class java.lang.Object

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

Constructor Detail

GridLayoutStrategy

public GridLayoutStrategy()

Method Detail

fetchGridCoordinates

public abstract rx.Observable<CubeCoordinate> 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.

Parameters:

builder - builder

Returns:

observable

checkParameters

public abstract 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

Parameters:

gridHeight - height

gridWidth - width

Returns:

valid?

checkCommonCase

protected final boolean checkCommonCase(int gridHeight,
                                        int gridWidth)