ThreePipe
    Preparing search index...

    Class OrbitControls3

    Hierarchy

    Implements

    Index

    Constructors

    constructor

    Properties

    autoPullTarget autoPushTarget autoRotate autoRotateSpeed clampMax clampMin dampingFactor dollyZoom enabled enableDamping enablePan enableRotate enableZoom keyPanSpeed maxAzimuthAngle maxDistance maxPolarAngle maxZoom maxZoomSpeed minAzimuthAngle minDistance minPolarAngle minZoom panSpeed rotateSpeed screenSpacePanning stopDamping throttleUpdate type uiConfig? zoomSpeed zoomToCursor

    Constructors

    • Parameters

      • object: Camera

        The camera to be controlled. The camera must not be a child of another object, unless that object is the scene itself.

      • OptionaldomElement: HTMLElement | null

        The HTML element used for event listeners. (optional)

      Returns OrbitControls3

    Properties

    autoPullTarget: boolean = false
    autoPushTarget: boolean = false
    autoRotate: boolean = false

    Set to true to automatically rotate around the target. Note that if this is enabled, you must call .update() in your animation loop. If you want the auto-rotate speed to be independent of the frame rate (the refresh rate of the display), you must pass the time deltaTime, in seconds, to .update().

    autoRotateSpeed: number = 2.0

    How fast to rotate around the target if .autoRotate is true. Default is 2.0, which equates to 30 seconds per orbit at 60fps. Note that if .autoRotate is enabled, you must call .update() in your animation loop.

    clampMax: Vector3 = ...
    clampMin: Vector3 = ...
    dampingFactor: number = 0.08

    The damping inertia used if .enableDamping is set to true. Default is 0.05. Note that for this to work, you must call .update() in your animation loop.

    dollyZoom: boolean = false
    enabled: boolean = true

    When set to false, the controls will not respond to user input. Default is true.

    enableDamping: boolean = true

    Set to true to enable damping (inertia), which can be used to give a sense of weight to the controls. Default is false. Note that if this is enabled, you must call .update() in your animation loop.

    enablePan: boolean = true

    Enable or disable camera panning. Default is true.

    enableRotate: boolean = true

    Enable or disable horizontal and vertical rotation of the camera. Default is true. Note that it is possible to disable a single axis by setting the min and max of the [polar angle].minPolarAngle or [azimuth angle].minAzimuthAngle to the same value, which will cause the vertical or horizontal rotation to be fixed at that value.

    enableZoom: boolean = true

    Enable or disable zooming (dollying) of the camera.

    keyPanSpeed: number = 7.0

    How fast to pan the camera when the keyboard is used. Default is 7.0 pixels per keypress.

    maxAzimuthAngle: number = 1e6

    How far you can orbit horizontally, upper limit. If set, the interval [ min, max ] must be a sub-interval of [ - 2 PI, 2 PI ], with ( max - min < 2 PI ). Default is Infinity.

    maxDistance: number = 1e6

    How far you can dolly out ( PerspectiveCamera only ). Default is Infinity.

    maxPolarAngle: number = Math.PI

    How far you can orbit vertically, upper limit. Range is 0 to Math.PI radians, and default is Math.PI.

    maxZoom: number = 1e6

    How far you can zoom out ( OrthographicCamera only ). Default is Infinity.

    maxZoomSpeed: number = 0.20
    minAzimuthAngle: number = -1e6

    How far you can orbit horizontally, lower limit. If set, the interval [ min, max ] must be a sub-interval of [ - 2 PI, 2 PI ], with ( max - min < 2 PI ). Default is Infinity.

    minDistance: number = 0.35

    How far you can dolly in ( PerspectiveCamera only ). Default is 0.

    minPolarAngle: number = 0

    How far you can orbit vertically, lower limit. Range is 0 to Math.PI radians, and default is 0.

    minZoom: number = 0.01

    How far you can zoom in ( OrthographicCamera only ). Default is 0.

    panSpeed: number = 1.0

    Speed of panning. Default is 1.

    rotateSpeed: number = 2.0

    Speed of rotation. Default is 1.

    screenSpacePanning: boolean = true

    Defines how the camera's position is translated when panning. If true, the camera pans in screen space. Otherwise, the camera pans in the plane orthogonal to the camera's up direction. Default is true.

    stopDamping: () => void
    throttleUpdate: number = 60

    Max number of updates in a second, set to 0 to disable throttling.

    type: string = 'OrbitControls'
    uiConfig?: UiObjectConfig<void, "panel", any>
    zoomSpeed: number = 0.15

    Speed of zooming / dollying. Default is 1.

    zoomToCursor: boolean = false

    Setting this property to true allows to zoom to the cursor's position. Default is false.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties