HGrid

ostrat.prid.phex.HGrid
See theHGrid companion object
trait HGrid extends TGrid, HGridSys, Tell

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

Attributes

Companion
object
Graph
Supertypes
trait Tell
trait Persist
trait HGridSys
trait HexStruct
trait TGrid
trait TGridSys
trait TCenStruct
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Grouped members

Side Members

Trait members that operate on the sides of the Hex Grid.

final def bottomSepR: Int

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

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

Attributes

Inherited from:
TGrid

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

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

Attributes

Inherited from:
TGrid
final def numOfSepRows: Int

The number of Rows of Sides.

The number of Rows of Sides.

Attributes

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

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

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

Attributes

Inherited from:
TGrid
final override def sepsForeach(f: HSep => Unit): Unit

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

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

Attributes

Definition Classes
final def topSepRow: Int

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

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

Attributes

Inherited from:
TGrid

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

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

Attributes

Inherited from:
TGrid
final override def vertsForeach(f: HVert => Unit): Unit

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

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

Attributes

Definition Classes

Value members

Abstract methods

override def coordCen: HCoord

The TCenOrSep coordinate centre of this tile grid.

The TCenOrSep coordinate centre of this tile grid.

Attributes

Definition Classes
def edgesForeach(f: HSep => Unit): Unit

foreach hex edge / outer side's coordinate HSide, calls the effectual function.

foreach hex edge / outer side's coordinate HSide, calls the effectual function.

Attributes

def numRow0s: Int

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

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

Attributes

def numRow2s: Int

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

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

Attributes

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.

Attributes

def rowForeachSep(r: Int)(f: HSep => Unit): Unit

Calls the Foreach procedure on every hex separator HSep in the row given by the input parameter.

Calls the Foreach procedure on every hex separator HSep in the row given by the input parameter.

Attributes

def rowLeftCenC(row: Int): Int

The start (or by default left column) of the tile centre of the given row.

The start (or by default left column) of the tile centre of the given row.

Attributes

def rowNumTiles(row: Int): Int

The number of tile centres in the given row.

The number of tile centres in the given row.

Attributes

def rowRightCenC(row: Int): Int

The end (or by default right) column number of the tile centre of the given row.

The end (or by default right) column number of the tile centre of the given row.

Attributes

Concrete methods

final override def bottom: Double

The bottom most point in the grid where the value of y is minimum.

The bottom most point in the grid where the value of y is minimum.

Attributes

Definition Classes
final def cenRowEmpty(row: Int): Boolean

Is the specified tile centre row empty?

Is the specified tile centre row empty?

Attributes

override def defaultView(pxScale: Double): HGView

Attributes

Definition Classes
override def findSepTiles(hs: HSep): Option[(HCen, HCen)]

Not correct yet.

Not correct yet.

Attributes

Definition Classes
override def flatHCoordToPt2(hCoord: HCoord): Pt2

Gives a flat projection of HCoords to Pt2s. For a simple singular HGrid system this is all that is required to translate between grid coordinates and standard 2 dimensional space. For multi grids it provides a simple way to display all the tiles in the grid system, but a more complex projection may be required for fully meaningful display representation. For Example world grid systems and multi layer square tile games will require their own specialist projections.

Gives a flat projection of HCoords to Pt2s. For a simple singular HGrid system this is all that is required to translate between grid coordinates and standard 2 dimensional space. For multi grids it provides a simple way to display all the tiles in the grid system, but a more complex projection may be required for fully meaningful display representation. For Example world grid systems and multi layer square tile games will require their own specialist projections.

Attributes

Definition Classes
final override def foreach(f: HCen => Unit): Unit

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

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

Attributes

Definition Classes
def getHCost(startCen: HCen, endCen: HCen): Int

H cost for A* path finding. To move 1 tile has a cost 2. This is because the G cost or actual cost is the sum of the terrain cost of tile of departure and the tile of arrival.

