CameraControls | camera-controls

Hierarchy

EventDispatcher
- CameraControls

Index

Statics

Constructor

constructor

Statics

Static install

install(libs: { THREE: THREESubset }): void

Injects THREE as the dependency. You can then proceed to use CameraControls.

e.g

CameraControls.install( { THREE: THREE } );

Note: If you do not wish to use enter three.js to reduce file size(tree-shaking for example), make a subset to install.

import {
    MOUSE,
    Vector2,
    Vector3,
    Vector4,
    Quaternion,
    Matrix4,
    Spherical,
    Box3,
    Sphere,
    Raycaster,
    MathUtils,
} from 'three';

const subsetOfTHREE = {
    MOUSE     : MOUSE,
    Vector2   : Vector2,
    Vector3   : Vector3,
    Vector4   : Vector4,
    Quaternion: Quaternion,
    Matrix4   : Matrix4,
    Spherical : Spherical,
    Box3      : Box3,
    Sphere    : Sphere,
    Raycaster : Raycaster,
    MathUtils : {
        DEG2RAD: MathUtils.DEG2RAD,
        clamp: MathUtils.clamp,
    },
};

CameraControls.install( { THREE: subsetOfTHREE } );

Parameters

libs: { THREE: THREESubset }
- THREE: THREESubset

Returns void

Static ACTION

get ACTION(): Readonly<{ NONE: 0; ROTATE: 1; TRUCK: 2; OFFSET: 3; DOLLY: 4; ZOOM: 5; TOUCH_ROTATE: 6; TOUCH_TRUCK: 7; TOUCH_OFFSET: 8; TOUCH_DOLLY: 9; TOUCH_ZOOM: 10; TOUCH_DOLLY_TRUCK: 11; TOUCH_DOLLY_OFFSET: 12; TOUCH_ZOOM_TRUCK: 13; TOUCH_ZOOM_OFFSET: 14 }>

- Defined in CameraControls.ts:136
list all ACTIONs

category
Statics

Returns Readonly<{ NONE: 0; ROTATE: 1; TRUCK: 2; OFFSET: 3; DOLLY: 4; ZOOM: 5; TOUCH_ROTATE: 6; TOUCH_TRUCK: 7; TOUCH_OFFSET: 8; TOUCH_DOLLY: 9; TOUCH_ZOOM: 10; TOUCH_DOLLY_TRUCK: 11; TOUCH_DOLLY_OFFSET: 12; TOUCH_ZOOM_TRUCK: 13; TOUCH_ZOOM_OFFSET: 14 }>

Constructor

constructor

new CameraControls(camera: PerspectiveCamera | OrthographicCamera, domElement: HTMLElement): CameraControls

Overrides EventDispatcher.constructor
- Defined in CameraControls.ts:401
Creates a CameraControls instance.
Note:
You must install three.js before using camera-controls. see #install
Not doing so will lead to runtime errors (undefined references to THREE).

e.g.
```
CameraControls.install( { THREE } );
const cameraControls = new CameraControls( camera, domElement );
```
Parameters
- camera: PerspectiveCamera | OrthographicCamera
  
  A THREE.PerspectiveCamera or THREE.OrthographicCamera to be controlled.
- domElement: HTMLElement
  
  A HTMLElement for the draggable area, usually renderer.domElement.
Returns CameraControls

Properties

minPolarAngle

minPolarAngle: number = 0

Minimum vertical angle in radians.
The angle has to be between 0 and .maxPolarAngle inclusive.
The default value is 0.

e.g.

cameraControls.maxPolarAngle = 0;

maxPolarAngle

maxPolarAngle: number = Math.PI

Maximum vertical angle in radians.
The angle has to be between .maxPolarAngle and Math.PI inclusive.
The default value is Math.PI.

e.g.

cameraControls.maxPolarAngle = Math.PI;

minAzimuthAngle

minAzimuthAngle: number = - Infinity

Minimum horizontal angle in radians.
The angle has to be less than .maxAzimuthAngle.
The default value is - Infinity.

e.g.

