HGrid

trait HGrid extends TGrid

A grid of Hexs. The grid may be a regular rectangle of hexs or an irregular grid with variable length rows.

trait TGrid
class Object
trait Matchable
class Any

Document{}

final val numSides: Int

The number of Sides in the TileGrid. Needs reimplementing.

The number of Sides in the TileGrid. Needs reimplementing.

final def sidesForeach(f: HSide => Unit): Unit

foreach Hex side's coordinate HSide, calls the effectfull function.

foreach Hex side's coordinate HSide, calls the effectfull function.

final def sidesMap[B, ArrT <: ArrImut[B]](f: HSide => B)(implicit build: ArrTBuilder[B, ArrT]): ArrT

maps over each Hex Side's coordinate HSide in the given Row.

maps over each Hex Side's coordinate HSide in the given Row.

final def sidesFlatMap[ArrT <: ArrImut[_]](f: HSide => ArrT)(implicit build: ArrTFlatBuilder[ArrT]): ArrT

maps over each Hex Side's coordinate HSide in the given Row.

maps over each Hex Side's coordinate HSide in the given Row.

The Hex Sides of the Hex Grid defined in integer constructed HCoordLineSeg..

The Hex Sides of the Hex Grid defined in integer constructed HCoordLineSeg..

@inline
final def rSideMin: Int

The bottom Side Row of this TileGrid. The r value, the row number value.

The bottom Side Row of this TileGrid. The r value, the row number value.

Inherited from
TGrid
def sideRowForeach(f: Int => Unit): Unit

Foreachs over each Row of Sides. Users will not normally need to use this method directly.

Foreachs over each Row of Sides. Users will not normally need to use this method directly.

Inherited from
TGrid
@inline
final def rSideMax: Int

The top Side Row of this TileGrid. The r value, the row number.

The top Side Row of this TileGrid. The r value, the row number.

Inherited from
TGrid
final def sidesDraw(colour: Colour, lineWidth: Double): LinesDraw

This gives the all tile grid lines in a single colour and line width.

This gives the all tile grid lines in a single colour and line width.

Inherited from
TGrid
@inline
final def numOfSideRows: Int

The number of Rows of Sides.

The number of Rows of Sides.

Inherited from
TGrid

Value members

Abstract methods

def arrIndex(r: Int, c: Int): Int

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

def cRowCenMin(row: Int): Int

The minimum or starting column of the tile centre of the given row.

The minimum or starting column of the tile centre of the given row.

def hCenExists(r: Int, c: Int): Boolean

Boolean. True if the specified hex centre exists in this hex grid.

Boolean. True if the specified hex centre exists in this hex grid.

def numRow0s: Int

The number of tile centre rows where r %% 4 == 0.

The number of tile centre rows where r %% 4 == 0.

def numRow2s: Int

The number of tile centre rows where r %% 4 == 2.

The number of tile centre rows where r %% 4 == 2.

def rowForeach(r: Int)(f: HCen => Unit): Unit

Carries out the procedure function on each HCen hex tile centre coordinate in the given tile row. This method is defined here rather than on TileGrid so it can take the specific narrow HCen parameter to the foreach function.

Carries out the procedure function on each HCen hex tile centre coordinate in the given tile row. This method is defined here rather than on TileGrid so it can take the specific narrow HCen parameter to the foreach function.

def rowForeachSide(r: Int)(f: HSide => Unit): Unit

Calls the Foreach procedure on every Hex Side in the row given by the input parameter.

Calls the Foreach procedure on every Hex Side in the row given by the input parameter.

def rowIForeach(r: Int, count: Int)(f: (HCen, Int) => Unit): Int

Carries out the procedure function on each HCen hex tile centre coordinate and an index counter in the given tile row. This method is defined here rather than on TileGrid so it can take the specific narrow HCen parameter to the foreach function.

