Taos API Reference
    Preparing search index...

    Interface ParticleFeatureOptions

    interface ParticleFeatureOptions {
        config: ParticleGraphConfig;
        emitterTransform?: () => Mat4;
        worldTransform?: () => Mat4;
        name?: string;
    }
    Index

    Properties

    config emitterTransform? worldTransform? name?

    Properties

    config: ParticleGraphConfig

    Initial particle graph config. Use ParticleFeature.setConfig to swap configs at runtime (the feature destroys the previous pass and builds a fresh one).

    emitterTransform?: () => Mat4

    Per-frame callback supplying the emitter world transform. Most demos pin the emitter to a fixed position; non-trivial uses (e.g. a particle attached to a moving object) read live state here.

    worldTransform?: () => Mat4

    Per-frame world transform applied to EVERY rendered particle (forward HDR sprite/arrow/trail paths). A rigid + uniform-scale Mat4 — used to drop a local sim onto the geospatial globe (the ENU tangent-plane transform at a lat/lon) and track floating-origin reanchors without re-simulating.

    name?: string

    Stable name for engine lookup. Defaults to the class name; pass an override when registering multiple ParticleFeatures (e.g. block-break + explosion particles in the same scene).

    Settings

    Member Visibility

    On This Page

    Properties