cameraControls.minAzimuthAngle = - Infinity;

maxAzimuthAngle

maxAzimuthAngle: number = Infinity

Maximum horizontal angle in radians.
The angle has to be greater than .minAzimuthAngle.
The default value is Infinity.

e.g.

cameraControls.maxAzimuthAngle = Infinity;

minDistance

minDistance: number = 0

Minimum distance for dolly. The value must be higher than 0.
PerspectiveCamera only.

maxDistance

maxDistance: number = Infinity

Maximum distance for dolly. The value must be higher than minDistance.
PerspectiveCamera only.

infinityDolly

infinityDolly: boolean = false

true to enable Infinity Dolly.
When the Dolly distance is less than the minDistance, radius of the sphere will be set minDistance automatically.

minZoom

minZoom: number = 0.01

Minimum camera zoom.

maxZoom

maxZoom: number = Infinity

Maximum camera zoom.

dampingFactor

dampingFactor: number = 0.05

The damping inertia.
The value must be between Math.EPSILON to 1 inclusive.
Setting 1 to disable smooth transitions.

draggingDampingFactor

draggingDampingFactor: number = 0.25

The damping inertia while dragging.
The value must be between Math.EPSILON to 1 inclusive.
Setting 1 to disable smooth transitions.

azimuthRotateSpeed

azimuthRotateSpeed: number = 1.0

Speed of azimuth (horizontal) rotation.

polarRotateSpeed

polarRotateSpeed: number = 1.0

Speed of polar (vertical) rotation.

dollySpeed

dollySpeed: number = 1.0

Speed of mouse-wheel dollying.

truckSpeed

truckSpeed: number = 2.0

Speed of drag for truck and pedestal.

dollyToCursor

dollyToCursor: boolean = false

true to enable Dolly-in to the mouse cursor coords.

dragToOffset

dragToOffset: boolean = false

verticalDragToForward

verticalDragToForward: boolean = false

The same as .screenSpacePanning in three.js's OrbitControls.

boundaryFriction

boundaryFriction: number = 0.0

Friction ratio of the boundary.

restThreshold

restThreshold: number = 0.01

Controls how soon the rest event fires as the camera slows.

colliderMeshes

colliderMeshes: Object3D<Event>[] = []

An array of Meshes to collide with camera.
Be aware colliderMeshes may decrease performance. The collision test uses 4 raycasters from the camera since the near plane has 4 corners.

mouseButtons

mouseButtons: MouseButtons

User's mouse input config.

button to assign	behavior
`mouseButtons.left`	`CameraControls.ACTION.ROTATE`* \| `CameraControls.ACTION.TRUCK` \| `CameraControls.ACTION.OFFSET` \| `CameraControls.ACTION.DOLLY` \| `CameraControls.ACTION.ZOOM` \| `CameraControls.ACTION.NONE`
`mouseButtons.right`	`CameraControls.ACTION.ROTATE` \| `CameraControls.ACTION.TRUCK`* \| `CameraControls.ACTION.OFFSET` \| `CameraControls.ACTION.DOLLY` \| `CameraControls.ACTION.ZOOM` \| `CameraControls.ACTION.NONE`
`mouseButtons.shiftLeft`	`CameraControls.ACTION.ROTATE` \| `CameraControls.ACTION.TRUCK` \| `CameraControls.ACTION.OFFSET` \| `CameraControls.ACTION.DOLLY` \| `CameraControls.ACTION.ZOOM` \| `CameraControls.ACTION.NONE`*
`mouseButtons.wheel` ¹	`CameraControls.ACTION.ROTATE` \| `CameraControls.ACTION.TRUCK` \| `CameraControls.ACTION.OFFSET` \| `CameraControls.ACTION.DOLLY` \| `CameraControls.ACTION.ZOOM` \| `CameraControls.ACTION.NONE`
`mouseButtons.middle` ²	`CameraControls.ACTION.ROTATE` \| `CameraControls.ACTION.TRUCK` \| `CameraControls.ACTION.OFFSET` \| `CameraControls.ACTION.DOLLY`* \| `CameraControls.ACTION.ZOOM` \| `CameraControls.ACTION.NONE`

