Class: ComboControls
@cognite/reveal.ComboControls
Hierarchy
EventDispatcher↳
ComboControls
Constructors
constructor
• new ComboControls(camera, domElement)
Parameters
| Name | Type |
|---|---|
camera | PerspectiveCamera | OrthographicCamera |
domElement | HTMLElement |
Overrides
EventDispatcher.constructor
Defined in
packages/camera-manager/src/ComboControls.ts:218
Properties
dispose
• dispose: () => void
Type declaration
▸ (): void
Returns
void
Defined in
packages/camera-manager/src/ComboControls.ts:115
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:337
enabled
• get enabled(): boolean
Returns true if these controls are enabled.
Returns
boolean
Defined in
packages/camera-manager/src/ComboControls.ts:200
• 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:207
options
• get options(): Readonly<ComboControlsOptions>
Gets current Combo Controls options.
Returns
Readonly<ComboControlsOptions>
Defined in
packages/camera-manager/src/ComboControls.ts:184
• 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:193
Methods
getScrollTarget
▸ getScrollTarget(): Vector3
Returns
Vector3
Defined in
packages/camera-manager/src/ComboControls.ts:350
getState
▸ getState(): Object
Returns
Object
| Name | Type |
|---|---|
position | Vector3 |
target | Vector3 |
Defined in
packages/camera-manager/src/ComboControls.ts:312
setScrollTarget
▸ setScrollTarget(target): void
Parameters
| Name | Type |
|---|---|
target | Vector3 |
Returns
void
Defined in
packages/camera-manager/src/ComboControls.ts:346
setState
▸ setState(position, target): void
Parameters
| Name | Type |
|---|---|
position | Vector3 |
target | Vector3 |
Returns
void
Defined in
packages/camera-manager/src/ComboControls.ts:320
setViewTarget
▸ setViewTarget(target): void
Parameters
| Name | Type |
|---|---|
target | Vector3 |
Returns
void
Defined in
packages/camera-manager/src/ComboControls.ts:341
triggerCameraChangeEvent
▸ triggerCameraChangeEvent(): void
Returns
void
Defined in
packages/camera-manager/src/ComboControls.ts:354
update
▸ update(deltaTime, forceUpdate?): boolean
Parameters
| Name | Type | Default value |
|---|---|---|
deltaTime | number | undefined |
forceUpdate | boolean | false |
Returns
boolean