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.

    Hierarchy (View Summary)

    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.

    _inPrimary: boolean = false

    Accessors

    • get elevation(): number

      The elevation of this container.

      Returns number

    • get inPrimary(): boolean

      Is this container in the primary group?

      Returns boolean

    • get shouldRenderDepth(): boolean

      To know if this container has at least one children that should render its depth.

      Returns boolean

    • get sort(): number

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

      Returns number

    • get sortLayer(): number

      A key which resolves ties amongst objects at the same elevation of different layers.

      Returns number

    • get zIndex(): number

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

      Returns number

    Methods

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

      Parameters

      • point: IPointData

        The point in canvas space.

      Returns boolean

    • Protected

      Event fired when this container is added to a parent.

      Parameters

      • parent: Container<DisplayObject>

        The new parent container.

      Returns void

    • Protected

      Event fired when this container is removed from its parent.

      Parameters

      • parent: Container<DisplayObject>

        Parent from which the container is removed.

      Returns void