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

    Interface AdvanceArgs

    Inputs for one playback advance step.

    interface AdvanceArgs {
        current: number;
        min: number;
        max: number;
        step: number | null;
        gridStep?: number | null;
        direction: AnimationDirection;
        loopMode: LoopMode;
        targetFPS: number;
        continuousTraverseMs: number;
    }
    Index
    current min max step gridStep? direction loopMode targetFPS continuousTraverseMs
    current: number

    Current dimension value (the playhead).

    min: number

    Dimension range minimum.

    max: number

    Dimension range maximum.

    step: number | null

    Step size for discrete dimensions; null = continuous.

    gridStep?: number | null

    The dimension's own discrete grid step (its authored step), or null/undefined for a continuous dimension. When max is off that grid, the last grid point below it is the effective end of the range: the dims manager snaps every write onto the grid, so clamping onto max would land back on the current value and freeze playback there.

    direction: AnimationDirection

    Current playback direction.

    loopMode: LoopMode

    Boundary behavior: once | loop | bounce.

    targetFPS: number

    Target playback FPS (sizes the continuous increment).

    continuousTraverseMs: number

    Full-range traverse time for continuous dimensions, in ms.

    Settings
    Member Visibility

    On This Page
    Properties