Skip to main content
Version: 3.x

Class: ComboControls

@cognite/reveal.ComboControls

Hierarchy

  • EventDispatcher

    ComboControls

Constructors

constructor

new ComboControls(camera, domElement)

Parameters

NameType
cameraPerspectiveCamera | OrthographicCamera
domElementHTMLElement

Overrides

EventDispatcher.constructor

Defined in

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

Properties

EPSILON

EPSILON: number = 0.001

Defined in

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


dampingFactor

dampingFactor: number = 0.25

Defined in

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


dispose

dispose: () => void

Type declaration

▸ (): void

Returns

void

Defined in

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


dollyFactor

dollyFactor: number = 0.99

Defined in

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


dynamicTarget

dynamicTarget: boolean = true

Defined in

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


enableDamping

enableDamping: boolean = true

Defined in

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


enableKeyboardNavigation

enableKeyboardNavigation: boolean = true

Defined in

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


enabled

enabled: boolean = true

Defined in

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


firstPersonRotationFactor

firstPersonRotationFactor: number = 0.4

Defined in

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


keyboardDollySpeed

keyboardDollySpeed: number = 2

Defined in

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


keyboardPanSpeed

keyboardPanSpeed: number = 10

Defined in

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


keyboardRotationSpeedAzimuth

keyboardRotationSpeedAzimuth: number = defaultKeyboardRotationSpeed

Defined in

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


keyboardRotationSpeedPolar

keyboardRotationSpeedPolar: number = defaultKeyboardRotationSpeed

Defined in

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


keyboardSpeedFactor

keyboardSpeedFactor: number = 3

Defined in

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


lookAtViewTarget

lookAtViewTarget: boolean = false

Defined in

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


maxAzimuthAngle

maxAzimuthAngle: number = Infinity

Defined in

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


maxDeltaDownscaleCoefficient

maxDeltaDownscaleCoefficient: number = 1

Defined in

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


maxDeltaRatio

maxDeltaRatio: number = 8

Defined in

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


maxPolarAngle

maxPolarAngle: number = Math.PI

Defined in

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


maxZoom

maxZoom: number = Infinity

Defined in

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


minAzimuthAngle

minAzimuthAngle: number = -Infinity

Defined in

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


minDeltaDownscaleCoefficient

minDeltaDownscaleCoefficient: number = 0.1

Defined in

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


minDeltaRatio

minDeltaRatio: number = 1

Defined in

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


minDistance

minDistance: number = 0.8

Defined in

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


minPolarAngle

minPolarAngle: number = 0

Defined in

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


minZoom

minZoom: number = 0

Defined in

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


minZoomDistance

minZoomDistance: number = 0.4

Defined in

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


mouseFirstPersonRotationSpeed

mouseFirstPersonRotationSpeed: number

Defined in

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


orthographicCameraDollyFactor

orthographicCameraDollyFactor: number = 0.3

Defined in

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


panDollyMinDistanceFactor

panDollyMinDistanceFactor: number = 10.0

Defined in

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


pinchEpsilon

pinchEpsilon: number = 2

Defined in

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


pinchPanSpeed

pinchPanSpeed: number = 1

Defined in

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


pointerRotationSpeedAzimuth

pointerRotationSpeedAzimuth: number = defaultPointerRotationSpeed

Defined in

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


pointerRotationSpeedPolar

pointerRotationSpeedPolar: number = defaultPointerRotationSpeed

Defined in

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


useScrollTarget

useScrollTarget: boolean = false

Defined in

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


zoomToCursor

zoomToCursor: boolean = true

Defined in

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

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:258

Methods

getScrollTarget

getScrollTarget(): Vector3

Returns

Vector3

Defined in

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


getState

getState(): Object

Returns

Object

NameType
positionVector3
targetVector3

Defined in

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


setScrollTarget

setScrollTarget(target): void

Parameters

NameType
targetVector3

Returns

void

Defined in

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


setState

setState(position, target): void

Parameters

NameType
positionVector3
targetVector3

Returns

void

Defined in

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


setViewTarget

setViewTarget(target): void

Parameters

NameType
targetVector3

Returns

void

Defined in

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


triggerCameraChangeEvent

triggerCameraChangeEvent(): void

Returns

void

Defined in

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


update

update(deltaTime, forceUpdate?): boolean

Parameters

NameTypeDefault value
deltaTimenumberundefined
forceUpdatebooleanfalse

Returns

boolean

Defined in

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