KHexagon/io.github.offlinebrain.khexagon.coordinates/DoubleHeightCoordinates

DoubleHeightCoordinates

data class DoubleHeightCoordinates(val col: Int, val row: Int) : Coordinates<DoubleHeightCoordinates> , FromHexCoordinates<DoubleHeightCoordinates> (source)

Represents a double height coordinate in the hexagonal grid layout, which doubles the row step size. Use in a flat top hex layout, the row is increased by 2 for each hex.

Constraint: (col + row) % 2 == 0

Constructors

constructor(col: Int, row: Int)

Types

Companion

object Companion

Properties

col

val col: Int

Column of the coordinate.

hex

open override val hex: HexCoordinates

Expects a property of HexCoordinates type, which should be provided by instances of this interface.

neighbors

val neighbors: List<DoubleHeightCoordinates>

open override val q: Int

The column coordinate of the point on the hexagonal grid.

open override val r: Int

The row coordinate of the point on the hexagonal grid.

row

val row: Int

Row of the coordinate.

Functions

get

operator fun get(int: Int): DoubleHeightCoordinates

into

open override fun HexCoordinates.into(): DoubleHeightCoordinates

Transforms the given this from HexCoordinates into the corresponding subtype of Coordinates.

plus

operator fun plus(other: DoubleHeightCoordinates): DoubleHeightCoordinates

toHexCoordinates

fun toHexCoordinates(): HexCoordinates