JsAgg
API
Generated with
JsAgg/ostrat/ostrat.prid/ostrat.prid.psq/SqGridMulti

SqGridMulti

ostrat.prid.psq.SqGridMulti
trait SqGridMulti extends SqGridSys, TGridMulti

A system of SqGrids.

Attributes

Graph
Supertypes
trait TGridMulti
trait SqGridSys
trait TGridSys
trait TCenStruct
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Type members

Types

final type GridT = SqGrid

The type of the tile grids within this tile grid system.

The type of the tile grids within this tile grid system.

Attributes

Value members

Concrete methods

override def defaultView(pxScale: Double): SGView

Gives the default view in terms of SqCoord focus and scaling of this square grid system.

Gives the default view in terms of SqCoord focus and scaling of this square grid system.

Attributes

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

Attributes

Definition Classes
override def stepEndFind(startSC: SqCen, step: SqStep): Option[SqCen]

Finds step from StartSqCen to target fromSqCen.

Finds step from StartSqCen to target fromSqCen.

Attributes

Definition Classes

Inherited methods

def activeTiles: RArr[PolygonActive]

The active tiles without any PaintElems.

The active tiles without any PaintElems.

Attributes

Inherited from:
SqGridSys
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
override def allRsforeach(f: Int => Unit): Unit

For each row of tiles performs side effecting function on the r coordinate of the row.

For each row of tiles performs side effecting function on the r coordinate of the row.

Attributes

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

Attributes

Inherited from:
TGridSys
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 map[B, ArrB <: Arr[B]](f: SqCen => B)(implicit build: BuilderArrMap[B, ArrB]): ArrB

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

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

Attributes

Inherited from:
SqGridSys
final def newSCenOptDGrider[A <: AnyRef](implicit ct: ClassTag[A]): SqCenOptLayer[A]

New Square tile data grid for this Square grid system.

New Square tile data grid for this Square grid system.

Attributes

Inherited from:
SqGridSys
final def newSqCenBuffLayer[A <: AnyRef](implicit ct: ClassTag[A]): SqCenBuffLayer[A]

Creates a new SqCenBuffLayer. A [[SqCen] square tile centre corresponding Arr of empty ArrayBuffers of the given or inferred type.

Creates a new SqCenBuffLayer. A [[SqCen] square tile centre corresponding Arr of empty ArrayBuffers of the given or inferred type.

Attributes

Inherited from:
SqGridSys
final def newSqCenDGrid[A <: AnyRef](value: A)(implicit ct: ClassTag[A]): SqCenLayer[A]

New Square tile centre data Square grid.

New Square tile centre data Square grid.

Attributes

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

Inherited from:
TGridMulti
def projection: Panel => SqSysProjection

Attributes

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

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

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

Attributes

Inherited from:
SqGridSys
def sidesForeach(f: SqSep => Unit): Unit

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

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

Attributes

Inherited from:
SqGridSys
final def sqCenExists(sc: SqCen): Boolean

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

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

Attributes

Inherited from:
SqGridSys
def stepEndFind(cenStep: SqCenStep): Option[SqCen]

Attributes

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

Finds step from Start SqCen to target from SqCen.

Finds step from Start SqCen to target from SqCen.

Attributes

Inherited from:
SqGridSys
def stepLikeEndFind(startHC: SqCen, stepLike: SqStepLike): Option[SqCen]

Finds the end from an SqStepLike.

Finds the end from an SqStepLike.

Attributes

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

Inherited from:
TGridSys
def yCen: Double

The centre of this grid in the y axis. For SqGrids this will be equal to the cCen Int value, but this is not the case for HGrids.

The centre of this grid in the y axis. For SqGrids this will be equal to the cCen Int value, but this is not the case for HGrids.

Attributes

Inherited from:
TGridSys
final override def yRatio: Double

C coordinates match 1 to 1 to x coordinates for square grids.

C coordinates match 1 to 1 to x coordinates for square grids.

Attributes

Definition Classes
Inherited from:
SqGridSys

Inherited and Abstract methods

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

Inherited from:
TGridSys
def flatSqCoordToPt2(sqCoord: SqCoord): Pt2

Gives a flat projection of SqCoords to Pt2s. For a simple singular SqGrid 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 SqCoords to Pt2s. For a simple singular SqGrid 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

Inherited from:
SqGridSys
def grids: RArr[GridT]

The grids of this tile grid system.

The grids of this tile grid system.

Attributes

Inherited from:
TGridMulti
def layerArrayIndex(r: Int, c: Int): Int

Gives the index into the backing Array for the given SqCen.

Gives the index into the backing Array for the given SqCen.

Attributes

Inherited from:
SqGridSys
def layerArrayIndex(sc: SqCen): Int

Gives the index into the backing Array for the given SqCen.

Gives the index into the backing Array for the given SqCen.

Attributes

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

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

Inherited from:
TGridSys
def sideLines: LineSegArr

Attributes

Inherited from:
SqGridSys
def sqCenExists(r: Int, c: Int): Boolean

Attributes

Inherited from:
SqGridSys
def stepFind(startHC: SqCen, endHC: SqCen): Option[SqStep]

Finds step from Start SqCen to target from SqCen.

Finds step from Start SqCen to target from SqCen.

Attributes

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

Inherited from:
TGridSys

Inherited fields

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:
SqGridSys
Generated with