Class GridLayer

A CanvasLayer responsible for drawing a square grid

Hierarchy (View Summary)

CanvasLayer
- GridLayer

Properties

highlight

highlight: Container<DisplayObject>

The Grid Highlight container

highlightLayers

highlightLayers: Record<string, GridHighlight> = {}

Map named highlight layers

interactiveChildren

interactiveChildren: boolean = false

Whether this event target has any children that need UI events. This can be used optimize event propagation.

mesh

mesh: GridMesh

The grid mesh.

options

options: { name: string } = ...

Options for this layer instance.

Accessors

hookName

get hookName(): string
The name used by hooks to construct their hook string. Note: You should override this getter if hookName should not return the class constructor name.

Returns string
Inherited from CanvasLayer.hookName

name

get name(): string
The canonical name of the CanvasLayer is the name of the constructor that is the immediate child of the defined baseClass for the layer type.

Returns string
Example
```
canvas.lighting.name -> "LightingLayer"
```
Inherited from CanvasLayer.name

`Static`instance

get instance(): any
Returns any
Overrides CanvasLayer.instance

`Static`layerOptions

get layerOptions(): object
Customize behaviors of this CanvasLayer by modifying some behaviors at a class level.

Returns object
Overrides CanvasLayer.layerOptions

Methods

_draw

_draw(options: any): Promise<void>
Parameters
- options: any
Returns Promise<void>
Overrides CanvasLayer._draw

addHighlightLayer

addHighlightLayer(name: string): GridHighlight
Define a new Highlight graphic
Parameters
- name: string
  The name for the referenced highlight layer
Returns GridHighlight

clearHighlightLayer

clearHighlightLayer(name: string): void
Clear a specific Highlight graphic
Parameters
- name: string
  The name for the referenced highlight layer
Returns void

destroyHighlightLayer

destroyHighlightLayer(name: string): void
Destroy a specific Highlight graphic
Parameters
- name: string
  The name for the referenced highlight layer
Returns void

draw

draw(options?: object): Promise<CanvasLayer>
Draw the canvas layer, rendering its internal components and returning a Promise. The Promise resolves to the drawn layer once its contents are successfully rendered.
Parameters
- Optionaloptions: object = {}
  Options which configure how the layer is drawn
Returns Promise<CanvasLayer>
Inherited from CanvasLayer.draw

getHighlightLayer

getHighlightLayer(name: string): void | GridHighlight
Obtain the highlight layer graphic by name
Parameters
- name: string
  The name for the referenced highlight layer
Returns void | GridHighlight

getZIndex

getZIndex(): number
Get the zIndex that should be used for ordering this layer vertically relative to others in the same Container.

Returns number
Inherited from CanvasLayer.getZIndex

highlightPosition

highlightPosition(
    name: string,
    options: {
        alpha?: number;
        border?: ColorSource | null;
        color?: ColorSource;
        shape?: Polygon;
        x?: number;
        y?: number;
    },
): void
Add highlighting for a specific grid position to a named highlight graphic
Parameters
- name: string
  The name for the referenced highlight layer
- options: {
      alpha?: number;
      border?: ColorSource | null;
      color?: ColorSource;
      shape?: Polygon;
      x?: number;
      y?: number;
  }
  If gridless you need to pass shape but not x and y. - If not gridless you need to pass x and y, but not shape.
  - Optionalalpha?: number
    The opacity of the highlight
  - Optionalborder?: ColorSource | null
    The border color of the highlight
  - Optionalcolor?: ColorSource
    The fill color of the highlight
  - Optionalshape?: Polygon
    A predefined shape to highlight
  - Optionalx?: number
    The x-coordinate of the highlighted position
  - Optionaly?: number
    The y-coordinate of the highlighted position
Returns void

initializeMesh

initializeMesh(
    options?: {
        alpha?: number;
        color?: string;
        style?: string;
        thickness?: number;
    },
): void
Initialize the grid mesh appearance and configure the grid shader.
Parameters
- options: { alpha?: number; color?: string; style?: string; thickness?: number } = {}
  - Optionalalpha?: number
    The grid alpha
  - Optionalcolor?: string
    The grid color
  - Optionalstyle?: string
    The grid style
  - Optionalthickness?: number
    The grid thickness
Returns void

tearDown

tearDown(options?: object): Promise<CanvasLayer>
Deconstruct data used in the current layer in preparation to re-draw the canvas
Parameters
- Optionaloptions: object = {}
  Options which configure how the layer is deconstructed
Returns Promise<CanvasLayer>
Inherited from CanvasLayer.tearDown

`Protected`_drawMesh

_drawMesh(): Promise<GridMesh>
Protected
Creates the grid mesh.

Returns Promise<GridMesh>

`Protected`_tearDown

_tearDown(options: object): Promise<void>
Protected
The inner _tearDown method which may be customized by each CanvasLayer subclass.
Parameters
- options: object
  Options which configure how the layer is deconstructed
Returns Promise<void>
Inherited from CanvasLayer._tearDown

Class GridLayer

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

highlight

highlightLayers

interactiveChildren

mesh

options

Accessors

hookName

Returns string

name

Returns string

Example

Staticinstance

Returns any

StaticlayerOptions

Returns object

Methods

_draw

Parameters

Returns Promise<void>

addHighlightLayer

Parameters

Returns GridHighlight

clearHighlightLayer

Parameters

Returns void

destroyHighlightLayer

Parameters

Returns void

draw

Parameters

Returns Promise<CanvasLayer>

getHighlightLayer

Parameters

Returns void | GridHighlight

getZIndex

Returns number

highlightPosition

Parameters

Optionalalpha?: number

Optionalborder?: ColorSource | null

Optionalcolor?: ColorSource

Optionalshape?: Polygon

Optionalx?: number

Optionaly?: number

Returns void

initializeMesh

Parameters

Optionalalpha?: number

Optionalcolor?: string

Optionalstyle?: string

Optionalthickness?: number

Returns void

tearDown

Parameters

Returns Promise<CanvasLayer>

Protected_drawMesh

Returns Promise<GridMesh>

Protected_tearDown

Parameters

Returns Promise<void>

Settings

On This Page

`Static`instance

`Static`layerOptions

`Optional`alpha?: number

`Optional`border?: ColorSource | null

`Optional`color?: ColorSource

`Optional`shape?: Polygon

`Optional`x?: number

`Optional`y?: number

`Optional`alpha?: number

`Optional`color?: string

`Optional`style?: string

`Optional`thickness?: number

`Protected`_drawMesh

`Protected`_tearDown