Class OrbitControls3

Hierarchy

Implements

Constructors

  • Parameters

    • object: Camera
    • OptionaldomElement: HTMLElement

    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.

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.

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

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

0.05
dollyZoom: boolean = false
enabled: boolean = true

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

true
enableDamping: boolean = true

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

false
enablePan: boolean = true

Enable or disable camera panning.

true
enableRotate: boolean = true

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

true
enableZoom: boolean = true

Enable or disable zooming (dollying) of the camera.

true
keyPanSpeed: number = 7.0

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

7
maxAzimuthAngle: number = 10000

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 ).

Infinity
maxDistance: number = 1000

How far you can dolly out ( PerspectiveCamera only ).

Infinity
maxPolarAngle: number = Math.PI

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

Math.PI.
maxZoom: number = 1000

How far you can zoom out ( OrthographicCamera only ).

Infinity
maxZoomSpeed: number = 0.20
minAzimuthAngle: number = -10000

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 ).

Infinity
minDistance: number = 0.35

How far you can dolly in ( PerspectiveCamera only ).

0
minPolarAngle: number = 0

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

0
minZoom: number = 0.01

How far you can zoom in ( OrthographicCamera only ).

0
panSpeed: number = 1.0

Speed of panning.

1
rotateSpeed: number = 2.0

Speed of rotation.

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 for OrbitControls; false for MapControls.

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">
zoomSpeed: number = 0.15

Speed of zooming / dollying.

1