Class BrickGrid

Hierarchy

HexagonalGrid
- BrickGrid

Implements

IGrid<HexagonalTile>

Index

Constructors

constructor

Properties

Constructors

constructor

new BrickGrid(scale: Float, orientation?: boolean, shape?: Shape, x?: Integer, y?: Integer): BrickGrid

Overrides HexagonalGrid.constructor
- Defined in BrickGrid.ts:13
Parameters
- scale: Float
- Default value orientation: boolean = false
- Default value shape: Shape = Shape.Hexagonal
- Default value x: Integer = 1
- Optional y: Integer
Returns BrickGrid

Properties

angle

angle: Float = 0

orientation

orientation: boolean

radius

radius: Float

scale

scale: Float

scaleY

scaleY: Float = -1

shape

shape: Shape

tileTypes

tileTypes: TileType = TileType.Simple

tiles

tiles: HexagonalTile[]

toPoint

toPoint: function

Type declaration

- (tile: HexagonalTile): Position
- Parameters
  - tile: HexagonalTile
  Returns Position

toTile

toTile: function

Type declaration

- (position: Position): HexagonalTile
- Parameters
  - position: Position
  Returns HexagonalTile

x

y

Static shapes

shapes: Shape[] = [Shape.Hexagonal,Shape.Rhombus, Shape.Even, Shape.Odd, Shape.Triangular]

Methods

bounds

bounds(): Rectangle

Implementation of IGrid.bounds

Inherited from HexagonalGrid.bounds
- Defined in HexagonalGrid.ts:242
Returns Rectangle

center

center(cube: HexagonalTile): Float2

Overrides HexagonalGrid.center
- Defined in BrickGrid.ts:33
Parameters
- cube: HexagonalTile
Returns Float2

position

position(p: Float2): HexagonalTile

Implementation of IGrid.position

Inherited from HexagonalGrid.position
- Defined in HexagonalGrid.ts:274
Parameters
- p: Float2
Returns HexagonalTile

tile

tile(x: number, y: number): HexagonalTile | undefined

Implementation of IGrid.tile

Inherited from HexagonalGrid.tile
- Defined in HexagonalGrid.ts:293
Parameters
- x: number
- y: number
Returns HexagonalTile | undefined

vertices

vertices(orientation?: undefined | true | false, scale?: Float): Float2[]

Overrides HexagonalGrid.vertices
- Defined in BrickGrid.ts:20
Parameters
- Optional orientation: undefined | true | false
- Optional scale: Float
Returns Float2[]

Static CUBE_TO_EVEN_Q

CUBE_TO_EVEN_Q(tile: HexagonalTile): Position

Inherited from HexagonalGrid.CUBE_TO_EVEN_Q
- Defined in HexagonalGrid.ts:136
Parameters
- tile: HexagonalTile
Returns Position

Static CUBE_TO_EVEN_R

CUBE_TO_EVEN_R(tile: HexagonalTile): Position

Inherited from HexagonalGrid.CUBE_TO_EVEN_R
- Defined in HexagonalGrid.ts:172
Parameters
- tile: HexagonalTile
Returns Position

Static CUBE_TO_ODD_Q

CUBE_TO_ODD_Q(tile: HexagonalTile): Position

Inherited from HexagonalGrid.CUBE_TO_ODD_Q
- Defined in HexagonalGrid.ts:118
Parameters
- tile: HexagonalTile
Returns Position

Static CUBE_TO_ODD_R

CUBE_TO_ODD_R(tile: HexagonalTile): Position

Inherited from HexagonalGrid.CUBE_TO_ODD_R
- Defined in HexagonalGrid.ts:154
Parameters
- tile: HexagonalTile
Returns Position

Static CUBE_TO_TWO_AXIS

CUBE_TO_TWO_AXIS(tile: HexagonalTile): Position

Inherited from HexagonalGrid.CUBE_TO_TWO_AXIS
- Defined in HexagonalGrid.ts:89
Parameters
- tile: HexagonalTile
Returns Position

Static CUBE_TO_TWO_AXIS_XY

CUBE_TO_TWO_AXIS_XY(tile: HexagonalTile): Position

