CameraOrbitOperator

class Operators.Camera.CameraOrbitOperator()

Methods

addMapping

CameraOrbitOperator.addMapping(button, modifier)

Arguments

button (Button()) – None
modifier (KeyModifiers()) – None

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.

Return type: void

clearMapping

CameraOrbitOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

getBimOrbitEnabled

CameraOrbitOperator.getBimOrbitEnabled()

Returns true if BIM orbit is enabled.

Return type: boolean

getCameraRotationMomentumEnabled

CameraOrbitOperator.getCameraRotationMomentumEnabled()

Return type: boolean

getMomentum

CameraOrbitOperator.getMomentum()

Return type: number

getMomentumLossPerSecond

CameraOrbitOperator.getMomentumLossPerSecond()

Return type: number

getOrbitFallbackMode

CameraOrbitOperator.getOrbitFallbackMode()

Gets the orbit fallback mode.

Returns: orbit fallback mode
Return type: OrbitFallbackMode

getOrbitTarget

CameraOrbitOperator.getOrbitTarget()

Gets the orbit target point.

Returns: orbit target
Return type: Point3

getPrimaryButton

CameraOrbitOperator.getPrimaryButton()

Returns: the primary orbit button
Return type: Button

isAnimating

CameraOrbitOperator.isAnimating()

Return type: boolean

isCurrentlyAnimating

CameraOrbitOperator.isCurrentlyAnimating()

Return type: boolean

setBimOrbitEnabled

CameraOrbitOperator.setBimOrbitEnabled(bimOrbitEnabled)

Arguments

bimOrbitEnabled (boolean()) – None

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.

Return type: void

setCameraRotationMomentumEnabled

CameraOrbitOperator.setCameraRotationMomentumEnabled(val)

Arguments

val (boolean()) – None

Return type

void

setMapping

CameraOrbitOperator.setMapping(button, modifier)

Arguments

button (Button()) – None
modifier (KeyModifiers()) – None

Sets the button and key modifier mapping for the operator.

Return type: void

setMomentumLossPerSecond

CameraOrbitOperator.setMomentumLossPerSecond(amountLost)

Arguments

amountLost (number()) – Proportion of momentum lost per second

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.

Return type: void

setOrbitFallbackMode

CameraOrbitOperator.setOrbitFallbackMode(fallbackMode)

Arguments

fallbackMode (OrbitFallbackMode()) – None

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

Return type: void

setOrbitTarget

CameraOrbitOperator.setOrbitTarget(orbitTarget)

Arguments

orbitTarget (Point3()) – None

Sets the orbit target for the orbit fallback mode OrbitTarget.

Return type: void

setPrimaryButton

CameraOrbitOperator.setPrimaryButton(button)

Arguments

button (Button()) – None

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.

Return type: void

stopAnimation

CameraOrbitOperator.stopAnimation()

Return type: void

supportsAnimation

CameraOrbitOperator.supportsAnimation()

Return type: boolean