Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Class PrimaryCanvasParticleContainer

    A lightweight primary-canvas container designed for particle effects. This container intentionally avoids any internal sorting or depth participation. Children render in insertion order.

    Index

    Properties

    _canvasTransformID: number = -1

    The update ID of canvas transform matrix.

    canvasBounds: Rectangle = ...

    The canvas bounds of this object.

    canvasTransform: Matrix = ...

    The transform matrix from local space to canvas space.

    _canvasBounds: Bounds = ...

    The canvas bounds of this object.

    _canvasBoundsID: number = 0

    The update ID of the canvas bounds. Increment to force recalculation.

    Accessors

    • get elevation(): number

      The elevation of this container.

      Returns number

    • get shouldRenderDepth(): boolean

      Particle containers do not render depth.

      Returns boolean

    • get sort(): number

      A key which resolves ties amongst objects at the same elevation within the same layer.

      Returns number

    Methods

    • Is the given point in canvas space contained in this object?

      Parameters

      • point: IPointData

        The point in canvas space.

      Returns boolean

    • Parameters

      • renderer: any

      Returns void

    • Recalculate the canvas transform and bounds of this object and its children, if necessary.

      Returns void

    • Protected

      Calculate the canvas bounds of this object.

      Returns void

    • Protected

      Called when the canvas bounds changed.

      Returns void

    • Protected

      Called when the canvas transform changed.

      Returns void