three-nebula API
    Preparing search index...

    Class Rate

    Calculates the rate of particle emission.

    NOTE This doesn't need to be an initializer, it doesn't have an initialize method, it overrides the base init method and it is only relevent to the Emitter class. It would be better to move this to the Emitter module itself as a standalone class.

    Hierarchy

    • default
      • Rate
    Index
    constructor
    isEnabled nextTime numPan startTime timePan type
    getValue init initialize reset resetInterval fromJSON requiresWebGlApi

    • Constructs a Rate instance.

      Parameters

      • numPan: number | number[] | Span<number> = DEFAULT_RATE_NUM_PAN

        The number of particles to emit

      • timePan: number | number[] | Span<number> = DEFAULT_RATE_TIME_PAN

        The time between each particle emission

      Returns Rate

    isEnabled: boolean
    nextTime: number
    numPan: Span<number>
    startTime: number
    timePan: Span<number>
    type: string

    • Gets the number of particles to emit.

      Parameters

      • time: number

        Current particle engine time

      • Optionalrng: RNG

      Returns number

    • Sets the startTime and nextTime properties.

      Returns void

    • Resets the emission interval, drawing the next interval from timePan. Separate from the base Initializer.init (which has a different signature) so the emitter's seeded rng can be threaded in without an override clash.

      Parameters

      • Optionalrng: RNG

      Returns void

    • Creates a Rate initializer from JSON.

      Parameters

      • json: RateJSON

        The JSON to construct the instance from.

      Returns Rate

    • Determines if the initializer requires a WebGL API to be provided to its constructor.

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods