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

Coordinates

interface Coordinates<T : Coordinates<T>> : AxisPoint(source)

The Coordinates interface is a generic contract for types which extend or implement Coordinates themselves. It provides constant directions for two hexagonal coordinate systems, Flat-top and Pointy-top.

The Flat object has six directions, starting from 'right-bottom' and moving counter-clockwise. The Pointy object also has six directions, starting from 'right' and moving counter-clockwise.

Parameters

This represents the type of the Coordinates, which is a subtype of Coordinates itself.

Inheritors

HexCoordinates

DoubleWidthCoordinates

DoubleHeightCoordinates

OffsetCoordinates

Types

Flat

object Flat

Enumeration of direction constants for Flat-top hexagonal layout. Directions start from 'RightBottom' and move counter-clockwise.

Pointy

object Pointy

Enumeration of direction constants for Pointy-top hexagonal layout. Directions start from 'Right' and move counter-clockwise.

Properties

hex

abstract val hex: HexCoordinates

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

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.