HGridReg

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

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

The number of Rows of Sides.

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

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

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

Combine adjacent tiles of the same value.

The bottom, lowest or minimum row r value for tile centre rows where r.Div4Rem0, r %% 4 == 0.

The bottom, lowest or minimum row r value for tile centre rows where r.Div4Rem2, r %% 4 == 2.

The number of tile sides in the bottom side row of the hex grid.

The HCenOrSide coordinate centre for this hex grid.

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

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

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

The starting, minimum or by convention left column coordinate c value for tile centre rows where r.Div4Rem0. This property is only available on regular hex grids HGrids, as this value is not fixed on irregular hex grids.

The start minimum or by convention left column or c value for tile centre rows where r.Div4Rem2. This property is only available on regular hex grids HGrids, as this value is not fixed on irregular hex grids.

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

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

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.

The end maximum or by convention right column coordinate, or c value for tile centre rows where r.Div4Rem0. This property is only available on regular hex grids HGrids, as this value is not fixed on irregular hex grids.

The end, maximum or by convention right column coordinate or c value for tile centre rows where r.Div4Rem2. This property is only available on regular hex grids HGrids, as this value is not fixed on irregular hex grids.

The number of tiles or tile centres in rows where r.Div4Rem0.

The number of tiles or tile centres in rows where r.Div4Rem2.

foreachs over each Tile's Roord in the given Row. The row is specified by its r value.

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

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

The number of tile centres in the given row.

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

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.

The top, highest or maximum row r value for tile centres rows where r.Div4Rem0, r %% 4 == 0.

The top, highest or maximum row r value for tile centre rows where r.Div4Rem2, r %% 4 == 2.

The number of tile sides in the top side row of the hex grid.

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

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

Is the specified tile centre row empty?

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

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

Spawns a new HCornerLayer data layer for this HGridSys from the master HGridSys's data layer.

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

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

Not correct yet.

Finds step from Start HCen to target from HCen.

Finds step from Start HCen to target from HCen.

Finds step from Start HCen to target from HCen.

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.

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 over each row number.

foldLefts over each row number.

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

Foreach grid Row y coordinate.

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.

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

Spawns a new HCenLayer data layer for this HGridSys from the master HGridSys's HCenLayer data layer.

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

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.

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

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.

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

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

flatMaps over each inner hex Side's coordinate HSide..

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

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

OptMaps over each inner hex Side's coordinate HSide.

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 each row number.

New hex tile data layer of RArr[A].

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

New hex tile data layer.

New hex tile data layer of optional data for this HGridSys.

The number of Rows of vertices.

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.

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

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

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

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

Implementation incomplete.

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

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

Spawns a new HSideBoolLayer data layer for this HGridSys from the master HGridSys's data layer.

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

The line segments of the sides defined in HCoord vertices.

Spawns a new HSideOptlLayer data layer for this HGridSys from the master HGridSys's data layer.

The HSide hex side coordinates.

flatMaps over each Hex Side's coordinate HSide.

maps over each Hex Side's coordinate HSide in the hex grid system.

Optionally maps over each Hex Side's coordinate HSide.

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

The top or highest centre row, r coordinate.

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 Tile data from its tile HVert. Use arrIndex and sideArrIndex methods to access tile centre and side Arr / Array data.

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

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

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

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

The bottom or lowest tile centre row, r coordinate.

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 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 top of highest tile centre row, r coordinate.

The number of inner sides in the hex grid system.

The number of outer sides in the hex grid system.

The number of sides in the hex grid system.

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

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