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

    Interface LODProgressState

    Live, per-node LOD / progressive-refinement / cache-residency state, polled by the monitor each tick. Keyed by scene-graph path. All fields beyond kind are optional — only the ones relevant to a node's kind are populated.

    interface LODProgressState {
        kind: LODNodeKind;
        levelCount?: number;
        activeLevel?: number;
        selector?: string;
        loaded?: number;
        total?: number;
        refining?: boolean;
        held?: RefinementHoldReason;
        lastAllResident?: boolean;
        energy?: number;
        partCount?: number;
    }
    Index
    kind levelCount? activeLevel? selector? loaded? total? refining? held? lastAllResident? energy? partCount?
    kind: LODNodeKind
    levelCount?: number

    substitutive: total number of levels (child count).

    activeLevel?: number

    substitutive: currently active level index (0-based, coarsest-first).

    selector?: string

    substitutive: selector mode — 'auto' or a locked level label.

    loaded?: number

    additive: rungs actually committed on screen; falls back to the loader's cursor when no committedLODCount stamp exists.

    total?: number

    additive: total LOD levels available.

    refining?: boolean

    additive: more LODs pending — refinement loop still running.

    held?: RefinementHoldReason

    additive: why the next rung is HELD rather than streaming, when it is. 'density': the density guard's rung gate — at the current framing the node already projects more elements per pixel than its cap; loads once the camera moves in. 'budget': the residency ceiling — loading it would exceed the in-memory budget; nothing more loads until memory frees. Absent while a pending rung is genuinely downloading (or nothing is pending).

    lastAllResident?: boolean

    additive: whether the most recent streamed load was fully cache-resident (drives a "cached" vs "streaming" indicator). Mirrors ResidencyAccumulator.allResident.

    energy?: number

    additive: committed energy fraction e(k) ∈ [0, 1] of the loaded ladder prefix (from the build-time energy_fraction_cum quality stamps — energy-ordered streaming front-loads the visually important elements). Undefined on unstamped (legacy) datasets.

    partCount?: number

    partition: number of BSP parts.

    Settings
    Member Visibility

    On This Page
    Properties