Inherited from HexagonalGrid.CUBE_TO_TWO_AXIS_XY
- Defined in HexagonalGrid.ts:97
Parameters
- tile: HexagonalTile
Returns Position

Static CUBE_TO_TWO_AXIS_YZ

CUBE_TO_TWO_AXIS_YZ(tile: HexagonalTile): Position

Inherited from HexagonalGrid.CUBE_TO_TWO_AXIS_YZ
- Defined in HexagonalGrid.ts:105
Parameters
- tile: HexagonalTile
Returns Position

Static EVEN_Q_TO_CUBE

EVEN_Q_TO_CUBE(position: Position): HexagonalTile

Inherited from HexagonalGrid.EVEN_Q_TO_CUBE
- Defined in HexagonalGrid.ts:127
Parameters
- position: Position
Returns HexagonalTile

Static EVEN_R_TO_CUBE

EVEN_R_TO_CUBE(position: Position): HexagonalTile

Inherited from HexagonalGrid.EVEN_R_TO_CUBE
- Defined in HexagonalGrid.ts:163
Parameters
- position: Position
Returns HexagonalTile

Static HEXAGONAL_SHAPE

HEXAGONAL_SHAPE(size: Integer): HexagonalTile[]

Inherited from HexagonalGrid.HEXAGONAL_SHAPE
- Defined in HexagonalGrid.ts:207
Parameters
- size: Integer
Returns HexagonalTile[]

Static ODD_Q_TO_CUBE

ODD_Q_TO_CUBE(position: Position): HexagonalTile

Inherited from HexagonalGrid.ODD_Q_TO_CUBE
- Defined in HexagonalGrid.ts:109
Parameters
- position: Position
Returns HexagonalTile

Static ODD_R_TO_CUBE

ODD_R_TO_CUBE(position: Position): HexagonalTile

Inherited from HexagonalGrid.ODD_R_TO_CUBE
- Defined in HexagonalGrid.ts:145
Parameters
- position: Position
Returns HexagonalTile

Static REGION

REGION(xmin: Integer, xmax: Integer, ymin: Integer, ymax: Integer, zmin: Integer, zmax: Integer): HexagonalTile[]

Inherited from HexagonalGrid.REGION
- Defined in HexagonalGrid.ts:223
Parameters
- xmin: Integer
- xmax: Integer
- ymin: Integer
- ymax: Integer
- zmin: Integer
- zmax: Integer
Returns HexagonalTile[]

Static TRAPEZOIDAL_SHAPE

TRAPEZOIDAL_SHAPE(minQ: Integer, maxQ: Integer, minR: Integer, maxR: Integer, toCube: function): HexagonalTile[]

Inherited from HexagonalGrid.TRAPEZOIDAL_SHAPE
- Defined in HexagonalGrid.ts:181
Parameters
- minQ: Integer
- maxQ: Integer
- minR: Integer
- maxR: Integer
- toCube: function
  - - (position: Position): HexagonalTile
    - Parameters
      - position: Position
      Returns HexagonalTile
Returns HexagonalTile[]

Static TRIANGULAR_SHAPE

TRIANGULAR_SHAPE(size: Integer): HexagonalTile[]

Inherited from HexagonalGrid.TRIANGULAR_SHAPE
- Defined in HexagonalGrid.ts:195
Parameters
- size: Integer
Returns HexagonalTile[]

Static TWO_AXIS_TO_CUBE

TWO_AXIS_TO_CUBE(position: Position): HexagonalTile

Inherited from HexagonalGrid.TWO_AXIS_TO_CUBE
- Defined in HexagonalGrid.ts:85
Parameters
- position: Position
Returns HexagonalTile

Static TWO_AXIS_TO_CUBE_XY

TWO_AXIS_TO_CUBE_XY(position: Position): HexagonalTile

Inherited from HexagonalGrid.TWO_AXIS_TO_CUBE_XY
- Defined in HexagonalGrid.ts:93
Parameters
- position: Position
Returns HexagonalTile

Static TWO_AXIS_TO_CUBE_YZ

TWO_AXIS_TO_CUBE_YZ(position: Position): HexagonalTile

Inherited from HexagonalGrid.TWO_AXIS_TO_CUBE_YZ
- Defined in HexagonalGrid.ts:101
Parameters
- position: Position
Returns HexagonalTile