Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface DimensionAnimationEvents

    Animation events emitted by DimensionAnimationManager

    interface DimensionAnimationEvents {
        play: { dimIndex: number };
        pause: { dimIndex: number };
        complete: { dimIndex: number };
        speedChange: { dimIndex: number; fps: number };
        loopModeChange: { dimIndex: number; loopMode: LoopMode };
        stepChange: { dimIndex: number; stepSize: number | null };
        ladderDepthChange: {
            dimIndex: number;
            ladderDepth: number | "auto" | null;
        };
        directionChange: { dimIndex: number; direction: AnimationDirection };
        fpsWarning: {
            dimIndex: number;
            targetFPS: number;
            actualFPS: number;
            committedEnergyFraction: number | null;
        };
    }
    Index
    play pause complete speedChange loopModeChange stepChange ladderDepthChange directionChange fpsWarning
    play: { dimIndex: number }

    Emitted when animation starts

    pause: { dimIndex: number }

    Emitted when animation pauses

    complete: { dimIndex: number }

    Emitted when animation completes (loop mode: once)

    speedChange: { dimIndex: number; fps: number }

    Emitted when target FPS changes

    loopModeChange: { dimIndex: number; loopMode: LoopMode }

    Emitted when loop mode changes

    stepChange: { dimIndex: number; stepSize: number | null }

    Emitted when the per-dimension step override changes (null = Auto)

    ladderDepthChange: { dimIndex: number; ladderDepth: number | "auto" | null }

    Emitted when the playback detail changes: rungs, 'auto', or null (Fast)

    directionChange: { dimIndex: number; direction: AnimationDirection }

    Emitted when direction changes (bounce mode)

    fpsWarning: {
        dimIndex: number;
        targetFPS: number;
        actualFPS: number;
        committedEnergyFraction: number | null;
    }

    Playback missed the requested cadence or a visible node is still below the committed-energy display threshold. committedEnergyFraction is the worst-served non-empty laddered node's committed energy, or null when nothing on screen carries energy stamps (#2374).

    Settings
    Member Visibility

    On This Page
    Properties