OpenStrat
API
Generated with
OpenStrat/ostrat/ostrat.prid/ostrat.prid.phex/HGridRect

HGridRect

ostrat.prid.phex.HGridRect
See theHGridRect companion object
class HGridRect(val bottomCenR: Int, val topCenR: Int, val gridLeftCenC: Int, val gridRightCenC: Int) extends HGrid, TellInt4

A Rectangular hex grid where the tile rows have the same length, except the tile rows where r %% 4 == 2 may differ in length by 1 from tile rows where r %% 4 == 0 rows.

Attributes

Companion
object
Graph
Supertypes
trait TellInt4
trait Tell4[Int, Int, Int, Int]
trait Persist4[Int, Int, Int, Int]
trait Tell4Plused[Int, Int, Int, Int]
trait Persist4Plus[Int, Int, Int, Int]
trait Tell3Plused[Int, Int, Int]
trait Persist3Plus[Int, Int, Int]
trait Tell2Plused[Int, Int]
trait Persist2Plus[Int, Int]
trait Persist1Plus[Int]
trait PersistN
trait TellN
trait HGrid
trait Tell
trait Persist
trait HGridSys
trait HexStruct
trait TGrid
trait TGridSys
trait TCenStruct
class Object
trait Matchable
class Any
Show all

Members list

Grouped members

SidesGroup

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
def innerSepRowsForeach(f: Int => Unit): Unit

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
Inherited from:
HGrid
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
def vertRowsForeach(f: Int => Unit): Unit

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
Inherited from:
HGrid

Value members

Concrete methods

override def adjTilesOfTile(origR: Int, origC: Int): HCenArr

Combine adjacent tiles of the same value.

Combine adjacent tiles of the same value.

Attributes

Definition Classes
def bottomRem0R: Int

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.Div4Rem0, r %% 4 == 0.

Attributes

def bottomRem2R: Int

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

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

Attributes

def bottomSideRowLen: Int

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

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

Attributes

def canEqual(a: Any): Boolean
override def coordCen: HCoord

The HCenOrSep coordinate centre for this hex grid.

The HCenOrSep coordinate centre for this hex grid.

Attributes

Definition Classes
override 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

Definition Classes
override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
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

override def innerRowForeachInnerSide(r: Int)(f: HSep => Unit): Unit

Attributes

Definition Classes
def layerArrayIndex(r: Int, c: Int): Int

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.

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.

Attributes

def leftRem0CenC: Int

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

Attributes

def leftrem2CenC: Int

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

Attributes

override def name1: String

1st parameter name.

1st parameter name.

Attributes

Definition Classes
override def name2: String

2nd parameter name.

2nd parameter name.

Attributes

Definition Classes
override def name3: String

3rd parameter name.

3rd parameter name.

Attributes

Definition Classes
override def name4: String

4th parameter name.

4th parameter name.

Attributes

Definition Classes
override def numRow0s: Int

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

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

Attributes

Definition Classes
override def numRow2s: Int

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

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

Attributes

Definition Classes
override def numTileRows: 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.

Attributes

Definition Classes
def rightRem0CenC: Int

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.Div4Rem0. This property is only available on regular hex grids HGrids, as this value is not fixed on irregular hex grids.

Attributes

def rightRem2CenC: Int

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

Attributes

def row0sTileNum: Int

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

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

Attributes

def row2sTileNum: Int

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

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

Attributes

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

foreachs over each hex tile's HCen in the given Row. The row is specified by its r value.

foreachs over each hex tile's HCen in the given Row. The row is specified by its r value.

Attributes

Definition Classes
override 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

Definition Classes
override 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

Definition Classes
override def rowNumTiles(row: Int): Int

The number of tile centres in the given row.

The number of tile centres in the given row.

Attributes

Definition Classes
override 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

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

Attributes

Definition Classes
def sepTileLtAndVertUnsafe(hSide: HSep): (HCen, Int)

Needs reimplementing.

Needs reimplementing.

Attributes

override def sepTileLtOpt(hSide: HSep): Option[HCen]

Attributes

Definition Classes
override def tell1: Int

Element 1 of this Tell2+ element product.

Element 1 of this Tell2+ element product.

Attributes

Definition Classes
override def tell2: Int

Element 2 of this Tell2+ element product.

Element 2 of this Tell2+ element product.

Attributes

Definition Classes
override def tell3: Int

Element 3 of this Show 3+ element product.

Element 3 of this Show 3+ element product.

Attributes

Definition Classes
override def tell4: Int

Element 4 of this Tell4+ element product.

Element 4 of this Tell4+ element product.

Attributes

Definition Classes
def topRem0R: Int

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 centres rows where r.Div4Rem0, r %% 4 == 0.

Attributes

def topRem2R: Int

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

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

Attributes

def topSideRowlen: Int

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

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

Attributes

override def typeStr: String

The type of the object to be persisted.

The type of the object to be persisted.

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 allRowsForeach(f: HCenRow => Unit): Unit

Attributes

Inherited from:
HGrid
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
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
Inherited from:
HGrid
def bottomRowForeachSide(f: HSep => Unit): Unit

Attributes

Inherited from:
HGrid
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 cenRowEmpty(row: Int): Boolean

Is the specified tile centre row empty?

Is the specified tile centre row empty?

Attributes

Inherited from:
HGrid
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
override def defaultView(pxScale: Double): HGView

Attributes

Definition Classes
Inherited from:
HGrid
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
override def elemTypeNames: StrArr

A StrArr Arr of the element type names of this Show Product class.

A StrArr Arr of the element type names of this Show Product class.

Attributes

Definition Classes
Inherited from:
TellInt4
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
override def findSepTiles(hs: HSep): Option[(HCen, HCen)]

Not correct yet.

