SqGrid

ostrat.prid.psq.SqGrid
See theSqGrid companion object
class SqGrid(val bottomCenR: Int, val topCenR: Int, val leftCenC: Int, val rightCenC: Int) extends SqGridSys with TGrid

A grid of Squares. A regular rectangle of squares.

Attributes

Companion:
object
Graph
Supertypes
trait TGrid
trait SqGridSys
trait TGridSys
class Object
trait Matchable
class Any
Known subtypes
object ChessBoard.type

Members list

Concise view

Side Members

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

final def bottomSideR: 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 numOfSideRows: Int

The number of Rows of Sides.

The number of Rows of Sides.

Attributes

Inherited from:
TGrid
override def sideLines: LineSegArr

The line segments LineSegs for the sides of the tiles.

The line segments LineSegs for the sides of the tiles.

Attributes

Definition Classes

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

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

Attributes

Inherited from:
TGrid
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
final def topSideRow: 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

Value members

Concrete methods

final def arrIndex(sc: SqCen): Int

Gives the index into an Arr / Array of Tile data from its tile SqCen. 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 SqCen. Use sideIndex and vertIndex methods to access Side and Vertex Arr / Array data.

Attributes

def arrIndex(r: Int, c: Int): Int
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
override def coordCen: SqCoord

The TCenOrSide coordinate centre of this tile grid.

The TCenOrSide coordinate centre of this tile grid.

Attributes

Definition Classes
override def defaultView(pxScale: Double): SqGridView

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

Fills all the tiles with the same given parameter Colour. Not sure how useful this method is.

Fills all the tiles with the same given parameter Colour. Not sure how useful this method is.

Attributes

override def findStepEnd(startSC: SqCen, step: SqDirn): Option[SqCen]

Finds step from StartSqCen to target fromSqCen.

Finds step from StartSqCen to target fromSqCen.

Attributes

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

Definition Classes
def foreach(f: SqCen => Unit): Unit
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 TSide tile side, with the lowest C column coordinate. This places it on the left most points of the grid.

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

Attributes

Definition Classes
override def numTileRows: Int

Number of rows of tiles.

Number of rows of tiles.

Attributes

Definition Classes
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 TSide tile side, with the highest C column coordinate. This places it on the right most points of the grid.

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

Attributes

Definition Classes
def rowForeach(r: Int)(f: SqCen => Unit): Unit
def rowIForeach(r: Int, startCount: Int)(f: (SqCen, Int) => Unit): Int
override def sidesForeach(f: SqSide => Unit): Unit

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

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

Attributes

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

The number of tiles in each tile row.

The number of tiles in each tile row.

Attributes

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

Definition Classes

Inherited methods

The active tiles without any PaintElems.

The active tiles without any PaintElems.

Attributes

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

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

Attributes

Inherited from:
SqGridSys
final def flatMapRows[ArrT <: Arr[_]](f: Int => ArrT)(implicit build: ArrFlatBuilder[ArrT]): ArrT

flatMaps over each row number.

flatMaps over each row number.

Attributes

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

Foreach grid Row y coordinate.

Foreach grid Row y coordinate.

Attributes

Inherited from:
TGrid
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: ArrMapBuilder[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 HCen => 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 HCen => B, corresponding to the standard Scala map function of A => B.

Attributes

Inherited from:
SqGridSys
final def mapRows[B, BB <: Arr[B]](f: Int => B)(implicit build: ArrMapBuilder[B, BB]): BB

maps over each row number.

maps over each row number.

Attributes

Inherited from:
TGridSys
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
final def numOfVertRows: Int

The number of Rows of vertices.

The number of Rows of vertices.

Attributes

Inherited from:
TGrid

Attributes

Inherited from:
SqGridSys
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 def sqCenExists(sc: SqCen): 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:
SqGridSys
final def topSideR: Int

The top or highest centre row, r coordinate.

The top or highest centre row, r coordinate.

Attributes

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

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

Concrete fields

The bottom or lowest tile centre row, r coordinate.

The bottom or lowest tile centre row, r coordinate.

Attributes

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

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

The top of highest tile centre row, r coordinate.

The top of highest tile centre row, r coordinate.

Attributes

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