data/com.gonodono.hexgrid.data

Package-level declarations

Types

enum CrossMode : Enum<CrossMode>

Possible options for how to lay out the grid in the dimension perpendicular to the one that determines the cell size.

enum FitMode : Enum<FitMode>

Possible options for determining the hex cell size.

interface Grid

The library's specialized state collection that allows indexing by the particular address system used here.

enum HexOrientation : Enum<HexOrientation>

Possible options for the orientation of the cell hexagons.

class MutableGrid : Grid

The mutable version of the library's Grid structure.

StateMapBuilderScope

sealed interface StateMapBuilderScope

Scope for assembling State maps. For use with buildStateMap.

Properties

val EmptyGrid: Grid

An empty Grid instance for use as an initial value, a reset value, etc.

val HexOrientation.isHorizontal: Boolean

Convenience for concisely checking the hex orientation.

Functions

fun buildStateMap(block: StateMapBuilderScope.() -> Unit): Map<Grid.Address, Grid.State>

Provides a scope in which to build a Map using convenience functions.

fun MutableGrid.change(address: Grid.Address, isVisible: Boolean = this[address].isVisible, isSelected: Boolean = this[address].isSelected)

Updates the Grid.State at the given Grid.Address.

inline fun <T : Grid> T.changed(address: Grid.Address, isVisible: Boolean = this[address].isVisible, isSelected: Boolean = this[address].isSelected): T

Returns a modified copy of the Grid with the specified Grid.State update at the given Grid.Address.

fun Grid.Address.isAt(row: Int, column: Int): Boolean

Convenience to concisely check an Address against individual indices.

fun MutableGrid.toggle(address: Grid.Address)

Toggles the Grid.State.isSelected value at the given Grid.Address.

inline fun <T : Grid> T.toggled(address: Grid.Address): T

Returns a modified copy of the Grid with the Grid.State.isSelected value toggled at the given Grid.Address.