Not correct yet.

Attributes

Definition Classes
Inherited from:
HGrid
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
Inherited from:
HGrid
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
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
Inherited from:
HGrid
def fullDisplayScale(dispWidth: Double, dispHeight: Double, padding: Double): Double

Attributes

Inherited from:
TGridSys
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

Inherited from:
HGrid
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
override def hCenSteps(hCen: HCen): HStepArr

Attributes

Definition Classes
Inherited from:
HGrid
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

Inherited from:
HGrid
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 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
Inherited from:
HGrid
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
Inherited from:
HGrid
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
def innerSepLineSegHCs: LineSegHCArr

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
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 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
Inherited from:
HGrid
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
Inherited from:
HGrid
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 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

Inherited from:
HGrid
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
def newSideBooleans: HSideBoolLayer

Attributes

Inherited from:
HGrid
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
override def numParams: Int

Number of parameter constituents of this class.

Number of parameter constituents of this class.

Attributes

Definition Classes
Inherited from:
Persist4
override def opt1: Option[Int]

The optional default value for parameter 1.

The optional default value for parameter 1.

Attributes

Definition Classes
Inherited from:
Tell2Plused
override def opt2: Option[Int]

The optional default value for parameter 2.

The optional default value for parameter 2.

Attributes

Definition Classes
Inherited from:
Tell2Plused
override def opt3: Option[Int]

The optional default value for parameter 3.

The optional default value for parameter 3.

Attributes

Definition Classes
Inherited from:
Tell3Plused
override def opt4: Option[Int]

The optional default value for parameter 4.

The optional default value for parameter 4.

Attributes

Definition Classes
Inherited from:
Tell4Plused
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
def outerPolygon: PolygonHC

Attributes

Inherited from:
HGrid
def outerSepLineSegHCs: LineSegHCArr

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
final override def paramNames: StrArr

Sequence of the names of parameter constituents of this class.

Sequence of the names of parameter constituents of this class.

Attributes

Definition Classes
Inherited from:
Persist4
def projection: Panel => HSysProjection

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
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
Inherited from:
HGrid
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
Inherited from:
HGrid
def rowCombine[A <: AnyRef](r: Int, layer: LayerHcRefSys[A], indexingGSys: HGridSys)(implicit ct2: ClassTag[A]): RPairArr[HCenRow, A]

Implementation incomplete.

Implementation incomplete.

Attributes

Inherited from:
HGrid
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

Inherited from:
HGrid
def rowLeftCoordC(row: Int, c: Int): Int

Attributes

Inherited from:
HGrid
def rowLeftSepC(r: Int): Int

Attributes

Inherited from:
HGrid
def rowLen(r: Int): Int

Attributes

Inherited from:
HGrid
def rowMap[B, ArrB <: Arr[B]](r: Int)(f: HCen => B)(implicit build: BuilderArrMap[B, ArrB]): ArrB

Attributes

Inherited from:
HGrid
def rowNumSeps(r: Int): Int

Attributes

Inherited from:
HGrid
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

Inherited from:
HGrid
def rowRightSepC(r: Int): Int

Attributes

Inherited from:
HGrid
def rowVertHighLeftC(r: Int): Int

Attributes

Inherited from:
HGrid
def rowVertHighRightC(r: Int): Int

Attributes

Inherited from:
HGrid
def rowVertLowLeftC(r: Int): Int

Attributes

Inherited from:
HGrid
def rowVertLowRightC(r: Int): Int

Attributes

Inherited from:
HGrid
def rows: HCenRowArr

Attributes

Inherited from:
HGrid
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
Inherited from:
HGrid
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
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
def sepLineSegHCs: LineSegHCArr

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
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
Inherited from:
HGrid
override def sepTileRtOpt(hSide: HSep): Option[HCen]

Attributes

Definition Classes
Inherited from:
HGrid
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
Inherited from:
HGrid
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
override def show1: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt4
override def show2: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt4
override def show3: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt4
override def show4: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt4
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
Inherited from:
HGrid
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
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
Inherited from:
HGrid
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
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
Inherited from:
HGrid
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
override 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

Definition Classes
TellN -> Tell
Inherited from:
TellN
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
override 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

Definition Classes
TellN -> Tell
Inherited from:
TellN
override def tellDepth: Int

The syntactic depth of the tell String for this object.

The syntactic depth of the tell String for this object.

Attributes

Definition Classes
Inherited from:
TellInt4
override def tellElemStrs(way: ShowStyle, decimalPlaces: Int, minPlaces: Int): StrArr

A StrArr Arr collection of the show methods return values of the elements of this Show Product class.

A StrArr Arr collection of the show methods return values of the elements of this Show Product class.

Attributes

Definition Classes
Inherited from:
Tell4
def tellSemisNames(maxPlaces: Int, minPlaces: Int): String

Attributes

Inherited from:
TellN
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
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
Inherited from:
HGrid
def topRowForeachSide(f: HSep => Unit): Unit

Attributes

Inherited from:
HGrid
final def topSepR: Int

The top or highest separator row, r coordinate.

The top or highest separator row, r coordinate.

Attributes

Inherited from:
TGrid
def useMultiple: Boolean

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
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
Inherited from:
HGrid
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 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 from:
HGrid
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

val bottomCenR: Int

The bottom or lowest tile centre row, r coordinate.

The bottom or lowest tile centre row, r coordinate.

Attributes

val gridLeftCenC: Int

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

val gridRightCenC: Int

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

val topCenR: Int

The top or highest tile centre row, r coordinate.

The top or highest tile centre row, r coordinate.

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
val sepIndexArr: Array[Int]

Attributes

Inherited from:
HGrid
lazy val sepRowIndexArray: Array[Int]

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 from:
HGrid
Generated with