Class: DefaultCameraController

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:10

A camera controller based on the camera-controls library.

Extends

• CameraControls

Constructors

new DefaultCameraController()

new DefaultCameraController(__namedParameters: {
  camera_entity: Entity;
  viewport: Viewport;
  activate: boolean;
  preset: CameraControllerPreset;
 }): DefaultCameraController

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:47

Parameters

Parameter	Type
__namedParameters	{ camera_entity: Entity; viewport: Viewport; activate: boolean; preset: CameraControllerPreset; }
__namedParameters.camera_entity	Entity
__namedParameters.viewport	Viewport
__namedParameters.activate?	boolean
__namedParameters.preset?	CameraControllerPreset

Returns

DefaultCameraController

Overrides

CameraControls.constructor;

Methods

cancel()

cancel: () => void;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:191

Force cancel user dragging.

Returns

void

Inherited from

CameraControls.cancel;

---

lockPointer()

lockPointer: () => void;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:197

Still an experimental feature. This could change at any time.

Returns

void

Inherited from

CameraControls.lockPointer;

---

unlockPointer()

unlockPointer: () => void;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:203

Still an experimental feature. This could change at any time.

Returns

void

Inherited from

CameraControls.unlockPointer;

---

addEventListener()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:373

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.

1. 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.
2. 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

Type Parameter
K extends keyof CameraControlsEventMap

Parameters

Parameter	Type	Description
type	K	event name
listener	(event: CameraControlsEventMap[K]) => any	handler function

Returns

void

Inherited from

CameraControls.addEventListener;

---

removeEventListener()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:384

Removes the specified event listener e.g.

cameraControl.addEventListener( 'controlstart', myCallbackFunction );

Type Parameters

Type Parameter
K extends keyof CameraControlsEventMap

Parameters

Parameter	Type	Description
type	K	event name
listener	(event: CameraControlsEventMap[K]) => any	handler function

Returns

void

Inherited from

CameraControls.removeEventListener;

---

rotate()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:393

Rotate azimuthal angle(horizontal) and polar angle(vertical). Every value is added to the current value.

Parameters

Parameter	Type	Description
azimuthAngle	number	Azimuth rotate angle. In radian.
polarAngle	number	Polar rotate angle. In radian.
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.rotate;

---

rotateAzimuthTo()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:405

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

Parameter	Type	Description
azimuthAngle	number	Azimuth rotate angle. In radian.
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.rotateAzimuthTo;

---

rotatePolarTo()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:417

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

Parameter	Type	Description
polarAngle	number	Polar rotate angle. In radian.
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.rotatePolarTo;

---

rotateTo()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:456

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

Parameter	Type	Description
azimuthAngle	number	Azimuth rotate angle to. In radian.
polarAngle	number	Polar rotate angle to. In radian.
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.rotateTo;

---

dolly()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:463

Dolly in/out camera position.

Parameters

Parameter	Type	Description
distance	number	Distance of dollyIn. Negative number for dollyOut.
enableTransition?	boolean	Whether to move smoothly or immediately.

Returns

Promise<void>

Inherited from

CameraControls.dolly;

---

dollyTo()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:470

Dolly in/out camera position to given distance.

Parameters

Parameter	Type	Description
distance	number	Distance of dolly.
enableTransition?	boolean	Whether to move smoothly or immediately.

Returns

Promise<void>

Inherited from

CameraControls.dollyTo;

---

dollyInFixed()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:479

Dolly in, but does not change the distance between the target and the camera, and moves the target position instead. Specify a negative value for dolly out.

Parameters

Parameter	Type	Description
distance	number	Distance of dolly.
enableTransition?	boolean	Whether to move smoothly or immediately.

Returns

Promise<void>

Inherited from

CameraControls.dollyInFixed;

---

zoom()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:487

Zoom in/out camera. The value is added to camera zoom. Limits set with .minZoom and .maxZoom

Parameters

Parameter	Type	Description
zoomStep	number	zoom scale
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.zoom;

---

zoomTo()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:495

Zoom in/out camera to given scale. The value overwrites camera zoom. Limits set with .minZoom and .maxZoom

Parameters

