Illutions Engine API - v0.26.0
    Preparing search index...

    Interface OrbitCtrlsCfg

    Defines the Orbit Controls settings used to rotate, pan, zoom and constrain the camera around a target.

    interface OrbitCtrlsCfg {
        autoRotate: boolean;
        autoRotateSpeed: number;
        dampingFactor: number;
        enable: boolean;
        enableDamping: boolean;
        enablePan: boolean;
        enableRotate: boolean;
        enableZoom: boolean;
        load: boolean;
        maxDistance: number;
        maxPolarAngle: number;
        minDistance: number;
        minPolarAngle: number;
        panSpeed: number;
        rotateSpeed: number;
        zoomSpeed: number;
    }
    Index
    autoRotate: boolean

    Enables automatic camera rotation.

    false
    
    autoRotateSpeed: number

    Rotation speed of automatic rotation.

    2.0
    
    dampingFactor: number

    Amount of damping applied per frame.

    0.1
    
    enable: boolean

    Enables OrbitControls.

    false
    
    enableDamping: boolean

    Enables smooth inertia-like camera movement.

    false
    
    enablePan: boolean

    Enables or disables camera panning.

    true
    
    enableRotate: boolean

    Enables or disables camera rotation.

    true
    
    enableZoom: boolean

    Enables or disables zoom interaction.

    true
    
    load: boolean

    Loads OrbitControls via dynamic import.

    false
    
    maxDistance: number

    Maximum allowed distance between the camera and the target.

    Infinity
    
    maxPolarAngle: number

    Maximum allowed vertical orbit angle in degrees.

    180
    
    minDistance: number

    Minimum allowed distance between the camera and the target.

    0
    
    minPolarAngle: number

    Minimum allowed vertical orbit angle in degrees.

    0
    
    panSpeed: number

    Speed factor for panning movement.

    1.0
    
    rotateSpeed: number

    Speed factor for camera rotation.

    1.0
    
    zoomSpeed: number

    Speed factor for zooming.

    1.0