Mouse wheel event for scroll "up/down" on mac "up/down/left/right"
Mouse click on wheel event "button"

* is the default.
The default of mouseButtons.wheel is:
- DOLLY for Perspective camera.
- ZOOM for Orthographic camera, and can't set DOLLY.

touches

touches: Touches

User's touch input config.

fingers to assign	behavior
`touches.one`	`CameraControls.ACTION.TOUCH_ROTATE`* \| `CameraControls.ACTION.TOUCH_TRUCK` \| `CameraControls.ACTION.TOUCH_OFFSET` \| `CameraControls.ACTION.DOLLY`
`touches.two`	`ACTION.TOUCH_DOLLY_TRUCK` \| `ACTION.TOUCH_DOLLY_OFFSET` \| `ACTION.TOUCH_ZOOM_TRUCK` \| `ACTION.TOUCH_ZOOM_OFFSET` \| `ACTION.TOUCH_DOLLY` \| `ACTION.TOUCH_ZOOM` \| `CameraControls.ACTION.TOUCH_ROTATE` \| `CameraControls.ACTION.TOUCH_TRUCK` \| `CameraControls.ACTION.TOUCH_OFFSET` \| `CameraControls.ACTION.NONE`
`touches.three`	`ACTION.TOUCH_DOLLY_TRUCK` \| `ACTION.TOUCH_DOLLY_OFFSET` \| `ACTION.TOUCH_ZOOM_TRUCK` \| `ACTION.TOUCH_ZOOM_OFFSET` \| `CameraControls.ACTION.TOUCH_ROTATE` \| `CameraControls.ACTION.TOUCH_TRUCK` \| `CameraControls.ACTION.TOUCH_OFFSET` \| `CameraControls.ACTION.NONE`

* is the default.
The default of touches.two and touches.three is:
- TOUCH_DOLLY_TRUCK for Perspective camera.
- TOUCH_ZOOM_TRUCK for Orthographic camera, and can't set TOUCH_DOLLY_TRUCK and TOUCH_DOLLY.

camera

get camera(): PerspectiveCamera | OrthographicCamera
set camera(camera: PerspectiveCamera | OrthographicCamera): void

- Defined in CameraControls.ts:1067
The camera to be controlled

category
Properties

Returns PerspectiveCamera | OrthographicCamera
- Defined in CameraControls.ts:1073
The camera to be controlled

Parameters
- camera: PerspectiveCamera | OrthographicCamera
Returns void

enabled

get enabled(): boolean
set enabled(enabled: boolean): void

- Defined in CameraControls.ts:1088
Whether or not the controls are enabled.
false to disable user dragging/touch-move, but all methods works.

category
Properties

Returns boolean
- Defined in CameraControls.ts:1094
Whether or not the controls are enabled.
false to disable user dragging/touch-move, but all methods works.

Parameters
- enabled: boolean
Returns void

active

get active(): boolean

- Defined in CameraControls.ts:1119
Returns true if the controls are active updating.
readonly value.

category
Properties

Returns boolean

currentAction

get currentAction(): ACTION

- Defined in CameraControls.ts:1130
Getter for the current ACTION.
readonly value.

category
Properties

Returns ACTION

distance

get distance(): number
set distance(distance: number): void

- Defined in CameraControls.ts:1140
get/set Current distance.

category
Properties

Returns number
- Defined in CameraControls.ts:1146
get/set Current distance.

Parameters
- distance: number
Returns void

azimuthAngle

get azimuthAngle(): number
set azimuthAngle(azimuthAngle: number): void

- Defined in CameraControls.ts:1165
get/set the azimuth angle (horizontal) in radians.
Every 360 degrees turn is added to .azimuthAngle value, which is accumulative.

category
Properties

Returns number
- Defined in CameraControls.ts:1171
get/set the azimuth angle (horizontal) in radians.
Every 360 degrees turn is added to .azimuthAngle value, which is accumulative.

