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

HCenRow

ostrat.prid.phex.HCenRow
See theHCenRow companion object
final class HCenRow(val r: Int, val cStart: Int, val cEnd: Int) extends HexStruct, TellInt3, Int3Elem, SpecialT

A hex tile row. Has a row number, a row starting coordinate number and the number of tiles.

Attributes

Companion
object
Graph
Supertypes
trait Int3Elem
trait IntNElem
trait ValueNElem
trait SpecialT
trait TellInt3
trait Tell3[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 Tell
trait Persist
trait HexStruct
trait TCenStruct
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def cLen: Int
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
override 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

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

Definition Classes
override def hSepExists(r: Int, c: Int): Boolean

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

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

Attributes

Definition Classes
def hVertPolygon: PolygonHC

The polygon of this tile, specified in HVert coordinates.

The polygon of this tile, specified in HVert coordinates.

Attributes

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
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
inline override def int1: Int

Attributes

Definition Classes
inline override def int2: Int

Attributes

Definition Classes
inline override def int3: Int

Attributes

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

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

Definition Classes
def setHVertArray: Array[Int]

Creates the backing Array[Int] of HVerts for this HCenRow. This same array can be used inside an HVertArr or a PolygonHC class.

Creates the backing Array[Int] of HVerts for this HCenRow. This same array can be used inside an HVertArr or a PolygonHC class.

Attributes

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 typeStr: String

The type of the object to be persisted.

The type of the object to be persisted.

Attributes

Definition Classes

Inherited methods

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:
Tell3
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 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 hSepExists(hc: HSep): Boolean

Boolean. True if the HSep hex separator exists in this hex grid.

Boolean. True if the HSep hex separator exists in this hex grid.

Attributes

Inherited from:
HexStruct
def hSepExistsIfDo(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 hSepExistsIfDo(hc: HSep)(proc: => Unit): Unit

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

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

Attributes

Inherited from:
HexStruct
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
override def intBufferAppend(buffer: ArrayBuffer[Int]): Unit

Utility method to append this element on to an ArrayBuffer[Int]. End users should rarely need to use this method. This is useful for methods like filter.

Utility method to append this element on to an ArrayBuffer[Int]. End users should rarely need to use this method. This is useful for methods like filter.

Attributes

Definition Classes
Inherited from:
Int3Elem
override def intForeach(f: Int => Unit): Unit

Performs the side effecting function on each Double in this Product element.

Performs the side effecting function on each Double in this Product element.

Attributes

Definition Classes
Inherited from:
Int3Elem
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 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 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
override def numParams: Int

Number of parameter constituents of this class.

Number of parameter constituents of this class.

Attributes

Definition Classes
Inherited from:
Tell3
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
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
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:
Tell3
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
final 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:
TellInt3
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:
Tell3
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
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
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 cEnd: Int
val cStart: Int
val r: Int

Implicits

Inherited implicits

final implicit override def show1: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt3
final implicit override def show2: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt3
final implicit override def show3: Show[Int]

Attributes

Definition Classes
Inherited from:
TellInt3
Generated with