Skip to main content
Version: Next

Class: ComboControls

Defined in: packages/camera-manager/src/ComboControls.ts:32

Extends​

Constructors​

Constructor​

new ComboControls(camera, domElement): ComboControls

Defined in: packages/camera-manager/src/ComboControls.ts:67

Parameters​

camera​

PerspectiveCamera | OrthographicCamera

domElement​

HTMLElement

Returns​

ComboControls

Overrides​

EventDispatcher<ComboControlsEventType>.constructor

Properties​

dispose​

dispose: () => void

Defined in: packages/camera-manager/src/ComboControls.ts:37

Returns​

void

Accessors​

cameraRawRotation​

Get Signature​

get cameraRawRotation(): Quaternion

Defined in: packages/camera-manager/src/ComboControls.ts:129

Camera rotation to be used by the camera instead of target-based rotation. This rotation is used only when set to non-default quaternion value (not identity rotation quaternion). Externally, value is updated by CameraManager when setState method with non-zero rotation is called. Automatically resets to default value when setState method is called with no rotation value.

Returns​

Quaternion

enabled​

Get Signature​

get enabled(): boolean

Defined in: packages/camera-manager/src/ComboControls.ts:107

Returns true if these controls are enabled.

Returns​

boolean

Set Signature​

set enabled(newEnabledValue): void

Defined in: packages/camera-manager/src/ComboControls.ts:114

Sets the enabled state of these controls.

Parameters​
newEnabledValue​

boolean

Returns​

void

options​

Get Signature​

get options(): Readonly<ComboControlsOptions>

Defined in: packages/camera-manager/src/ComboControls.ts:91

Gets current Combo Controls options.

Returns​

Readonly<ComboControlsOptions>

Set Signature​

set options(options): void

Defined in: packages/camera-manager/src/ComboControls.ts:100

Sets Combo Controls options.

Only the provided options will be changed, any undefined options will be kept as is.

Parameters​
options​

Partial<ComboControlsOptions>

Returns​

void

Methods​

getScrollTarget()​

getScrollTarget(): Vector3

Defined in: packages/camera-manager/src/ComboControls.ts:137

Returns​

Vector3

getState()​

getState(): object

Defined in: packages/camera-manager/src/ComboControls.ts:141

Returns​

object

position​

position: Vector3

target​

target: Vector3

setScrollTarget()​

setScrollTarget(target): void

Defined in: packages/camera-manager/src/ComboControls.ts:151

Parameters​

target​

Vector3

Returns​

void

setState()​

setState(position, target): void

Defined in: packages/camera-manager/src/ComboControls.ts:155

Parameters​

position​

Vector3

target​

Vector3

Returns​

void

setViewTarget()​

setViewTarget(target): void

Defined in: packages/camera-manager/src/ComboControls.ts:166

Parameters​

target​

Vector3

Returns​

void

triggerCameraChangeEvent()​

triggerCameraChangeEvent(): void

Defined in: packages/camera-manager/src/ComboControls.ts:262

Returns​

void

update()​

update(deltaTimeS, forceUpdate?): boolean

Defined in: packages/camera-manager/src/ComboControls.ts:199

Parameters​

deltaTimeS​

number

forceUpdate?​

boolean = false

Returns​

boolean