Class GridMesh

The grid mesh, which uses the foundry.canvas.rendering.shaders.GridShader to render the grid.

Hierarchy (View Summary)

QuadMesh
- GridMesh

Index

Constructors

Properties

Accessors

blendMode shader

Methods

_calculateBounds _render containsPoint destroy initialize setShaderClass _initialize

Constructors

constructor

new GridMesh(shaderClass?: typeof GridShader): GridMesh
The grid mesh constructor.
Parameters
- OptionalshaderClass: typeof GridShader = GridShader
  The shader class
Returns GridMesh
Overrides QuadMesh.constructor

Properties

data

data: GridMeshData = ...

The data of this mesh.

Accessors

blendMode

get blendMode(): BLEND_MODES
Assigned blend mode to this mesh.

Returns BLEND_MODES
Inherited from QuadMesh.blendMode

shader

get shader(): AbstractBaseShader
The shader bound to this mesh.

Returns AbstractBaseShader
Inherited from QuadMesh.shader

Methods

_calculateBounds

_calculateBounds(): void
Returns void
Inherited from QuadMesh._calculateBounds

_render

_render(renderer: any): void
Parameters
- renderer: any
Returns void
Inherited from QuadMesh._render

containsPoint

containsPoint(point: IPointData): boolean
Tests if a point is inside this QuadMesh.
Parameters
- point: IPointData
Returns boolean
Inherited from QuadMesh.containsPoint

destroy

destroy(options: any): void
Parameters
- options: any
Returns void
Inherited from QuadMesh.destroy

initialize

initialize(data: Partial<GridMeshData>): GridMesh
Initialize and update the mesh given the (partial) data.
Parameters
- data: Partial<GridMeshData>
  The (partial) data.
Returns GridMesh

setShaderClass

setShaderClass(shaderClass: typeof AbstractBaseShader): void
Initialize shader based on the shader class type.
Parameters
- shaderClass: typeof AbstractBaseShader
  Shader class used. Must inherit from AbstractBaseShader.
Returns void
Inherited from QuadMesh.setShaderClass

`Protected`_initialize

_initialize(data: Partial<GridMeshData>): void
Protected
Initialize the data of this mesh given the (partial) data.
Parameters
- data: Partial<GridMeshData>
  The (partial) data.
Returns void