A configurable particle effect meant to be used in the PrimaryCanvasGroup. You must provide a full configuration object.

Hierarchy

  • CanvasTransform<this>
    • PrimaryParticleEffect

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

    Always false for a Primary Particle Effect.

    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

    • ...args: any[]

    Returns void

  • Initialize the emitter with optional configuration.

    Parameters

    • Optionalconfig: object

      Optional config object.

    • Optionalplay: boolean = false

      Should we play immediately? False by default.

    Returns void

  • Begin animation for the configured emitter.

    Returns void

  • Stop animation for the configured emitter.

    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