org.kynosarges.tektosyne.geometry

Enum PolygonGridShift

java.lang.Object

java.lang.Enum<PolygonGridShift>

org.kynosarges.tektosyne.geometry.PolygonGridShift

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PolygonGridShift>

public enum PolygonGridShift
extends java.lang.Enum<PolygonGridShift>

Specifies the shifting of rows or columns in a PolygonGrid. Valid choices dependon on the underlying RegularPolygon. Specifies how even-numbered rows or columns are shifted, relative to odd-numbered ones. For this purpose, counting starts at one for the PolygonGrid row or column at index position zero, so the first row or column is considered odd-numbered.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLUMN_DOWN Specifies that even-numbered columns are shifted downward.
COLUMN_UP Specifies that even-numbered columns are shifted upward.
NONE Specifies that no rows or columns are shifted.
ROW_LEFT Specifies that even-numbered rows are shifted left.
ROW_RIGHT Specifies that even-numbered rows are shifted right.

Method Summary

Modifier and Type	Method and Description
boolean	anyColumns() Indicates whether the PolygonGridShift shifts any columns.
boolean	anyRows() Indicates whether the PolygonGridShift shifts any rows.
boolean	isDownColumn(int column) Determines whether the specified column is shifted down compared to its neighbors.
boolean	isLeftRow(int row) Determines whether the specified row is shifted left compared to its neighbors.
boolean	isRightRow(int row) Determines whether the specified row is shifted right compared to its neighbors.
boolean	isUpColumn(int column) Determines whether the specified column is shifted up compared to its neighbors.
static PolygonGridShift	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PolygonGridShift[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final PolygonGridShift NONE

Specifies that no rows or columns are shifted. NONE is the only valid choice for a square grid with PolygonOrientation.ON_EDGE orientation.

COLUMN_UP

public static final PolygonGridShift COLUMN_UP

Specifies that even-numbered columns are shifted upward. COLUMN_UP and COLUMN_DOWN are the only valid choices for a hexagon grid with PolygonOrientation.ON_EDGE orientation.

COLUMN_DOWN

public static final PolygonGridShift COLUMN_DOWN

Specifies that even-numbered columns are shifted downward. COLUMN_UP and COLUMN_DOWN are the only valid choices for a hexagon grid with PolygonOrientation.ON_EDGE orientation.

ROW_RIGHT

public static final PolygonGridShift ROW_RIGHT

Specifies that even-numbered rows are shifted right. ROW_RIGHT and ROW_LEFT are the only valid choices for a hexagon grid with PolygonOrientation.ON_VERTEX orientation.

ROW_LEFT

public static final PolygonGridShift ROW_LEFT

Specifies that even-numbered rows are shifted left. ROW_RIGHT and ROW_LEFT are the only valid choices for a hexagon grid with PolygonOrientation.ON_VERTEX orientation.

Method Detail

values

public static PolygonGridShift[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PolygonGridShift c : PolygonGridShift.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PolygonGridShift valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

anyColumns

public boolean anyColumns()

Indicates whether the PolygonGridShift shifts any columns.

Returns:

true for COLUMN_UP or COLUMN_DOWN, else false

anyRows

public boolean anyRows()

Indicates whether the PolygonGridShift shifts any rows.

Returns:

true for ROW_LEFT or ROW_RIGHT, else false

isDownColumn

public boolean isDownColumn(int column)

Determines whether the specified column is shifted down compared to its neighbors. Always returns false if anyColumns() is false.

Parameters:

column - the zero-based index of the column to test

Returns:

true if column is shifted down, else false

isLeftRow

public boolean isLeftRow(int row)

Determines whether the specified row is shifted left compared to its neighbors. Always returns false if anyRows() is false.

Parameters:

row - the zero-based index of the row to test

Returns:

true if row is shifted left, else false

isRightRow

public boolean isRightRow(int row)

Determines whether the specified row is shifted right compared to its neighbors. Always returns false if anyRows() is false.

Parameters:

row - the zero-based index of the row to test

Returns:

true if row is shifted right, else false

isUpColumn

public boolean isUpColumn(int column)

Determines whether the specified column is shifted up compared to its neighbors. Always returns false if anyColumns() is false.

Parameters:

column - the zero-based index of the column to test

Returns:

true if column is shifted up, else false