Parameters
- azimuthAngle: number
Returns void

polarAngle

get polarAngle(): number
set polarAngle(polarAngle: number): void

- Defined in CameraControls.ts:1189
get/set the polar angle (vertical) in radians.

category
Properties

Returns number
- Defined in CameraControls.ts:1195
get/set the polar angle (vertical) in radians.

Parameters
- polarAngle: number
Returns void

boundaryEnclosesCamera

get boundaryEnclosesCamera(): boolean
set boundaryEnclosesCamera(boundaryEnclosesCamera: boolean): void

- Defined in CameraControls.ts:1212
Whether camera position should be enclosed in the boundary or not.

category
Properties

Returns boolean
- Defined in CameraControls.ts:1218
Whether camera position should be enclosed in the boundary or not.

Parameters
- boundaryEnclosesCamera: boolean
Returns void

Methods

cancel

cancel: () => void = ...

Type declaration

- (): void
- Force cancel user dragging.
  
  Returns void

addEventListener

addEventListener<K>(type: K, listener: (event: CameraControlsEventMap[K]) => any): void

Adds the specified event listener.
Applicable event types (which is K) are:

Event name	Timing
`'controlstart'`	When the user starts to control the camera via mouse / touches. ¹
`'control'`	When the user controls the camera (dragging).
`'controlend'`	When the user ends to control the camera. ¹
`'transitionstart'`	When any kind of transition starts, either user control or using a method with `enableTransition = true`
`'update'`	When the camera position is updated.
`'wake'`	When the camera starts moving.
`'rest'`	When the camera movement is below `.restThreshold` ².
`'sleep'`	When the camera end moving.

mouseButtons.wheel (Mouse wheel control) does not emit 'controlstart' and 'controlend'. mouseButtons.wheel uses scroll-event internally, and scroll-event happens intermittently. That means "start" and "end" cannot be detected.
Due to damping, sleep will usually fire a few seconds after the camera appears to have stopped moving. If you want to do something (e.g. enable UI, perform another transition) at the point when the camera has stopped, you probably want the rest event. This can be fine tuned using the .restThreshold parameter. See the Rest and Sleep Example.

e.g.

cameraControl.addEventListener( 'controlstart', myCallbackFunction );

Type parameters

K: keyof CameraControlsEventMap

Parameters

type: K

event name
listener: (event: CameraControlsEventMap[K]) => any

handler function
- - (event: CameraControlsEventMap[K]): any
  - Parameters
    - event: CameraControlsEventMap[K]
    Returns any

Returns void

removeEventListener

removeEventListener<K>(type: K, listener: (event: CameraControlsEventMap[K]) => any): void

Overrides EventDispatcher.removeEventListener
- Defined in CameraControls.ts:1269
Removes the specified event listener
e.g.
```
cameraControl.addEventListener( 'controlstart', myCallbackFunction );
```
Type parameters
- K: keyof CameraControlsEventMap
Parameters
- type: K
  
  event name
- listener: (event: CameraControlsEventMap[K]) => any
  
  handler function
  - - (event: CameraControlsEventMap[K]): any
    - Parameters
      - event: CameraControlsEventMap[K]
      Returns any
Returns void

rotate

