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

HexCoordinates

data class HexCoordinates(val q: Int, val r: Int) : Coordinates<HexCoordinates> , FromHexCoordinates<HexCoordinates> (source)

A data class representing a point in a hexagonal grid using cube coordinates (q, r, s). The s coordinate is calculated based on q and r as -q - r.

Constructors

constructor(q: Int, r: Int)

Types

object Companion

Properties

open override val hex: HexCoordinates

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

val neighbors: List<HexCoordinates>

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.

val s: Int

Functions

operator fun component3(): Int

operator fun get(direction: Int): HexCoordinates

Retrieves the neighboring HexCoordinates in the specified direction.

open override fun HexCoordinates.into(): HexCoordinates

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

operator fun minus(other: HexCoordinates): HexCoordinates

operator fun plus(other: HexCoordinates): HexCoordinates

toDoubleHeightCoordinates

fun HexCoordinates.toDoubleHeightCoordinates(): DoubleHeightCoordinates

toDoubleWidthCoordinates

fun HexCoordinates.toDoubleWidthCoordinates(): DoubleWidthCoordinates

toEvenQCoordinates

fun HexCoordinates.toEvenQCoordinates(): EvenQCoordinates

toEvenRCoordinates

fun HexCoordinates.toEvenRCoordinates(): EvenRCoordinates

toOddQCoordinates

fun HexCoordinates.toOddQCoordinates(): OddQCoordinates

toOddRCoordinates

fun HexCoordinates.toOddRCoordinates(): OddRCoordinates