Carries out the procedure function on each HCen hex tile centre coordinate and an index counter in the given tile row. This method is defined here rather than on TileGrid so it can take the specific narrow HCen parameter to the foreach function.

def rowNumCens(row: Int): Int

The number of tile centres in the given row.

The number of tile centres in the given row.

def sideArrIndex(r: Int, c: Int): Int

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

def sideRowIndexArray: Array[Int]

Array of indexs for Side data Arrs giving the index value for the start of each side row.

Array of indexs for Side data Arrs giving the index value for the start of each side row.

Concrete methods

The active tiles without any PaintElems.

The active tiles without any PaintElems.

@inline
final def arrIndex(hc: HCen): Int

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

def cCen: Double

The centre of the hex grid in terms of c column coordinates.

The centre of the hex grid in terms of c column coordinates.

final def cenRowEmpty(row: Int): Boolean

Is the specified tile centre row empty?

Is the specified tile centre row empty?

final def flatMap[ArrT <: ArrImut[_]](f: HCen => ArrT)(implicit build: ArrTFlatBuilder[ArrT]): ArrT

flatMaps from all hex tile centre coordinates to an Arr of type ArrT. The elements of this array can not be accessed from this grid class as the TileGrid structure is lost in the flatMap operation.

flatMaps from all hex tile centre coordinates to an Arr of type ArrT. The elements of this array can not be accessed from this grid class as the TileGrid structure is lost in the flatMap operation.

final def foreach(f: HCen => Unit): Unit

foreachs over each HCen hex tile centre, apply the side effecting function.

foreachs over each HCen hex tile centre, apply the side effecting function.

override def foreachCenCoord(f: TCoord => Unit): Unit
Definition Classes
final def hCenExists(hc: HCen): Boolean

Boolean. True if the HCen hex centre exists in this hex grid.

Boolean. True if the HCen hex centre exists in this hex grid.

final def iForeach(f: (HCen, Int) => Unit): Unit

foreachs with index over each HCen hex tile centre, apply the side effecting function.

foreachs with index over each HCen hex tile centre, apply the side effecting function.

final def map[B, ArrB <: ArrImut[B]](f: HCen => B)(implicit build: ArrTBuilder[B, ArrB]): ArrB

Maps over the HCen hex centre tile coordinates. B is used rather than A as a type parameter, as this method maps from HCen => B, corresponding to the standard Scala map function of A => B.

Maps over the HCen hex centre tile coordinates. B is used rather than A as a type parameter, as this method maps from HCen => B, corresponding to the standard Scala map function of A => B.

final def newHCenArrBuff[A <: AnyRef](implicit ct: ClassTag[A]): HCenArrBuff[A]

