Class OrbitControls

Helper to create orbit camera controls (sometimes called arc ball camera).

Example

// assuming renderer is a valid CameraRenderer
const { camera } = renderer
const orbitControls = new OrbitControls({ camera })

Constructors

constructor

new OrbitControls(parameters): OrbitControls
OrbitControls constructor = *
Parameters
- parameters: OrbitControlsParams
  parameters to use.
Returns OrbitControls
- Defined in src/extras/controls/OrbitControls.ts:122

Properties

camera

camera: Camera

Camera to use with this OrbitControls.

`Private` #element

#element: any = null

HTMLElement (or Window element) to use for event listeners.

target

target: Vec3

The focus point or the OrbitControls. Default to Vec3(0).

enableZoom

enableZoom: boolean

Whether to allow zooming or not. Default to true.

minZoom

minZoom: number

Minimum zoom value to use. Default to 0.

maxZoom

maxZoom: number

Maximum zoom value to use. Default to Infinity.

zoomSpeed

zoomSpeed: number

Zoom speed value to use. Default to 1.

enableRotate

enableRotate: boolean

Whether to allow rotating or not. Default to true.

minPolarAngle

minPolarAngle: number

Minimum angle to use for vertical rotation. Default to 0.

maxPolarAngle

maxPolarAngle: number

Maximum angle to use for vertical rotation. Default to Math.PI.

minAzimuthAngle

minAzimuthAngle: number

Minimum angle to use for horizontal rotation. Default to -Infinity.

maxAzimuthAngle

maxAzimuthAngle: number

Maximum angle to use for horizontal rotation. Default to Infinity.

rotateSpeed

rotateSpeed: number

Rotate speed value to use. Default to 1.

enablePan

enablePan: boolean

Whether to allow paning or not. Default to true.

panSpeed

panSpeed: number

Pan speed value to use. Default to 1.

Accessors

element

get element(): HTMLElement | Window
Get our element to use for event listeners.

Returns HTMLElement | Window
- HTMLElement (or Window element) used.
- Defined in src/extras/controls/OrbitControls.ts:308
set element(value): void
Set the element to use for event listeners. Can remove previous event listeners first if needed.
Parameters
- value: HTMLElement | Window
  HTMLElement (or Window element) to use.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:292

Methods

useCamera

useCamera(camera): void
Allow to set or reset this OrbitControls camera.
Parameters
- camera: Camera
  New camera to use.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:173

reset

reset(parameters?): void
Reset the OrbitControls values.
Parameters
- parameters: {
  position?: Vec3;
  } & OrbitControlsBaseParams = {}
  Parameters used to reset the values. Those are the same as OrbitControlsBaseParams with an additional position parameter to allow to override the OrbitControls position.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:235

updatePosition

updatePosition(position?): void
Allow to override the camera position.
Parameters
- position: Vec3 = ...
  new camera position to set.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:279

`Private` #addEvents

#addEvents(): void
Private
Add the event listeners.

Returns void
- Defined in src/extras/controls/OrbitControls.ts:316

`Private` #removeEvents

#removeEvents(): void
Private
Remove the event listeners.

Returns void
- Defined in src/extras/controls/OrbitControls.ts:331

`Private` #onMouseDown

#onMouseDown(e): void
Private
Callback executed on mouse down event.
Parameters
- e: MouseEvent
  MouseEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:347

`Private` #onTouchStart

#onTouchStart(e): void
Private
Callback executed on touch start event.
Parameters
- e: TouchEvent
  TouchEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:365

`Private` #onMouseMove

#onMouseMove(e): void
Callback executed on mouse move event.
Parameters
- e: MouseEvent
  MouseEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:377

`Private` #onTouchMove

#onTouchMove(e): void
Private
Callback executed on touch move event.
Parameters
- e: TouchEvent
  TouchEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:390

`Private` #onMouseUp

#onMouseUp(e): void
Private
Callback executed on mouse up event.
Parameters
- e: MouseEvent
  MouseEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:401

`Private` #onTouchEnd

#onTouchEnd(e): void
Private
Callback executed on touch end event.
Parameters
- e: TouchEvent
  MouseEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:411

`Private` #onMouseWheel

#onMouseWheel(e): void
Private
Callback executed on wheel event.
Parameters
- e: WheelEvent
  WheelEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:421

`Private` #onContextMenu

#onContextMenu(e): void
Private
Prevent context menu apparition on right click
Parameters
- e: MouseEvent
  MouseEvent.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:434

`Private` #update

#update(): void
Private
Update the camera position based on the target and internal values.

Returns void
- Defined in src/extras/controls/OrbitControls.ts:442

`Private` #rotate

#rotate(x, y): void
Private
Update the camera position based on input coordinates so it rotates around the target.
Parameters
- x: number
  input coordinate along the X axis.
- y: number
  input coordinate along the Y axis.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:459

`Private` #pan

#pan(x, y): void
Private
Pan the camera position based on input coordinates by updating target.
Parameters
- x: number
  input coordinate along the X axis.
- y: number
  input coordinate along the Y axis.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:479

`Private` #zoom

#zoom(value): void
Private
Move the camera forward or backward.
Parameters
- value: number
  new value to use for zoom.
Returns void
- Defined in src/extras/controls/OrbitControls.ts:524

destroy

destroy(): void
Destroy the OrbitControls.

Returns void
- Defined in src/extras/controls/OrbitControls.ts:536

Class OrbitControls

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: OrbitControlsParams

Returns OrbitControls

Properties

camera

Private #element

target

enableZoom

minZoom

maxZoom

zoomSpeed

enableRotate

minPolarAngle

maxPolarAngle

minAzimuthAngle

maxAzimuthAngle

rotateSpeed

enablePan

panSpeed

Accessors

element

Returns HTMLElement | Window

Parameters

value: HTMLElement | Window

Returns void

Methods

useCamera

Parameters

camera: Camera

Returns void

reset

Parameters

parameters: { position?: Vec3; } & OrbitControlsBaseParams = {}

Returns void

updatePosition

Parameters

position: Vec3 = ...

Returns void

Private #addEvents

Returns void

Private #removeEvents

Returns void

Private #onMouseDown

Parameters

e: MouseEvent

Returns void

Private #onTouchStart

Parameters

e: TouchEvent

Returns void

Private #onMouseMove

Parameters

e: MouseEvent

Returns void

Private #onTouchMove

Parameters

e: TouchEvent

Returns void

Private #onMouseUp

Parameters

e: MouseEvent

Returns void

Private #onTouchEnd

Parameters

e: TouchEvent

Returns void

Private #onMouseWheel

Parameters

e: WheelEvent

Returns void

Private #onContextMenu

`Private` #element

parameters: {
position?: Vec3;
} & OrbitControlsBaseParams = {}

`Private` #addEvents

`Private` #removeEvents

`Private` #onMouseDown

`Private` #onTouchStart

`Private` #onMouseMove

`Private` #onTouchMove

`Private` #onMouseUp

`Private` #onTouchEnd

`Private` #onMouseWheel

`Private` #onContextMenu

`Private` #update

`Private` #rotate

`Private` #pan

`Private` #zoom