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

    Interface PointsHandlerCtx

    Bundle of host references the handler needs to do its work.

    interface PointsHandlerCtx {
        frameBudgetMs?: number;
        ladderDepth?: number | "auto";
        rootGroup: Group<Object3DEventMap> | null;
        viewStateQueue: ViewStateQueue;
        clearFailure(path: string): void;
        currentVersion: number;
        updateVersion: number;
        deriveNodeViewState(
            path: string,
            attrs: { extend_to_all?: string[] } | undefined,
            opts: {
                applyPartialExtendTolerance: boolean;
                extendedToleranceCache?: Map<string, number[]>;
            },
        ): { skip: false; viewState: ViewState };
        extendedToleranceCache: Map<string, number[]>;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index
    frameBudgetMs?: number

    Per-tick LOD time budget during dimension-animation playback (see ViewState.frameBudgetMs). Injected into the DERIVED per-node view state only — a per-pass directive, so refinement/retry passes (which derive independently) stay budget-free.

    ladderDepth?: number | "auto"

    Pinned playback ladder depth (see ViewState.ladderDepth). Same per-pass contract as frameBudgetMs: injected into the DERIVED view state only.

    rootGroup: Group<Object3DEventMap> | null
    viewStateQueue: ViewStateQueue
    currentVersion: number
    updateVersion: number

    Passes run so far — gates the first-update [GEOM] log (the view version does not move on a same-view pass).

    extendedToleranceCache: Map<string, number[]>
    signal?: AbortSignal

    Per-update abort signal forwarded to loader.updateView (see DataLoader).

    • Called on a successful load to clear the path's failure record.

      Parameters

      • path: string

      Returns void

    • Derives the per-node view-state (skip / partial-extend tolerance / nd_transform inverse).

      Parameters

      • path: string
      • attrs: { extend_to_all?: string[] } | undefined
      • opts: {
            applyPartialExtendTolerance: boolean;
            extendedToleranceCache?: Map<string, number[]>;
        }

      Returns { skip: false; viewState: ViewState }