CameraOrbitOperator

class Operators.Camera.CameraOrbitOperator()

Methods

Operators.Camera.CameraOrbitOperator.addMapping()

inherited

addMapping(button: Button, modifier: KeyModifiers?): void

Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid. All mappings require a mouse button, but a key modifier is optional.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.Camera.CameraOrbitOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

Operators.Camera.CameraOrbitOperator.getBimOrbitEnabled()
getBimOrbitEnabled(): boolean

Returns true if BIM orbit is enabled.

Returns: boolean

Operators.Camera.CameraOrbitOperator.getCameraRotationMomentumEnabled()

inherited

getCameraRotationMomentumEnabled(): boolean

Returns: boolean

Operators.Camera.CameraOrbitOperator.getMomentum()

inherited

getMomentum(): number

Returns: number

Operators.Camera.CameraOrbitOperator.getMomentumLossPerSecond()

inherited

getMomentumLossPerSecond(): number

Returns: number

Operators.Camera.CameraOrbitOperator.getOrbitFallbackMode()
getOrbitFallbackMode(): OrbitFallbackMode

Gets the orbit fallback mode.

Returns: OrbitFallbackMode

orbit fallback mode
Operators.Camera.CameraOrbitOperator.getOrbitTarget()
getOrbitTarget(): Point3

Gets the orbit target point.

Returns: Point3

orbit target
Operators.Camera.CameraOrbitOperator.getPrimaryButton()
getPrimaryButton(): Button

Returns: Button

the primary orbit button
Operators.Camera.CameraOrbitOperator.isAnimating()

inherited

isAnimating(): boolean

Returns: boolean

Operators.Camera.CameraOrbitOperator.isCurrentlyAnimating()

inherited

isCurrentlyAnimating(): boolean

Returns: boolean

Operators.Camera.CameraOrbitOperator.setBimOrbitEnabled()
setBimOrbitEnabled(bimOrbitEnabled: boolean): void

BIM orbit is intended to make orbiting building models easier. It slows the rotation speed, clamps vertical rotation to 180 degrees, and restricts horizontal rotation to rotate around the vertical axis.

Parameters

bimOrbitEnabled: boolean

Returns: void

Operators.Camera.CameraOrbitOperator.setCameraRotationMomentumEnabled()

inherited

setCameraRotationMomentumEnabled(val: boolean): void

Parameters

val: boolean

Returns: void

Operators.Camera.CameraOrbitOperator.setMapping()

inherited

setMapping(button: Button, modifier: KeyModifiers?): void

Sets the button and key modifier mapping for the operator.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.Camera.CameraOrbitOperator.setMomentumLossPerSecond()

inherited

setMomentumLossPerSecond(amountLost: number): void

Sets proportion of momentum lost per second if camera rotation momentum is enabled. At 0 no momentum is lost and the camera will orbit indefinitely. Above 1 the camera will stop orbiting within a second of release. Only values greater than or equal to 0 are accepted.

Parameters

amountLost: number

Proportion of momentum lost per second

Returns: void

Operators.Camera.CameraOrbitOperator.setOrbitFallbackMode()
setOrbitFallbackMode(fallbackMode: OrbitFallbackMode): void

Sets the fallback mode. This is used to specify whether to orbit around a set target, the model center, or camera target.

Parameters

fallbackMode: OrbitFallbackMode

Returns: void

Operators.Camera.CameraOrbitOperator.setOrbitTarget()
setOrbitTarget(orbitTarget: Point3): void

Sets the orbit target for the orbit fallback mode OrbitTarget.

Parameters

orbitTarget: Point3

Returns: void

Operators.Camera.CameraOrbitOperator.setPrimaryButton()
setPrimaryButton(button: Button): void

Sets the primary mouse button. When this button is pressed, we will orbit around the selected point on the model. If there is no selected point, the orbit fallback mode will be used for orbit.

Parameters

button: Button

Returns: void

Operators.Camera.CameraOrbitOperator.stopAnimation()

inherited

stopAnimation(): void

Returns: void

Operators.Camera.CameraOrbitOperator.supportsAnimation()

inherited

supportsAnimation(): boolean

Returns: boolean