Parameter	Type	Description
zoom	number
enableTransition?	boolean

Returns

Promise<void>

Inherited from

CameraControls.zoomTo;

---

pan()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:500

Parameters

Parameter	Type
x	number
y	number
enableTransition?	boolean

Returns

Promise<void>

Deprecated

pan() has been renamed to truck()

Inherited from

CameraControls.pan;

---

truck()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:508

Truck and pedestal camera using current azimuthal angle

Parameters

Parameter	Type	Description
x	number	Horizontal translate amount
y	number	Vertical translate amount
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.truck;

---

forward()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:515

Move forward / backward.

Parameters

Parameter	Type	Description
distance	number	Amount to move forward / backward. Negative value to move backward
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.forward;

---

elevate()

elevate(height: number, enableTransition?: boolean): Promise<void>

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:522

Move up / down.

Parameters

Parameter	Type	Description
height	number	Amount to move up / down. Negative value to move down
enableTransition?	boolean	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.elevate;

---

moveTo()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:531

Move target position to given point.

Parameters

Parameter	Type	Description
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	Whether to move smoothly or immediately

Returns

Promise<void>

Inherited from

CameraControls.moveTo;

---

lookInDirectionOf()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:541

Look in the given point direction.

Parameters

Parameter	Type	Description
x	number	point x.
y	number	point y.
z	number	point z.
enableTransition?	boolean	Whether to move smoothly or immediately.

Returns

Promise<void>

Transition end promise

Inherited from

CameraControls.lookInDirectionOf;

---

fitToBox()

fitToBox(
   aabb: Box3,
   enableTransition: boolean,
options?: Partial<FitToOptions>): Promise<void[]>

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:555

Fit the viewport to the box or the bounding box of the object, using the nearest axis. paddings are in unit. set cover: true to fill enter screen. e.g.

cameraControls.fitToBox( myMesh );

Parameters

Parameter	Type	Description
aabb	Box3	Axis aligned bounding box to fit the view.
enableTransition	boolean	Whether to move smoothly or immediately.
options?	Partial<FitToOptions>	<object> { cover: boolean, paddingTop: number, paddingLeft: number, paddingBottom: number, paddingRight: number }

Returns

Promise<void[]>

Transition end promise

Inherited from

CameraControls.fitToBox;

---

fitToSphere()

fitToSphere(boundingSphere: Sphere, enableTransition: boolean): Promise<void[]>

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:562

Fit the viewport to the sphere or the bounding sphere of the object.

Parameters

Parameter	Type	Description
boundingSphere	Sphere
enableTransition	boolean

Returns

Promise<void[]>

Inherited from

CameraControls.fitToSphere;

---

setLookAt()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:574

Look at the target from the position.

Parameters

Parameter	Type	Description
positionX	number
positionY	number
positionZ	number
targetX	number
targetY	number
targetZ	number
enableTransition?	boolean

Returns

Promise<void>

Inherited from

CameraControls.setLookAt;

---

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: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:593

Similar to setLookAt, but it interpolates between two states.

Parameters

Parameter	Type	Description
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

Returns

Promise<void>

Inherited from

CameraControls.lerpLookAt;

---

setPosition()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:603

Set angle and distance by given position. An alias of setLookAt(), without target change. Thus keep gazing at the current target

Parameters

Parameter	Type	Description
positionX	number
positionY	number
positionZ	number
enableTransition?	boolean

Returns

Promise<void>

Inherited from

CameraControls.setPosition;

---

setTarget()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:613

Set the target position where gaze at. An alias of setLookAt(), without position change. Thus keep the same position.

Parameters

Parameter	Type	Description
targetX	number
targetY	number
targetZ	number
enableTransition?	boolean

Returns

Promise<void>

Inherited from

CameraControls.setTarget;

---

setFocalOffset()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:622

Set focal offset using the screen parallel coordinates. z doesn't affect in Orthographic as with Dolly.

Parameters

Parameter	Type	Description
x	number
y	number
z	number
enableTransition?	boolean

Returns

Promise<void>

Inherited from

CameraControls.setFocalOffset;

---

setOrbitPoint()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:631

