Class: ComboControls

@cognite/reveal.ComboControls

Hierarchy

• EventDispatcher<ComboControlsEventType>

  ↳ ComboControls

Constructors

constructor

• new ComboControls(camera, domElement): ComboControls

Parameters

Name	Type
camera	PerspectiveCamera | OrthographicCamera
domElement	HTMLElement

Returns

ComboControls

Overrides

EventDispatcher\<ComboControlsEventType\>.constructor

Defined in

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

Properties

dispose

• dispose: () => void

Type declaration

▸ (): void

Returns

void

Defined in

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

Accessors

cameraRawRotation

• 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 enabled(): boolean

Returns true if these controls are enabled.

Returns

boolean

Defined in

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

• set enabled(newEnabledValue): void

Sets the enabled state of these controls.

Parameters

Name	Type
newEnabledValue	boolean

Returns

void

Defined in

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

---

options

• get options(): Readonly<ComboControlsOptions>

Gets current Combo Controls options.

Returns

Readonly<ComboControlsOptions>

Defined in

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

• set options(options): void

Sets Combo Controls options.

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

Parameters

Name	Type
options	Partial<ComboControlsOptions>

Returns

void

Defined in

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

Methods

getScrollTarget

▸ getScrollTarget(): Vector3

Returns

Vector3

Defined in

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

---

getState

▸ getState(): Object

Returns

Object

Name	Type
position	Vector3
target	Vector3

Defined in

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

---

setScrollTarget

▸ setScrollTarget(target): void

Parameters

Name	Type
target	Vector3

Returns

void

Defined in

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

---

setState

▸ setState(position, target): void

Parameters

Name	Type
position	Vector3
target	Vector3

Returns

void

Defined in

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

---

setViewTarget

▸ setViewTarget(target): void

Parameters

Name	Type
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

Name	Type	Default value
deltaTimeS	number	undefined
forceUpdate	boolean	false

Returns

boolean

Defined in

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