Track the set of HTMLVideoElements which are currently playing as part of this group.
The primary background image configured for the Scene, rendered as a SpriteMesh.
The primary foreground image configured for the Scene, rendered as a SpriteMesh.
A Quadtree which partitions and organizes primary canvas objects.
The collection of PrimaryDrawingContainer objects which are rendered in the Scene.
The collection of SpriteMesh objects which are rendered in the Scene.
The collection of SpriteMesh objects which are rendered in the Scene.
Track the current elevation range which is present in the Scene.
Allow API users to override the default elevation of the background layer. This is a temporary solution until more formal support for scene levels is added in a future release.
Return the base HTML image or video element which provides the background texture.
Return the base HTML image or video element which provides the foreground texture.
Refresh the primary mesh.
Draw the canvas group and all its component layers.
Remove and destroy all children from the group. Clear container references to rendered objects.
Remove a TokenMesh from the group.
The Token being removed
Draw the SpriteMesh for a specific Token object.
The Tile being added
The added TileMesh or TileSprite
Remove a TokenMesh from the group.
The Tile being removed
Add a DrawingShape to the group.
The Drawing being added
The created DrawingShape instance
Remove a DrawingShape from the group.
The Drawing being removed
Map an elevation value to a depth value with the right precision.
A current elevation (or zIndex) in distance units.
The depth value for this elevation on the range [1/255, 1]
Override the default PIXI.Container behavior for how objects in this container are sorted.
Render all tokens in their own render texture.
The renderer to use.
Draw the Scene background image.
Draw the Scene foreground image.
Draw a SpriteMesh texture that fills the entire Scene rectangle.
The target SpriteMesh
The loaded Texture or null
The sorting function used to order objects inside the Primary Canvas Group. Overrides the default sorting function defined for the PIXI.Container. Sort TokenMesh above other objects except WeatherEffects, then DrawingShape, all else held equal.
An object to display
Some other object to display
The primary Canvas group which generally contains tangible physical objects which exist within the Scene. This group is a CachedContainer which is rendered to the Scene as a SpriteMesh. This allows the rendered result of the Primary Canvas Group to be affected by a BaseSamplerShader.