Skip to main content
Version: Next

Class: ComboControls

Extends

Constructors

new ComboControls()

new ComboControls(camera, domElement): ComboControls

Parameters

camera: PerspectiveCamera | OrthographicCamera

domElement: HTMLElement

Returns

ComboControls

Overrides

EventDispatcher<ComboControlsEventType>.constructor

Defined in

packages/camera-manager/src/ComboControls.ts:68

Properties

dispose()

dispose: () => void

Returns

void

Defined in

packages/camera-manager/src/ComboControls.ts:38

Accessors

cameraRawRotation

Get Signature

get cameraRawRotation(): Quaternion

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

Defined in

packages/camera-manager/src/ComboControls.ts:130


enabled

Get Signature

get enabled(): boolean

Returns true if these controls are enabled.

Returns

boolean

Set Signature

set enabled(newEnabledValue): void

Sets the enabled state of these controls.

Parameters

newEnabledValue: boolean

Returns

void

Defined in

packages/camera-manager/src/ComboControls.ts:108


options

Get Signature

get options(): Readonly<ComboControlsOptions>

Gets current Combo Controls options.

Returns

Readonly<ComboControlsOptions>

Set Signature

set options(options): void

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

Defined in

packages/camera-manager/src/ComboControls.ts:92

Methods

getScrollTarget()

getScrollTarget(): Vector3

Returns

Vector3

Defined in

packages/camera-manager/src/ComboControls.ts:138


getState()

getState(): object

Returns

object

position

position: Vector3

target

target: Vector3

Defined in

packages/camera-manager/src/ComboControls.ts:142


setScrollTarget()

setScrollTarget(target): void

Parameters

target: Vector3

Returns

void

Defined in

packages/camera-manager/src/ComboControls.ts:149


setState()

setState(position, target): void

Parameters

position: Vector3

target: Vector3

Returns

void

Defined in

packages/camera-manager/src/ComboControls.ts:153


setViewTarget()

setViewTarget(target): void

Parameters

target: Vector3

Returns

void

Defined in

packages/camera-manager/src/ComboControls.ts:164


triggerCameraChangeEvent()

triggerCameraChangeEvent(): void

Returns

void

Defined in

packages/camera-manager/src/ComboControls.ts:260


update()

update(deltaTimeS, forceUpdate): boolean

Parameters

deltaTimeS: number

forceUpdate: boolean = false

Returns

boolean

Defined in

packages/camera-manager/src/ComboControls.ts:197