rotate(azimuthAngle: number, polarAngle: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1286
Rotate azimuthal angle(horizontal) and polar angle(vertical).
Every value is added to the current value.

Parameters
- azimuthAngle: number
  
  Azimuth rotate angle. In radian.
- polarAngle: number
  
  Polar rotate angle. In radian.
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

rotateAzimuthTo

rotateAzimuthTo(azimuthAngle: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1307
Rotate azimuthal angle(horizontal) to the given angle and keep the same polar angle(vertical) target.
e.g.
```
cameraControls.rotateAzimuthTo( 30 * THREE.MathUtils.DEG2RAD, true );
```
Parameters
- azimuthAngle: number
  
  Azimuth rotate angle. In radian.
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

rotatePolarTo

rotatePolarTo(polarAngle: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1328
Rotate polar angle(vertical) to the given angle and keep the same azimuthal angle(horizontal) target.
e.g.
```
cameraControls.rotatePolarTo( 30 * THREE.MathUtils.DEG2RAD, true );
```
Parameters
- polarAngle: number
  
  Polar rotate angle. In radian.
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

rotateTo

rotateTo(azimuthAngle: number, polarAngle: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1376
Rotate azimuthal angle(horizontal) and polar angle(vertical) to the given angle.
Camera view will rotate over the orbit pivot absolutely:
azimuthAngle
```
      0º
        \
90º -----+----- -90º
          \
          180º
```
direction angle

front 0º

left 90º (Math.PI / 2)

right -90º (- Math.PI / 2)

back 180º (Math.PI)

polarAngle
```
    180º
     |
     90º
     |
     0º
```
direction angle

top/sky 180º (Math.PI)

horizontal from view 90º (Math.PI / 2)

bottom/floor 0º
Parameters
- azimuthAngle: number
  
  Azimuth rotate angle to. In radian.
- polarAngle: number
  
  Polar rotate angle to. In radian.
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

direction	angle
front	0º
left	90º (`Math.PI / 2`)
right	-90º (`- Math.PI / 2`)
back	180º (`Math.PI`)

direction	angle
top/sky	180º (`Math.PI`)
horizontal from view	90º (`Math.PI / 2`)
bottom/floor	0º

dolly

dolly(distance: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1407
Dolly in/out camera position.

Parameters
- distance: number
  
  Distance of dollyIn. Negative number for dollyOut.
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately.
Returns Promise<void>

dollyTo

dollyTo(distance: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1419
Dolly in/out camera position to given distance.

Parameters
- distance: number
  
  Distance of dolly.
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately.
Returns Promise<void>

zoom

zoom(zoomStep: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1461
Zoom in/out camera. The value is added to camera zoom.
Limits set with .minZoom and .maxZoom

Parameters
- zoomStep: number
  
  zoom scale
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

zoomTo

zoomTo(zoom: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1474
Zoom in/out camera to given scale. The value overwrites camera zoom.
Limits set with .minZoom and .maxZoom

Parameters
- zoom: number
- enableTransition: boolean = false
Returns Promise<void>

pan

pan(x: number, y: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1494
deprecated
pan() has been renamed to truck()

Parameters
- x: number
- y: number
- enableTransition: boolean = false
Returns Promise<void>

truck

truck(x: number, y: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1508
Truck and pedestal camera using current azimuthal angle

Parameters
- x: number
  
  Horizontal translate amount
- y: number
  
  Vertical translate amount
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

forward

forward(distance: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1529
Move forward / backward.

Parameters
- distance: number
  
  Amount to move forward / backward. Negative value to move backward
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

moveTo

moveTo(x: number, y: number, z: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1548
Move target position to given point.

Parameters
- x: number
  
  x coord to move center position
- y: number
  
  y coord to move center position
- z: number
  
  z coord to move center position
- enableTransition: boolean = false
  
  Whether to move smoothly or immediately
Returns Promise<void>

fitToBox

fitToBox(box3OrObject: Object3D<Event> | Box3, enableTransition: boolean, options?: Partial<FitToOptions>): Promise<void[]>

- Defined in CameraControls.ts:1582
Fit the viewport to the box or the bounding box of the object, using the nearest axis. paddings are in unit.
e.g.
```
cameraControls.fitToBox( myMesh );
```
Parameters
- box3OrObject: Object3D<Event> | Box3
  
  Axis aligned bounding box to fit the view.
- enableTransition: boolean
  
  Whether to move smoothly or immediately.
- options: Partial<FitToOptions> = {}
  
  | <object> { paddingTop: number, paddingLeft: number, paddingBottom: number, paddingRight: number }
Returns Promise<void[]>
Transition end promise

fitToSphere

fitToSphere(sphereOrMesh: Object3D<Event> | Sphere, enableTransition: boolean): Promise<void[]>

- Defined in CameraControls.ts:1691
Fit the viewport to the sphere or the bounding sphere of the object.

Parameters
- sphereOrMesh: Object3D<Event> | Sphere
- enableTransition: boolean
Returns Promise<void[]>

setLookAt

setLookAt(positionX: number, positionY: number, positionZ: number, targetX: number, targetY: number, targetZ: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1738
Make an orbit with given points.

Parameters
- positionX: number
- positionY: number
- positionZ: number
- targetX: number
- targetY: number
- targetZ: number
- enableTransition: boolean = false
Returns Promise<void>

lerpLookAt

lerpLookAt(positionAX: number, positionAY: number, positionAZ: number, targetAX: number, targetAY: number, targetAZ: number, positionBX: number, positionBY: number, positionBZ: number, targetBX: number, targetBY: number, targetBZ: number, t: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1789
Similar to setLookAt, but it interpolates between two states.

Parameters
- positionAX: number
- positionAY: number
- positionAZ: number
- targetAX: number
- targetAY: number
- targetAZ: number
- positionBX: number
- positionBY: number
- positionBZ: number
- targetBX: number
- targetBY: number
- targetBZ: number
- t: number
- enableTransition: boolean = false
Returns Promise<void>

setPosition

setPosition(positionX: number, positionY: number, positionZ: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1848
setLookAt without target, keep gazing at the current target

Parameters
- positionX: number
- positionY: number
- positionZ: number
- enableTransition: boolean = false
Returns Promise<void>

setTarget

setTarget(targetX: number, targetY: number, targetZ: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1866
setLookAt without position, Stay still at the position.

Parameters
- targetX: number
- targetY: number
- targetZ: number
- enableTransition: boolean = false
Returns Promise<void>

setFocalOffset

setFocalOffset(x: number, y: number, z: number, enableTransition?: boolean): Promise<void>

- Defined in CameraControls.ts:1885
Set focal offset using the screen parallel coordinates. z doesn't affect in Orthographic as with Dolly.

Parameters
- x: number
- y: number
- z: number
- enableTransition: boolean = false
Returns Promise<void>

setOrbitPoint

setOrbitPoint(targetX: number, targetY: number, targetZ: number): void

- Defined in CameraControls.ts:1911
Set orbit point without moving the camera.

Parameters
- targetX: number
- targetY: number
- targetZ: number
Returns void

setBoundary

setBoundary(box3?: Box3): void

- Defined in CameraControls.ts:1938
Set the boundary box that encloses the target of the camera. box3 is in THREE.Box3

Parameters
- Optional box3: Box3
Returns void

setViewport

setViewport(viewportOrX: null | number | Vector4, y: number, width: number, height: number): void

- Defined in CameraControls.ts:1965
Set (or unset) the current viewport.
Set this when you want to use renderer viewport and .dollyToCursor feature at the same time.

Parameters
- viewportOrX: null | number | Vector4
- y: number
- width: number
- height: number
Returns void

getDistanceToFitBox

getDistanceToFitBox(width: number, height: number, depth: number): number

- Defined in CameraControls.ts:1997
Calculate the distance to fit the box.

Parameters
- width: number
  
  box width
- height: number
  
  box height
- depth: number
  
  box depth
Returns number
distance

getDistanceToFitSphere

getDistanceToFitSphere(radius: number): number

- Defined in CameraControls.ts:2016
Calculate the distance to fit the sphere.

Parameters
- radius: number
  
  sphere radius
Returns number
distance

getTarget

getTarget(out: Vector3): Vector3

- Defined in CameraControls.ts:2033
Returns its current gazing target, which is the center position of the orbit.

Parameters
- out: Vector3
  
  current gazing target
Returns Vector3

getPosition

getPosition(out: Vector3): Vector3

- Defined in CameraControls.ts:2045
Returns its current position.

Parameters
- out: Vector3
  
  current position
Returns Vector3

getFocalOffset

getFocalOffset(out: Vector3): Vector3

- Defined in CameraControls.ts:2057
Returns its current focal offset, which is how much the camera appears to be translated in screen parallel coordinates.

Parameters
- out: Vector3
  
  current focal offset
Returns Vector3

normalizeRotations

normalizeRotations(): void

- Defined in CameraControls.ts:2068
Normalize camera azimuth angle rotation between 0 and 360 degrees.

Returns void

reset

reset(enableTransition?: boolean): Promise<void[]>

- Defined in CameraControls.ts:2081
Reset all rotation and position to defaults.

Parameters
- enableTransition: boolean = false
Returns Promise<void[]>

saveState

saveState(): void

- Defined in CameraControls.ts:2106
Set current camera position as the default position.

Returns void

updateCameraUp

updateCameraUp(): void

- Defined in CameraControls.ts:2119
Sync camera-up direction.
When camera-up vector is changed, .updateCameraUp() must be called.

Returns void

update

update(delta: number): boolean

- Defined in CameraControls.ts:2133
Update camera position and directions.
This should be called in your tick loop every time, and returns true if re-rendering is needed.

Parameters
- delta: number
Returns boolean
updated

toJSON

toJSON(): string

- Defined in CameraControls.ts:2324
Get all state in JSON string

Returns string

fromJSON

fromJSON(json: string, enableTransition?: boolean): void

- Defined in CameraControls.ts:2364
Reproduce the control state with JSON. enableTransition is where anim or not in a boolean.

Parameters
- json: string
- enableTransition: boolean = false
Returns void

dispose

dispose(): void

- Defined in CameraControls.ts:2405
Dispose the cameraControls instance itself, remove all eventListeners.

Returns void

removeAllEventListeners

removeAllEventListeners(type?: string): void

Inherited from EventDispatcher.removeAllEventListeners
- Defined in EventDispatcher.ts:62
Removes all event listeners

Parameters
- Optional type: string
  
  event name
Returns void

dispatchEvent

dispatchEvent(event: DispatcherEvent): void

Inherited from EventDispatcher.dispatchEvent
- Defined in EventDispatcher.ts:80
Fire an event type.

Parameters
- event: DispatcherEvent
  
  DispatcherEvent
Returns void

Hierarchy

Index

Statics

Constructor

Properties

Methods

Statics

Static install

Parameters

libs: { THREE: THREESubset }

THREE: THREESubset

Returns void

Static ACTION

Returns Readonly<{ NONE: 0; ROTATE: 1; TRUCK: 2; OFFSET: 3; DOLLY: 4; ZOOM: 5; TOUCH_ROTATE: 6; TOUCH_TRUCK: 7; TOUCH_OFFSET: 8; TOUCH_DOLLY: 9; TOUCH_ZOOM: 10; TOUCH_DOLLY_TRUCK: 11; TOUCH_DOLLY_OFFSET: 12; TOUCH_ZOOM_TRUCK: 13; TOUCH_ZOOM_OFFSET: 14 }>

Constructor

constructor

Parameters

camera: PerspectiveCamera | OrthographicCamera

domElement: HTMLElement

Returns CameraControls

Properties

minPolarAngle

maxPolarAngle

minAzimuthAngle

maxAzimuthAngle

minDistance

maxDistance

infinityDolly

minZoom

maxZoom

dampingFactor

draggingDampingFactor

azimuthRotateSpeed

polarRotateSpeed

dollySpeed

truckSpeed

dollyToCursor

dragToOffset

verticalDragToForward

boundaryFriction

restThreshold

colliderMeshes

mouseButtons

touches

camera

Returns PerspectiveCamera | OrthographicCamera

Parameters

camera: PerspectiveCamera | OrthographicCamera

Returns void

enabled

Returns boolean

Parameters

enabled: boolean

Returns void

active

Returns boolean

currentAction

Returns ACTION

distance

Returns number

Parameters

distance: number

Returns void

azimuthAngle

Returns number

Parameters

azimuthAngle: number

Returns void

polarAngle

Returns number

Parameters

polarAngle: number

Returns void

boundaryEnclosesCamera

Returns boolean

Parameters

boundaryEnclosesCamera: boolean

Returns void

Methods

cancel