Creates a new HCenArrBuff An [[HCen] hex tile centre corresponding Arr of empty ArrayBuffers of the given or inferred type.

Creates a new HCenArrBuff An [[HCen] hex tile centre corresponding Arr of empty ArrayBuffers of the given or inferred type.

final def newTileArr[A <: AnyRef](value: A)(implicit ct: ClassTag[A]): HCenArr[A]

New immutable Arr of Tile data.

New immutable Arr of Tile data.

final def newTileArrArr[A <: AnyRef](implicit ct: ClassTag[A]): HCenArrArr[A]

New immutable Arr of Tile data.

New immutable Arr of Tile data.

final def newTileArrOpt[A <: AnyRef](implicit ct: ClassTag[A]): HCenArrOpt[A]

New Tile immutable Tile Arr of Opt data values.

New Tile immutable Tile Arr of Opt data values.

def rBottomRow0: Boolean

The r coordinate of the bottom row of this grid divided by 4 leaves remainder of 0.

The r coordinate of the bottom row of this grid divided by 4 leaves remainder of 0.

def rBottomRow2: Boolean

The r coordinate of the bottom row of this grid divided by 4 leaves remainder of 2.

The r coordinate of the bottom row of this grid divided by 4 leaves remainder of 2.

final def rTopCenRow0: Boolean

Boolean, true if for top hex tile centre row of this hex grid r %% 4 == 0.

Boolean, true if for top hex tile centre row of this hex grid r %% 4 == 0.

final def rTopRow2: Boolean

Boolean, true if for top hex tile centre row of this hex grid r %% 4 == 2.

Boolean, true if for top hex tile centre row of this hex grid r %% 4 == 2.

@inline
final def sideArrIndex(hc: HSide): Int

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

Gives the index into an Arr / Array of Tile data from its tile HCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

override def sideLines: LineSegs
Definition Classes
final override def xCen: Double

The centre of the hex grid along the X axis after the XRatio has been applied to c column value.

The centre of the hex grid along the X axis after the XRatio has been applied to c column value.

Definition Classes
override def xRatio: Double

The conversion factor for c column tile grid coordinates. 1.0 / sqrt(3).

The conversion factor for c column tile grid coordinates. 1.0 / sqrt(3).

Definition Classes

Inherited methods

def cTileMax: Int

Maximum c or column value. This is not called x because in some grids there is not a 1 to 1 ratio from column coordinate to x.

Maximum c or column value. This is not called x because in some grids there is not a 1 to 1 ratio from column coordinate to x.

Inherited from
TGrid
def cTileMin: Int

Minimum c or column value. This is not called x because in some grids there is not a 1 to 1 ratio from column coordinate to x.

Minimum c or column value. This is not called x because in some grids there is not a 1 to 1 ratio from column coordinate to x.

Inherited from
TGrid
def cenVec: Vec2
Inherited from
TGrid
final def flatMapRows[ArrT <: ArrImut[_]](f: Int => ArrT)(implicit build: ArrTFlatBuilder[ArrT]): ArrT

flatMaps over each row number.

flatMaps over each row number.

Inherited from
TGrid
final def foreachRow(f: Int => Unit): Unit

Foreach grid Row y coordinate.

Foreach grid Row y coordinate.

Inherited from
TGrid
def fullDisplayScale(dispWidth: Double, dispHeight: Double, padding: Double): Double
Inherited from
TGrid
def height: Double

Height of the tile grid from furthest tile edge or vertex to furthest tile edge or vertex.

Height of the tile grid from furthest tile edge or vertex to furthest tile edge or vertex.

Inherited from
TGrid
def mapCenCoords[B, BB <: ArrImut[B]](f: TCoord => B)(implicit build: ArrTBuilder[B, BB]): BB
Inherited from
TGrid
final def mapRows[B, BB <: ArrImut[B]](f: Int => B)(implicit build: ArrTBuilder[B, BB]): BB

maps over each row number.

maps over each row number.

Inherited from
TGrid
def numCenRows: Int

Number of rows of tile centres. This will be different to the number of rows of sides and and will be different to the number of rows of vertices for HexGrids.

Number of rows of tile centres. This will be different to the number of rows of sides and and will be different to the number of rows of vertices for HexGrids.

Inherited from
TGrid
def numCens: Int

The total number of tile centres in this tile Grid.

The total number of tile centres in this tile Grid.

Inherited from
TGrid
@inline
final def numOfVertRows: Int

The number of Rows of vertices.

The number of Rows of vertices.

Inherited from
TGrid
def rCenMax: Int

The maximum row coordinate of tile centres.

The maximum row coordinate of tile centres.

Inherited from
TGrid
def rCenMin: Int

The minimum row coordinate of tile centres.

The minimum row coordinate of tile centres.

Inherited from
TGrid

Gives the text graphics for the row and column of each tile centre.

Gives the text graphics for the row and column of each tile centre.

Inherited from
TGrid
def width: Double

Width of the tile Grid from furthest tile edge to furthest tile edge.

Width of the tile Grid from furthest tile edge to furthest tile edge.

Inherited from
TGrid
def yCen: Double
Inherited from
TGrid