Hilo3d API - v2.0.0-alpha.3
    Preparing search index...

    Interface OrbitControlsOptions

    Configuration for OrbitControls.

    interface OrbitControlsOptions {
        camera?: PerspectiveCamera;
        enabled?: boolean;
        enablePan?: boolean;
        enableRotate?: boolean;
        enableZoom?: boolean;
        maxDistance?: number;
        maxPolarAngle?: number;
        minDistance?: number;
        minPolarAngle?: number;
        panSpeed?: number;
        rotateSpeed?: number;
        target?: Vector3;
        zoomSpeed?: number;
    }
    Index
    camera? enabled? enablePan? enableRotate? enableZoom? maxDistance? maxPolarAngle? minDistance? minPolarAngle? panSpeed? rotateSpeed? target? zoomSpeed?
    camera?: PerspectiveCamera

    Perspective camera to control. Defaults to the Stage primary camera.

    enabled?: boolean

    Whether event listeners are attached immediately. Defaults to true.

    enablePan?: boolean

    Whether secondary-drag, Shift-drag, and two-finger gestures can pan. Defaults to true.

    enableRotate?: boolean

    Whether pointer gestures can orbit the camera. Defaults to true.

    enableZoom?: boolean

    Whether wheel and pinch gestures can dolly the camera. Defaults to true.

    maxDistance?: number

    Maximum camera distance from the target. Defaults to positive infinity.

    maxPolarAngle?: number

    Maximum polar orbit angle in radians.

    minDistance?: number

    Minimum camera distance from the target. Defaults to the camera near plane.

    minPolarAngle?: number

    Minimum polar orbit angle in radians.

    panSpeed?: number

    Pan sensitivity multiplier. Defaults to 1.

    rotateSpeed?: number

    Orbit sensitivity multiplier. Defaults to 1.

    target?: Vector3

    Orbit center in the camera parent's coordinate space.

    zoomSpeed?: number

    Dolly sensitivity multiplier. Defaults to 1.

    Settings
    Member Visibility

    On This Page
    Properties