Set orbit point without moving the camera. SHOULD NOT RUN DURING ANIMATIONS. setOrbitPoint() will immediately fix the positions.

Parameters

Parameter	Type	Description
targetX	number
targetY	number
targetZ	number

Returns

void

Inherited from

CameraControls.setOrbitPoint;

---

setBoundary()

setBoundary(box3?: Box3): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:637

Set the boundary box that encloses the target of the camera. box3 is in THREE.Box3

Parameters

Parameter	Type	Description
box3?	Box3

Returns

void

Inherited from

CameraControls.setBoundary;

---

setViewport()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:647

Set (or unset) the current viewport. Set this when you want to use renderer viewport and .dollyToCursor feature at the same time.

Parameters

Parameter	Type	Description
viewportOrX	null | number | Vector4
y	number
width	number
height	number

Returns

void

Inherited from

CameraControls.setViewport;

---

getDistanceToFitBox()

getDistanceToFitBox(
   width: number,
   height: number,
   depth: number,
   cover?: boolean): number

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:656

Calculate the distance to fit the box.

Parameters

Parameter	Type	Description
width	number	box width
height	number	box height
depth	number	box depth
cover?	boolean	-

Returns

number

distance

Inherited from

CameraControls.getDistanceToFitBox;

---

getDistanceToFitSphere()

getDistanceToFitSphere(radius: number): number

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:663

Calculate the distance to fit the sphere.

Parameters

Parameter	Type	Description
radius	number	sphere radius

Returns

number

distance

Inherited from

CameraControls.getDistanceToFitSphere;

---

getTarget()

getTarget(out: Vector3, receiveEndValue?: boolean): Vector3

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:670

Returns the orbit center position, where the camera looking at.

Parameters

Parameter	Type	Description
out	Vector3	The receiving Vector3 instance to copy the result
receiveEndValue?	boolean	Whether receive the transition end coords or current. default is true

Returns

Vector3

Inherited from

CameraControls.getTarget;

---

getPosition()

getPosition(out: Vector3, receiveEndValue?: boolean): Vector3

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:677

Returns the camera position.

Parameters

Parameter	Type	Description
out	Vector3	The receiving Vector3 instance to copy the result
receiveEndValue?	boolean	Whether receive the transition end coords or current. default is true

Returns

Vector3

Inherited from

CameraControls.getPosition;

---

getSpherical()

getSpherical(out: Spherical, receiveEndValue?: boolean): Spherical

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:684

Returns the spherical coordinates of the orbit.

Parameters

Parameter	Type	Description
out	Spherical	The receiving Spherical instance to copy the result
receiveEndValue?	boolean	Whether receive the transition end coords or current. default is true

Returns

Spherical

Inherited from

CameraControls.getSpherical;

---

getFocalOffset()

getFocalOffset(out: Vector3, receiveEndValue?: boolean): Vector3

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:691

Returns the focal offset, which is how much the camera appears to be translated in screen parallel coordinates.

Parameters

Parameter	Type	Description
out	Vector3	The receiving Vector3 instance to copy the result
receiveEndValue?	boolean	Whether receive the transition end coords or current. default is true

Returns

Vector3

Inherited from

CameraControls.getFocalOffset;

---

normalizeRotations()

