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

    Class PrimaryCanvasContainer

    Primary canvas container are reserved for advanced usage. They allow to group PrimarySpriteMesh in a single Container. The container elevation is replacing individual sprite elevation.

    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.

    Accessors

    • get elevation(): number

      The elevation of this container.

      Returns number

    • 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

    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

    • Returns void

    • 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