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

    Interface ControlsManagerConfig

    Feel/behavior parameters for the three camera control modes.

    Populated with config-derived defaults by ControlsManager and updated live through its setters. Fields are grouped by mode: autoRotate* and naturalDrag apply to orbit, orbit* to both orbit and ortho (the same LuxarOrbitControls class backs both, and the live setters mutate whichever instance is current), and fly* to fly mode. All fields are optional; unset fields fall back to the manager's config defaults.

    interface ControlsManagerConfig {
        autoRotate?: boolean;
        autoRotateSpeed?: number;
        autoRotateAxis?: AutoRotateAxis;
        autoDolly?: boolean;
        autoDollyAmplitudePercent?: number;
        autoDollyPeriod?: number;
        naturalDrag?: boolean;
        orbitZoomSpeed?: number;
        orbitDampingFactor?: number;
        flyMovementSpeed?: number;
        flyRotationSpeed?: number;
        flyLookSpeed?: number;
        flyInertialMode?: boolean;
        flyDamping?: number;
        flyRotationDamping?: number;
    }
    Index
    autoRotate?: boolean
    autoRotateSpeed?: number
    autoRotateAxis?: AutoRotateAxis

    Camera-frame or fixed scene axis the orbit turntable revolves around (see AutoRotateAxis). Persisted here (not only on the live instance) so it survives the dispose/recreate an orbit↔ortho switch performs, exactly like the speed above.

    autoDolly?: boolean

    Auto-dolly: oscillate the viewing distance on a sine (the turntable's radial sibling). Persisted here for the same reason the turntable fields are — an orbit↔ortho switch disposes and recreates the control.

    autoDollyAmplitudePercent?: number

    Peak dolly swing as a PERCENT of the orbit distance. Percent (not the fraction the control holds) because this side of the manager is the user-facing one; createOrbitControls/createOrthoControls convert through dollyAmplitudeFromPercent.

    autoDollyPeriod?: number

    Seconds per full dolly oscillation.

    naturalDrag?: boolean

    Swap LEFT ↔ RIGHT mouse-button mapping in orbit (3D) mode. When true, one-finger drag rotates and right-drag pans (touchpad ergonomics); when false, the classic CAD/Blender mapping (left-drag pans, right- drag rotates) stays in place. Ignored in ortho and fly modes.

    orbitZoomSpeed?: number

    Orbit feel parameters. Also applied to ortho mode — it is the same LuxarOrbitControls class, and the live setters mutate whichever instance is current, so both modes share one zoom/damping feel.

    orbitDampingFactor?: number
    flyMovementSpeed?: number
    flyRotationSpeed?: number
    flyLookSpeed?: number
    flyInertialMode?: boolean
    flyDamping?: number
    flyRotationDamping?: number