normalizeRotations(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:696

Normalize camera azimuth angle rotation between 0 and 360 degrees.

Returns

void

Inherited from

CameraControls.normalizeRotations;

---

reset()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:706

Reset all rotation and position to defaults.

Parameters

Parameter	Type	Description
enableTransition?	boolean

Returns

Promise<void[]>

Inherited from

CameraControls.reset;

---

saveState()

saveState(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:711

Set current camera position as the default position.

Returns

void

Inherited from

CameraControls.saveState;

---

updateCameraUp()

updateCameraUp(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:717

Sync camera-up direction. When camera-up vector is changed, .updateCameraUp() must be called.

Returns

void

Inherited from

CameraControls.updateCameraUp;

---

applyCameraUp()

applyCameraUp(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:723

Apply current camera-up direction to the camera. The orbit system will be re-initialized with the current position.

Returns

void

Inherited from

CameraControls.applyCameraUp;

---

update()

update(delta: number): boolean

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:731

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

Parameters

Parameter	Type	Description
delta	number

Returns

boolean

updated

Inherited from

CameraControls.update;

---

toJSON()

toJSON(): string

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:736

Get all state in JSON string

Returns

string

Inherited from

CameraControls.toJSON;

---

fromJSON()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:743

Reproduce the control state with JSON. enableTransition is where anim or not in a boolean.

Parameters

Parameter	Type	Description
json	string
enableTransition?	boolean

Returns

void

Inherited from

CameraControls.fromJSON;

---

connect()

connect(domElement: HTMLElement): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:748

Attach all internal event handlers to enable drag control.

Parameters

Parameter	Type
domElement	HTMLElement

Returns

void

Inherited from

CameraControls.connect;

---

dispose()

dispose(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:757

Dispose the cameraControls instance itself, remove all eventListeners.

Returns

void

Inherited from

CameraControls.dispose;

---

hasEventListener()

hasEventListener(type: string, listener: Listener): boolean

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/EventDispatcher.d.ts:21

Presence of the specified event listener.

Parameters

Parameter	Type	Description
type	string	event name
listener	Listener	handler function

Returns

boolean

Inherited from

CameraControls.hasEventListener;

---

removeAllEventListeners()

removeAllEventListeners(type?: string): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/EventDispatcher.d.ts:34

Removes all event listeners

Parameters

Parameter	Type	Description
type?	string	event name

Returns

void

Inherited from

CameraControls.removeAllEventListeners;

---

dispatchEvent()

dispatchEvent(event: DispatcherEvent): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/EventDispatcher.d.ts:40

Fire an event type.

Parameters

Parameter	Type	Description
event	DispatcherEvent	DispatcherEvent

Returns

void

Inherited from

CameraControls.dispatchEvent;

Properties

minPolarAngle

minPolarAngle: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:23

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;

Inherited from

CameraControls.minPolarAngle;

---

maxPolarAngle

maxPolarAngle: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:35

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;

Inherited from

CameraControls.maxPolarAngle;

---

minAzimuthAngle

minAzimuthAngle: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:47

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

e.g.

cameraControls.minAzimuthAngle = - Infinity;

Inherited from

CameraControls.minAzimuthAngle;

---

maxAzimuthAngle

maxAzimuthAngle: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:59

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

e.g.

cameraControls.maxAzimuthAngle = Infinity;

Inherited from

CameraControls.maxAzimuthAngle;

---

minDistance

minDistance: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:65

Minimum distance for dolly. The value must be higher than 0. Default is Number.EPSILON. PerspectiveCamera only.

Inherited from

CameraControls.minDistance;

---

maxDistance

maxDistance: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:71

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

Inherited from

CameraControls.maxDistance;

---

infinityDolly

infinityDolly: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:77

true to enable Infinity Dolly for wheel and pinch. Use this with minDistance and maxDistance If the Dolly distance is less (or over) than the minDistance (or maxDistance), infinityDolly will keep the distance and pushes the target position instead.

Inherited from

CameraControls.infinityDolly;

---

minZoom

minZoom: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:82

Minimum camera zoom.

Inherited from

CameraControls.minZoom;

---

maxZoom

maxZoom: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:87

Maximum camera zoom.

Inherited from

CameraControls.maxZoom;

---

smoothTime

smoothTime: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:92

Approximate time in seconds to reach the target. A smaller value will reach the target faster.

Inherited from

CameraControls.smoothTime;

---

draggingSmoothTime

draggingSmoothTime: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:97

the smoothTime while dragging

Inherited from

CameraControls.draggingSmoothTime;

---

maxSpeed

maxSpeed: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:102

Max transition speed in unit-per-seconds

Inherited from

CameraControls.maxSpeed;

---

azimuthRotateSpeed

azimuthRotateSpeed: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:107

Speed of azimuth (horizontal) rotation.

Inherited from

CameraControls.azimuthRotateSpeed;

---

polarRotateSpeed

polarRotateSpeed: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:112

Speed of polar (vertical) rotation.

Inherited from

CameraControls.polarRotateSpeed;

---

dollySpeed

dollySpeed: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:117

Speed of mouse-wheel dollying.

Inherited from

CameraControls.dollySpeed;

---

dollyDragInverted

dollyDragInverted: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:122

true to invert direction when dollying or zooming via drag

Inherited from

CameraControls.dollyDragInverted;

---

truckSpeed

truckSpeed: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:127

Speed of drag for truck and pedestal.

Inherited from

CameraControls.truckSpeed;

---

scaleTruckSpeed

scaleTruckSpeed: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:132

Scale of the truck speed with target distance.

Inherited from

CameraControls.scaleTruckSpeed;

---

dollyToCursor

dollyToCursor: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:137

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

Inherited from

CameraControls.dollyToCursor;

---

dragToOffset

dragToOffset: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:141

Inherited from

CameraControls.dragToOffset;

---

boundaryFriction

boundaryFriction: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:146

Friction ratio of the boundary.

Inherited from

CameraControls.boundaryFriction;

---

restThreshold

restThreshold: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:151

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

Inherited from

CameraControls.restThreshold;

---

mouseButtons

mouseButtons: MouseButtons;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:170

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

1. Mouse wheel event for scroll "up/down" on mac "up/down/left/right"
2. 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.

Inherited from

CameraControls.mouseButtons;

---

touches

touches: Touches;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:186

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 | CameraControls.ACTION.ZOOM | CameraControls.ACTION.NONE | | touches.two | ACTION.TOUCH_DOLLY_TRUCK | ACTION.TOUCH_DOLLY_OFFSET | ACTION.TOUCH_DOLLY_ROTATE | ACTION.TOUCH_ZOOM_TRUCK | ACTION.TOUCH_ZOOM_OFFSET | ACTION.TOUCH_ZOOM_ROTATE | 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_DOLLY_ROTATE | ACTION.TOUCH_ZOOM_TRUCK | ACTION.TOUCH_ZOOM_OFFSET | ACTION.TOUCH_ZOOM_ROTATE | 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.

Inherited from

CameraControls.touches;

Other

invert_middle_button_dolly

invert_middle_button_dolly: boolean;

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:15

Invert the movement direction of the dolly action on middle button only

---

orbit_on_cursor

orbit_on_cursor: {
    enabled: boolean;
    cancel_target_offset: boolean;
}

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:20

Orbit on cursor options

Name	Type	Description
enabled	boolean	Enable for the rotate action to pick the orbit target on the pointer down
cancel_target_offset	boolean	Enable to use the previous target when none is picked to prevent target shift on truck and dolly actions.

Default

-{ enabled: false, cancel_target_offset: false };

---

lock_pointer

lock_pointer: {
    aim: LockMousePointerAim;
    on_drag_threshold_in_pixels: number;
}

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:30

Lock pointer options

Name	Type	Description
aim	LockMousePointerAim	Aim of the pointer lock
on_drag_threshold_in_pixels	number	Threshold in pixels of the pointer movement before to lock it when lock_pointer.aim = "on-drag"

Default

-{ aim: "off", on_drag_threshold_in_pixels: 0 };

---

init_options

init_options: Readonly<CameraControllerInitOptions>;

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:39

Set of options used by CameraController.initController

---

keyboard_fly_controls

keyboard_fly_controls: null | KeyboardFlyControls;

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:43

---

onViewportResize()

onViewportResize: () => void;

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:56

Returns

void

---

ACTION

readonly static ACTION: Readonly<{
  NONE: 0;
  ROTATE: 1;
  TRUCK: 2;
  SCREEN_PAN: 4;
  OFFSET: 8;
  DOLLY: 16;
  ZOOM: 32;
  TOUCH_ROTATE: 64;
  TOUCH_TRUCK: 128;
  TOUCH_SCREEN_PAN: 256;
  TOUCH_OFFSET: 512;
  TOUCH_DOLLY: 1024;
  TOUCH_ZOOM: 2048;
  TOUCH_DOLLY_TRUCK: 4096;
  TOUCH_DOLLY_SCREEN_PAN: 8192;
  TOUCH_DOLLY_OFFSET: 16384;
  TOUCH_DOLLY_ROTATE: 32768;
  TOUCH_ZOOM_TRUCK: 65536;
  TOUCH_ZOOM_OFFSET: 131072;
  TOUCH_ZOOM_SCREEN_PAN: 262144;
  TOUCH_ZOOM_ROTATE: 524288;
}>;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:11

Inherited from

CameraControls.ACTION;

---

_enabled

protected _enabled: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:204

Inherited from

CameraControls._enabled;

---

_camera

protected _camera: any;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:205

Inherited from

CameraControls._camera;

---

_yAxisUpSpace

protected _yAxisUpSpace: Quaternion;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:206

Inherited from

CameraControls._yAxisUpSpace;

---

_yAxisUpSpaceInverse

protected _yAxisUpSpaceInverse: Quaternion;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:207

Inherited from

CameraControls._yAxisUpSpaceInverse;

---

_state

protected _state: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:208

Inherited from

CameraControls._state;

---

_aspectRatio

protected _aspectRatio: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:209

Inherited from

CameraControls._aspectRatio;

---

_domElement?

protected optional _domElement: HTMLElement;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:210

Inherited from

CameraControls._domElement;

---

_viewport

protected _viewport: null | Vector4;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:211

Inherited from

CameraControls._viewport;

---

_target

protected _target: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:212

Inherited from

CameraControls._target;

---

_targetEnd

protected _targetEnd: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:213

Inherited from

CameraControls._targetEnd;

---

_focalOffset

protected _focalOffset: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:214

Inherited from

CameraControls._focalOffset;

---

_focalOffsetEnd

protected _focalOffsetEnd: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:215

Inherited from

CameraControls._focalOffsetEnd;

---

_spherical

protected _spherical: Spherical;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:216

Inherited from

CameraControls._spherical;

---

_sphericalEnd

protected _sphericalEnd: Spherical;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:217

Inherited from

CameraControls._sphericalEnd;

---

_lastDistance

protected _lastDistance: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:218

Inherited from

CameraControls._lastDistance;

---

_zoom

protected _zoom: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:219

Inherited from

CameraControls._zoom;

---

_zoomEnd

protected _zoomEnd: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:220

Inherited from

CameraControls._zoomEnd;

---

_lastZoom

protected _lastZoom: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:221

Inherited from

CameraControls._lastZoom;

---

_cameraUp0

protected _cameraUp0: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:222

Inherited from

CameraControls._cameraUp0;

---

_target0

protected _target0: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:223

Inherited from

CameraControls._target0;

---

_position0

protected _position0: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:224

Inherited from

CameraControls._position0;

---

_zoom0

protected _zoom0: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:225

Inherited from

CameraControls._zoom0;

---

_focalOffset0

protected _focalOffset0: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:226

Inherited from

CameraControls._focalOffset0;

---

_dollyControlCoord

protected _dollyControlCoord: Vector2;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:227

Inherited from

CameraControls._dollyControlCoord;

---

_changedDolly

protected _changedDolly: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:228

Inherited from

CameraControls._changedDolly;

---

_changedZoom

protected _changedZoom: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:229

Inherited from

CameraControls._changedZoom;

---

_nearPlaneCorners

protected _nearPlaneCorners: [Vector3, Vector3, Vector3, Vector3];

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:230

Inherited from

CameraControls._nearPlaneCorners;

---

_hasRested

protected _hasRested: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:236

Inherited from

CameraControls._hasRested;

---

_boundary

protected _boundary: Box3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:237

Inherited from

CameraControls._boundary;

---

_boundaryEnclosesCamera

protected _boundaryEnclosesCamera: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:238

Inherited from

CameraControls._boundaryEnclosesCamera;

---

_needsUpdate

protected _needsUpdate: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:239

Inherited from

CameraControls._needsUpdate;

---

_updatedLastTime

protected _updatedLastTime: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:240

Inherited from

CameraControls._updatedLastTime;

---

_elementRect

protected _elementRect: DOMRect;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:241

Inherited from

CameraControls._elementRect;

---

_isDragging

protected _isDragging: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:242

Inherited from

CameraControls._isDragging;

---

_dragNeedsUpdate

protected _dragNeedsUpdate: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:243

Inherited from

CameraControls._dragNeedsUpdate;

---

_activePointers

protected _activePointers: PointerInput[];

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:244

Inherited from

CameraControls._activePointers;

---

_lockedPointer

protected _lockedPointer: null | PointerInput;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:245

Inherited from

CameraControls._lockedPointer;

---

_interactiveArea

protected _interactiveArea: DOMRect;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:246

Inherited from

CameraControls._interactiveArea;

---

_isUserControllingRotate

protected _isUserControllingRotate: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:247

Inherited from

CameraControls._isUserControllingRotate;

---

_isUserControllingDolly

protected _isUserControllingDolly: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:248

Inherited from

CameraControls._isUserControllingDolly;

---

_isUserControllingTruck

protected _isUserControllingTruck: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:249

Inherited from

CameraControls._isUserControllingTruck;

---

_isUserControllingOffset

protected _isUserControllingOffset: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:250

Inherited from

CameraControls._isUserControllingOffset;

---

_isUserControllingZoom

protected _isUserControllingZoom: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:251

Inherited from

CameraControls._isUserControllingZoom;

---

_lastDollyDirection

protected _lastDollyDirection: DOLLY_DIRECTION;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:252

Inherited from

CameraControls._lastDollyDirection;

---

_thetaVelocity

protected _thetaVelocity: Ref;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:253

Inherited from

CameraControls._thetaVelocity;

---

_phiVelocity

protected _phiVelocity: Ref;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:254

Inherited from

CameraControls._phiVelocity;

---

_radiusVelocity

protected _radiusVelocity: Ref;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:255

Inherited from

CameraControls._radiusVelocity;

---

_targetVelocity

protected _targetVelocity: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:256

Inherited from

CameraControls._targetVelocity;

---

_focalOffsetVelocity

protected _focalOffsetVelocity: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:257

Inherited from

CameraControls._focalOffsetVelocity;

---

_zoomVelocity

protected _zoomVelocity: Ref;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:258

Inherited from

CameraControls._zoomVelocity;

---

position

readonly position: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:280

Inherited from

CameraControls.position;

---

orientation

readonly orientation: Quaternion;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:284

Inherited from

CameraControls.orientation;

---

direction

readonly direction: Vector3;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:288

Inherited from

CameraControls.direction;

---

aspectRatio

aspectRatio: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:296

Inherited from

CameraControls.aspectRatio;

---

enabled

enabled: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:302

Inherited from

CameraControls.enabled;

---

active

readonly active: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:308

Inherited from

CameraControls.active;

---

currentAction

readonly currentAction: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:314

Inherited from

CameraControls.currentAction;

---

distance

distance: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:319

Inherited from

CameraControls.distance;

---

azimuthAngle

azimuthAngle: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:325

Inherited from

CameraControls.azimuthAngle;

---

polarAngle

polarAngle: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:330

Inherited from

CameraControls.polarAngle;

---

boundaryEnclosesCamera

boundaryEnclosesCamera: boolean;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:335

Inherited from

CameraControls.boundaryEnclosesCamera;

---

interactiveArea

interactiveArea:
  | DOMRect
  | {
  x: number;
  y: number;
  width: number;
  height: number;
};

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:342

Inherited from

CameraControls.interactiveArea;

---

getTargetDistance()

getTargetDistance: () => number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:765

Returns

number

Inherited from

CameraControls.getTargetDistance;

---

_truckInternal()

protected _truckInternal: (deltaX: number, deltaY: number, dragToOffset: boolean, screenSpacePanning: boolean) => void;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:766

Parameters

Parameter	Type
deltaX	number
deltaY	number
dragToOffset	boolean
screenSpacePanning	boolean

Returns

void

Inherited from

CameraControls._truckInternal;

---

_rotateInternal()

protected _rotateInternal: (deltaX: number, deltaY: number) => void;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:767

Parameters

Parameter	Type
deltaX	number
deltaY	number

Returns

void

Inherited from

CameraControls._rotateInternal;

---

_dollyInternal()

protected _dollyInternal: (delta: number, x: number, y: number) => void;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:768

Parameters

Parameter	Type
delta	number
x	number
y	number

Returns

void

Inherited from

CameraControls._dollyInternal;

---

_zoomInternal()

protected _zoomInternal: (delta: number, x: number, y: number) => void;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:769

Parameters

Parameter	Type
delta	number
x	number
y	number

Returns

void

Inherited from

CameraControls._zoomInternal;

---

dampingFactor

dampingFactor: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:787

Inherited from

CameraControls.dampingFactor;

---

draggingDampingFactor

draggingDampingFactor: number;

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:798

Inherited from

CameraControls.draggingDampingFactor;

---

release()

release(): void

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:60

Returns

void

---

activate()

activate(): void

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:64

Returns

void

---

deactivate()

deactivate(): void

Defined in: livelink.js/dist/sources/rendering/camera/CameraController.d.ts:68

Returns

void

---

updateTransform()

updateTransform(position: Vec3, orientation: Quat): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:292

Updates the camera local position and local orientation.

Parameters

Parameter	Type
position	Vec3
orientation	Quat

Returns

void

Inherited from

CameraControls.updateTransform;

---

_dollyToNoClamp()

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

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:471

Parameters

Parameter	Type
distance	number
enableTransition?	boolean

Returns

Promise<void>

Inherited from

CameraControls._dollyToNoClamp;

---

stop()

stop(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:700

stop all transitions.

Returns

void

Inherited from

CameraControls.stop;

---

disconnect()

disconnect(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:752

Detach all internal event handlers to disable drag control.

Returns

void

Inherited from

CameraControls.disconnect;

---

_getTargetDirection()

protected _getTargetDirection(out: Vector3): Vector3

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:758

Parameters

Parameter	Type
out	Vector3

Returns

Vector3

Inherited from

CameraControls._getTargetDirection;

---

_getCameraDirection()

protected _getCameraDirection(out: Vector3): Vector3

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:759

Parameters

Parameter	Type
out	Vector3

Returns

Vector3

Inherited from

CameraControls._getCameraDirection;

---

_findPointerById()

protected _findPointerById(pointerId: number): undefined | PointerInput

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:760

Parameters

Parameter	Type
pointerId	number

Returns

undefined | PointerInput

Inherited from

CameraControls._findPointerById;

---

_findPointerByMouseButton()

protected _findPointerByMouseButton(mouseButton: MOUSE_BUTTON): undefined | PointerInput

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:761

Parameters

Parameter	Type
mouseButton	MOUSE_BUTTON

Returns

undefined | PointerInput

Inherited from

CameraControls._findPointerByMouseButton;

---

_disposePointer()

protected _disposePointer(pointer: PointerInput): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:762

Parameters

Parameter	Type
pointer	PointerInput

Returns

void

Inherited from

CameraControls._disposePointer;

---

_encloseToBoundary()

protected _encloseToBoundary(
   position: Vector3,
   offset: Vector3,
   friction: number): Vector3

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:763

Parameters

Parameter	Type
position	Vector3
offset	Vector3
friction	number

Returns

Vector3

Inherited from

CameraControls._encloseToBoundary;

---

_updateNearPlaneCorners()

protected _updateNearPlaneCorners(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:764

Returns

void

Inherited from

CameraControls._updateNearPlaneCorners;

---

_getClientRect()

protected _getClientRect(target: DOMRect): undefined | DOMRect

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:773

Get its client rect and package into given DOMRect .

Parameters

Parameter	Type
target	DOMRect

Returns

undefined | DOMRect

Inherited from

CameraControls._getClientRect;

---

_createOnRestPromise()

protected _createOnRestPromise(resolveImmediately: boolean): Promise<void>

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:774

Parameters

Parameter	Type
resolveImmediately	boolean

Returns

Promise<void>

Inherited from

CameraControls._createOnRestPromise;

---

_addAllEventListeners()

protected _addAllEventListeners(_domElement: HTMLElement): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:775

Parameters

Parameter	Type
_domElement	HTMLElement

Returns

void

Inherited from

CameraControls._addAllEventListeners;

---

_removeAllEventListeners()

protected _removeAllEventListeners(): void

Defined in: node_modules/@3dverse/livelink-camera-controls/dist/CameraControls.d.ts:776

Returns

void

Inherited from

CameraControls._removeAllEventListeners;