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

    Interface SetupContext

    Context object passed to all setup functions. Contains all dependencies needed to create controls.

    interface SetupContext {
        gui: GUI;
        settings: RenderingSettings;
        postProcessing: PostProcessingManager;
        sceneManager: SceneManager;
        animationController?: AnimationController;
        saveSettings: () => void;
        triggerAnimation: () => void;
        updateClippingControlsState: (dynamicEnabled: boolean) => void;
        updateNavigationControls: (controlType: "orbit" | "fly" | "ortho") => void;
    }
    Index
    gui settings postProcessing sceneManager animationController? saveSettings triggerAnimation updateClippingControlsState updateNavigationControls
    gui: GUI

    The GUI instance or folder to add controls to

    settings: RenderingSettings

    Current rendering settings (mutable)

    postProcessing: PostProcessingManager

    Reference to post-processing manager

    sceneManager: SceneManager

    Reference to scene manager

    animationController?: AnimationController

    Reference to animation controller (optional)

    saveSettings: () => void

    Callback to save settings to localStorage

    triggerAnimation: () => void

    Callback to trigger a single animation frame render

    updateClippingControlsState: (dynamicEnabled: boolean) => void

    Callback to update clipping controls enabled/disabled state

    updateNavigationControls: (controlType: "orbit" | "fly" | "ortho") => void

    Callback to update navigation controls visibility based on control type

    Settings
    Member Visibility

    On This Page
    Properties