H cost for A* path finding. To move 1 tile has a cost 2. This is because the G cost or actual cost is the sum of the terrain cost of tile of departure and the tile of arrival.

Attributes

override def hCenSteps(hCen: HCen): HStepArr

Attributes

Definition Classes
def hCoordExists(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.

Attributes

final override def iForeach(f: (Int, HCen) => 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.

Attributes

Definition Classes
final override def iForeach(init: Int)(f: (Int, HCen) => 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.

Attributes

Definition Classes
final override def left: Double

The left most point in the grid where x is minimum.

The left most point in the grid where x is minimum.

Attributes

Definition Classes
final override def leftSideC: Int

The TSep tile side, with the lowest C column coordinate. This places it on the left most points of the grid.

The TSep tile side, with the lowest C column coordinate. This places it on the left most points of the grid.

Attributes

Definition Classes
final def linksForeach(f: HSep => Unit): Unit

foreach hex link / inner side's coordinate HSide, calls the effectual function.

foreach hex link / inner side's coordinate HSide, calls the effectual function.

Attributes

final override def right: Double

The right most point in the grid where the value of x is maximum.

The right most point in the grid where the value of x is maximum.

Attributes

Definition Classes
final override def rightSideC: Int

The TSep tile side, with the highest C column coordinate. This places it on the right most points of the grid.

The TSep tile side, with the highest C column coordinate. This places it on the right most points of the grid.

Attributes

Definition Classes
def rowCombine[A <: AnyRef](r: Int, layer: LayerHcRefSys[A], indexingGSys: HGridSys)(implicit ct2: ClassTag[A]): RPairArr[HCenRow, A]

Implementation incomplete.

Implementation incomplete.

Attributes

def rowForeachVert(r: Int)(f: HVert => Unit): Unit

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

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

Attributes

def rowLeftCoordC(row: Int, c: Int): Int
def rowLeftSepC(r: Int): Int
def rowLen(r: Int): Int
def rowMap[B, ArrB <: Arr[B]](r: Int)(f: HCen => B)(implicit build: BuilderArrMap[B, ArrB]): ArrB
def rowNumSeps(r: Int): Int
def rowRightCoordC(row: Int, c: Int): Int

The end (or by default right) column number of the hex coordinate row. So note that for the purposes of this method 2, 2 is not considered to be in the same row as 2, 1 and 2, 3, although they have the same c number. Similarly Cen 2, 2 is not considered to be in the same row as sides 2, 0 and 2, 6.

The end (or by default right) column number of the hex coordinate row. So note that for the purposes of this method 2, 2 is not considered to be in the same row as 2, 1 and 2, 3, although they have the same c number. Similarly Cen 2, 2 is not considered to be in the same row as sides 2, 0 and 2, 6.

Attributes

def rowRightSepC(r: Int): Int
override def rowsCombine[A <: AnyRef](layer: LayerHcRefSys[A], indexingGSys: HGridSys): RArr[HCenRowPair[A]]

For each row combine data layer into RArr[HCenRowPair]. May be superceded

For each row combine data layer into RArr[HCenRowPair]. May be superceded

Attributes

Definition Classes
override def sepTileLtUnsafe(hSide: HSep): HCen

This method should only be used when you know the hex separator exists.

This method should only be used when you know the hex separator exists.

Attributes

Definition Classes
override def sepTileRtOpt(hSide: HSep): Option[HCen]

Attributes

Definition Classes
override def sepTileRtUnsafe(hSide: HSep): HCen

This method should only be used when you know the hex separator exists.

This method should only be used when you know the hex separator exists.

Attributes

Definition Classes
override def stepEndFind(startHC: HCen, step: HStep): Option[HCen]

Finds step from Start HCen to target from HCen.

Finds step from Start HCen to target from HCen.

Attributes

Definition Classes
override def stepEndGet(startCen: HCen, step: HStep): HCen

Unsafe. Gets the destination HCen from the HStep. Throws exception if no end point,

Unsafe. Gets the destination HCen from the HStep. Throws exception if no end point,

Attributes

Definition Classes
override def stepFind(startCen: HCen, endCen: HCen): Option[HStep]

Finds step from Start HCen to target from HCen.

Finds step from Start HCen to target from HCen.

Attributes

Definition Classes
final override def top: Double

The top most point in the grid where the value of y is maximum.

The top most point in the grid where the value of y is maximum.

Attributes

Definition Classes
override def vertToCoordFind(hVert: HVert, dirn: HVDirn): Option[HCoord]

Finds the HCoord if it exists, by taking the HVDirn from an HVert.

Finds the HCoord if it exists, by taking the HVDirn from an HVert.

Attributes

Definition Classes
final override def yCen: Double

The centre of the hex grid along the Y axis after the yRatio has been applied to the r row value.

The centre of the hex grid along the Y axis after the yRatio has been applied to the r row value.

Attributes

Definition Classes

Inherited methods

final def adjTilesOfTile(origin: HCen): HCenArr

Returns a clockwise sequence of adjacent tiles.

Returns a clockwise sequence of adjacent tiles.

Attributes

Inherited from:
HGridSys
def adjTilesOfTile(origR: Int, origC: Int): HCenArr

Returns a clockwise sequence of adjacent tiles.

Returns a clockwise sequence of adjacent tiles.

Attributes

Inherited from:
HGridSys
final def allRsFlatMap[ArrT <: Arr[_]](f: Int => ArrT)(implicit build: BuilderArrFlat[ArrT]): ArrT

flatMaps over each r row coordinate number.

flatMaps over each r row coordinate number.

Attributes

Inherited from:
TGridSys
final def allRsMap[B, BB <: Arr[B]](f: Int => B)(implicit build: BuilderArrMap[B, BB]): BB

maps over each r row coordinate number.

maps over each r row coordinate number.

Attributes

Inherited from:
TGridSys
final def allRsforeach(f: Int => Unit): Unit

Foreach grid Row r coordinate.

Foreach grid Row r coordinate.

Attributes

Inherited from:
TGrid

The bottom or lowest tile centre row, r coordinate.

The bottom or lowest tile centre row, r coordinate.

Attributes

Inherited from:
TGrid
def cCen: Int

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

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

Attributes

Inherited from:
TGrid
final def cenStepEndFind(cenStep: HCenStep): Option[HCen]

Attributes

Inherited from:
HGridSys
def cenVec: Vec2

The centre point as a Vec2. Not sure why this id implemented here.

The centre point as a Vec2. Not sure why this id implemented here.

Attributes

Inherited from:
TGridSys
def cornerLayerArrayIndex(hc: HCen, vertIndex: Int): Int

Gives the index into the unsafe backing Array of a HCornerLayer.

Gives the index into the unsafe backing Array of a HCornerLayer.

Attributes

Inherited from:
HGridSys
final def edgesMap[B, ArrT <: Arr[B]](f: HSep => B)(implicit build: BuilderArrMap[B, ArrT]): ArrT

maps over each the grid systems outer side's coordinate HSep.

maps over each the grid systems outer side's coordinate HSep.

Attributes

Inherited from:
HGridSys
def findPath(startCen: HCen, endCen: HCen)(fTerrCost: (HCen, HCen) => OptInt): Option[HCenArr]

Attributes

Inherited from:
HGridSys
def findPathList(startCen: HCen, endCen: HCen)(fTerrCost: (HCen, HCen) => OptInt): Option[List[HCen]]

Finds path from Start hex tile centre to end tile centre given the cost function parameter.

Finds path from Start hex tile centre to end tile centre given the cost function parameter.

Attributes

Inherited from:
HGridSys
final def flatMap[ArrT <: Arr[_]](f: HCen => ArrT)(implicit build: BuilderArrFlat[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.

Attributes

Inherited from:
HexStruct
final def foldRows[B](init: B)(f: (B, Int) => B): B

foldLefts over each row number.

foldLefts over each row number.

Attributes

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

Attributes

Inherited from:
TGridSys

The minimum or lowest tile centre column c coordinate in the whole tile grid. This is called c rather than x because in hex grids HGrids there is not a 1 to 1 ratio from column coordinate to the x value in a Pt2.

The minimum or lowest tile centre column c coordinate in the whole tile grid. This is called c rather than x because in hex grids HGrids there is not a 1 to 1 ratio from column coordinate to the x value in a Pt2.

Attributes

Inherited from:
TGrid

the Maximum or highest tile centre column c coordinate in the whole tile grid. This is called c rather than x because in hex grids HGrids there is not a 1 to 1 ratio from column coordinate to the x value in a Pt2.

the Maximum or highest tile centre column c coordinate in the whole tile grid. This is called c rather than x because in hex grids HGrids there is not a 1 to 1 ratio from column coordinate to the x value in a Pt2.

Attributes

Inherited from:
TGrid
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.

Attributes

Inherited from:
HexStruct
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.

Attributes

Inherited from:
HexStruct
def hCenExistsIfDo(r: Int, c: Int)(proc: => Unit): Unit

If the given HCen exists within this HGridSys, perform the side effecting function.

If the given HCen exists within this HGridSys, perform the side effecting function.

Attributes

Inherited from:
HexStruct
def hCenExistsIfDo(hc: HCen)(proc: => Unit): Unit

If the given HCen exists within this HGridSys, perform the side effecting function.

If the given HCen exists within this HGridSys, perform the side effecting function.

Attributes

Inherited from:
HexStruct
final def hCoordExists(hc: HCoord): 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.

Attributes

Inherited from:
HexStruct
final def height: Double

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

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

Attributes

Inherited from:
TGridSys
final def ifFlatMap[ArrT <: Arr[_]](f1: HCen => Boolean)(f2: HCen => ArrT)(implicit build: BuilderArrFlat[ArrT]): ArrT

flatMaps from all hex tile centre coordinates to an Arr of type ArrT. The normal flatMap functions is only applied if the condtion of the first function is true.

flatMaps from all hex tile centre coordinates to an Arr of type ArrT. The normal flatMap functions is only applied if the condtion of the first function is true.

Attributes

Inherited from:
HexStruct
final def ifMap[B, ArrB <: Arr[B]](f1: HCen => Boolean)(f2: HCen => B)(implicit build: BuilderArrMap[B, ArrB]): ArrB

Maps each Hcen to an element of type B, only if the predicate function on the HCen is true. Collects the true cases. In some cases this will be easier and more efficient than employing the optMap method.

Maps each Hcen to an element of type B, only if the predicate function on the HCen is true. Collects the true cases. In some cases this will be easier and more efficient than employing the optMap method.

Attributes

Inherited from:
HexStruct

The line segments of the inner separators defined in HCoord vertices.

The line segments of the inner separators defined in HCoord vertices.

Attributes

Inherited from:
HGridSys
def layerArrayIndex(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 SeqDef 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 SeqDef data.

Attributes

Inherited from:
HGridSys
final def layerArrayIndex(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.

Attributes

Inherited from:
HexStruct
final def linksFlatMap[ArrT <: Arr[_]](f: HSep => ArrT)(implicit build: BuilderArrFlat[ArrT]): ArrT

flatMaps over each inner hex Separator's coordinate HSep..

flatMaps over each inner hex Separator's coordinate HSep..

Attributes

Inherited from:
HGridSys
final def linksMap[B, ArrT <: Arr[B]](f: HSep => B)(implicit build: BuilderArrMap[B, ArrT]): ArrT

maps over each the grid systems link / inner side's coordinate HSep.

maps over each the grid systems link / inner side's coordinate HSep.

Attributes

Inherited from:
HGridSys
final def linksOptMap[B, ArrB <: Arr[B]](f: HSep => Option[B])(implicit build: BuilderArrMap[B, ArrB]): ArrB

OptMaps over each inner hex Side's coordinate HSep.

OptMaps over each inner hex Side's coordinate HSep.

Attributes

Inherited from:
HGridSys
final def map[B, ArrB <: Arr[B]](f: HCen => B)(implicit build: BuilderArrMap[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.

Attributes

Inherited from:
HexStruct
def mapPair[B2](f2: HCen => B2)(implicit build: HCenPairArrMapBuilder[B2]): HCenPairArr[B2]

Maps each HCen of this hex grid system to an HCenPair. The first part of the pair is just the HCen, the second part of the pair is produced by the parameter function.

Maps each HCen of this hex grid system to an HCenPair. The first part of the pair is just the HCen, the second part of the pair is produced by the parameter function.

Attributes

Inherited from:
HexStruct
final def newHCenArrOfBuff[A <: AnyRef](implicit ct: ClassTag[A]): HCenBuffLayer[A]

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

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

Attributes

Inherited from:
HGridSys
final def numCorners: Int

The number of HCorners in this HGridSys, 6 for each HCen.

The number of HCorners in this HGridSys, 6 for each HCen.

Attributes

Inherited from:
HexStruct
final def numOfVertRows: Int

The number of Rows of vertices.

The number of Rows of vertices.

Attributes

Inherited from:
TGrid

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.

Attributes

Inherited from:
TGrid
final def optMap[B, ArrB <: Arr[B]](f: HCen => Option[B])(implicit build: BuilderArrMap[B, ArrB]): ArrB

Maps 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.

Maps 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.

Attributes

Inherited from:
HexStruct
def optMapPair[B2](f2: HCen => Option[B2])(implicit build: HCenPairArrMapBuilder[B2]): HCenPairArr[B2]

OptMaps each HCen of this hex grid system to an HCenPair.

OptMaps each HCen of this hex grid system to an HCenPair.

Attributes

Inherited from:
HexStruct

The line segments of the outer separators defined in HCoord vertices.

The line segments of the outer separators defined in HCoord vertices.

Attributes

Inherited from:
HGridSys

Returns the most appropriate HSysProjection for this HGridSys.

Returns the most appropriate HSysProjection for this HGridSys.

Attributes

Inherited from:
HGridSys
def rCen: Int

The centre of the hex grid in terms of r row coordinates.

The centre of the hex grid in terms of r row coordinates.

Attributes

Inherited from:
TGrid
def sepExists(hs: HSep): Boolean

Does the HSep hex tile separator exist within thisHGridSys.

Does the HSep hex tile separator exist within thisHGridSys.

Attributes

Inherited from:
HGridSys
def sepExists(r: Int, c: Int): Boolean

Does the HSep hex tile separator exist within thisHGridSys.

Does the HSep hex tile separator exist within thisHGridSys.

Attributes

Inherited from:
HGridSys
def sepLayerArrayIndex(r: Int, c: Int): Int

Gives the index into an Arr / Array of side data from its tile HSep. Use arrIndex and vertIndex methods to access Side and Vertex Arr / Array data.

Gives the index into an Arr / Array of side data from its tile HSep. Use arrIndex and vertIndex methods to access Side and Vertex Arr / Array data.

Attributes

Inherited from:
HGridSys
final def sepLayerArrayIndex(hc: HSep): Int

Gives the index into an Arr / Array of Tile data from its tile HSep. Use arrIndex and vertIndex methods to access tile centre and Vertex Arr / Array data.

Gives the index into an Arr / Array of Tile data from its tile HSep. Use arrIndex and vertIndex methods to access tile centre and Vertex Arr / Array data.

Attributes

Inherited from:
HGridSys

The line segments of the sides defined in HCoord vertices.

The line segments of the sides defined in HCoord vertices.

Attributes

Inherited from:
HGridSys
def sepOptMapPair[B2](f2: HSep => Option[B2])(implicit build: HSepBuilderArrPairMap[B2]): HSepArrPair[B2]

OptMaps each HSep of this hex grid system to an HSepPair.

OptMaps each HSep of this hex grid system to an HSepPair.

Attributes

Inherited from:
HGridSys

Attributes

Inherited from:
HGridSys
def sepTileLtOpt(hSide: HSep): Option[HCen]

Attributes

Inherited from:
HGridSys
final def seps: HSepArr

The HSep hex separator coordinates.

The HSep hex separator coordinates.

Attributes

Inherited from:
HGridSys
final def sepsFlatMap[ArrT <: Arr[_]](f: HSep => ArrT)(implicit build: BuilderArrFlat[ArrT]): ArrT

flatMaps over each Hex Separator's coordinate HSep.

flatMaps over each Hex Separator's coordinate HSep.

Attributes

Inherited from:
HGridSys
final def sepsMap[B, ArrT <: Arr[B]](f: HSep => B)(implicit build: BuilderArrMap[B, ArrT]): ArrT

maps over each Hex Separator's coordinate HSep in the hex grid system.

maps over each Hex Separator's coordinate HSep in the hex grid system.

Attributes

Inherited from:
HGridSys
final def sepsOptMap[B, ArrB <: Arr[B]](f: HSep => Option[B])(implicit build: BuilderArrMap[B, ArrB]): ArrB

Optionally maps over each Hex Separator's coordinate HSep.

Optionally maps over each Hex Separator's coordinate HSep.

Attributes

Inherited from:
HGridSys
def stepEndFind(r: Int, c: Int, step: HStep): Option[HCen]

Optionally returns the destination of an HStep if the destination exists in the HGridSys.

Optionally returns the destination of an HStep if the destination exists in the HGridSys.

Attributes

Inherited from:
HGridSys
def stepEndOrStart(startHC: HCen, step: HStep): HCen

Finds step from Start HCen to target from HCen if end hex exists, else returns start hex.

Finds step from Start HCen to target from HCen if end hex exists, else returns start hex.

Attributes

Inherited from:
HGridSys
def stepExists(startCen: HCen, endCen: HCen): Boolean

Attributes

Inherited from:
HGridSys
final def stepFind(startR: Int, startC: Int, endR: Int, endC: Int): Option[HStep]

Finds step from Start HCen to target from HCen.

Finds step from Start HCen to target from HCen.

Attributes

Inherited from:
HGridSys
def stepLikeEndFind(startHC: HCen, stepLike: HStepLike): Option[HCen]

Finds the end from an HStepLike.

Finds the end from an HStepLike.

Attributes

Inherited from:
HGridSys
def stepsEndFind(startCen: HCen, steps: HStepArr): Option[HCen]

Attributes

Inherited from:
HGridSys
def str: String

The most basic Show method, paralleling the strT method on ShowT type class instances.

The most basic Show method, paralleling the strT method on ShowT type class instances.

Attributes

Inherited from:
Tell
def str0: String

Show with decimal precision of 0 places.

Show with decimal precision of 0 places.

Attributes

Inherited from:
Tell
def str1: String

Show with decimal precision of 1 place padding with a zero if necessary.

Show with decimal precision of 1 place padding with a zero if necessary.

Attributes

Inherited from:
Tell
def str2: String

Show with decimal precision of 2 places padding with zeros if necessary.

Show with decimal precision of 2 places padding with zeros if necessary.

Attributes

Inherited from:
Tell
def str3: String

Show with decimal precision of 3 places padding with zeros if necessary.

Show with decimal precision of 3 places padding with zeros if necessary.

Attributes

Inherited from:
Tell
def tell(style: ShowStyle, maxPlaces: Int, minPlaces: Int): String

Intended to be a multiple parameter comprehensive Show method. Intended to be paralleled by show method on Show type class instances.

Intended to be a multiple parameter comprehensive Show method. Intended to be paralleled by show method on Show type class instances.

Attributes

Inherited from:
Tell
def tellDepth: Int

The syntactic depth of the tell String for this object.

The syntactic depth of the tell String for this object.

Attributes

Inherited from:
Tell
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Tell -> Any
Inherited from:
Tell
def topCenR: Int

The top or highest tile centre row, r coordinate.

The top or highest tile centre row, r coordinate.

Attributes

Inherited from:
TGrid
final def topSepR: Int

The top or highest separator row, r coordinate.

The top or highest separator row, r coordinate.

Attributes

Inherited from:
TGrid

The type of the object to be persisted.

The type of the object to be persisted.

Attributes

Inherited from:
Persist

This property determines if the type can be used with Multiple syntax.

This property determines if the type can be used with Multiple syntax.

MyObj * 7

. for describing sequences succinctly. This is not desirable for some types such as numerical and mathematical vector types as this could be confusing 3 * 4 should resolve to an Int of value 12, not a Multiple(3, 4).

Attributes

Inherited from:
Persist
def vertArrIndex(r: Int, c: Int): Int

Gives the index into an Arr / Array of side data from its tile HVert. Use arrIndex and vertIndex methods to access tile centre and side Arr / Array data.

Gives the index into an Arr / Array of side data from its tile HVert. Use arrIndex and vertIndex methods to access tile centre and side Arr / Array data.

Attributes

Inherited from:
HGridSys
final def vertArrIndex(hc: HSep): Int

Gives the index into an Arr / Array of Tile data from its tile HVert. Use arrIndex and sideArrIndex methods to access tile centre and side Arr / Array data.

Gives the index into an Arr / Array of Tile data from its tile HVert. Use arrIndex and sideArrIndex methods to access tile centre and side Arr / Array data.

Attributes

Inherited from:
HGridSys
final def vertsFlatMap[ArrT <: Arr[_]](f: HVert => ArrT)(implicit build: BuilderArrFlat[ArrT]): ArrT

flatMaps over each Hex vertex's coordinate HVert.

flatMaps over each Hex vertex's coordinate HVert.

Attributes

Inherited from:
HGridSys
final def vertsMap[B, ArrT <: Arr[B]](f: HVert => B)(implicit build: BuilderArrMap[B, ArrT]): ArrT

maps over each Hex Separator's coordinate HSep in the hex grid system.

maps over each Hex Separator's coordinate HSep in the hex grid system.

Attributes

Inherited from:
HGridSys
final def width: Double

Width of the tile grid system from furthest tile edge or vertex to furthest tile edge or vertex.

Width of the tile grid system from furthest tile edge or vertex to furthest tile edge or vertex.

Attributes

Inherited from:
TGridSys
override def xCen: Double

The centre of this grid in the X axis. this will be equal to the cCen Int value.

The centre of this grid in the X axis. this will be equal to the cCen Int value.

Attributes

Definition Classes
Inherited from:
TGrid
final override def yRatio: 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).

Attributes

Definition Classes
Inherited from:
HexStruct

Concrete fields

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

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

Attributes

Inherited fields

final lazy val numInnerSides: Int

The number of inner sides in the hex grid system.

The number of inner sides in the hex grid system.

Attributes

Inherited from:
HGridSys
final lazy val numOuterSides: Int

The number of outer sides in the hex grid system.

The number of outer sides in the hex grid system.

Attributes

Inherited from:
HGridSys
final lazy val numSides: Int

The number of sides in the hex grid system.

The number of sides in the hex grid system.

Attributes

Inherited from:
HGridSys
final lazy override val numTiles: Int

The total number of tile centres in this tile Grid system.

The total number of tile centres in this tile Grid system.

Attributes

Inherited from:
HGridSys