CameraOrbitOperator
- class Communicator.Operator.CameraOrbitOperator()
Type aliases
Methods
Methods
addMapping
- Communicator.Operator.CameraOrbitOperator.addMapping(button, modifier)
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.
- Arguments
button (
Communicator.Button()) –modifier (
Communicator.KeyModifiers()) –
- Return type
void
clearMapping
- Communicator.Operator.CameraOrbitOperator.clearMapping()
Clears any button and key modifier mappings for the operator.
- Return type
void
getBimOrbitEnabled
- Communicator.Operator.CameraOrbitOperator.getBimOrbitEnabled()
Returns true if BIM orbit is enabled.
- Return type
boolean
getCameraRotationMomentumEnabled
- Communicator.Operator.CameraOrbitOperator.getCameraRotationMomentumEnabled()
- Return type
boolean
getMomentumLossPerSecond
- Communicator.Operator.CameraOrbitOperator.getMomentumLossPerSecond()
- Return type
number
getOrbitFallbackMode
- Communicator.Operator.CameraOrbitOperator.getOrbitFallbackMode()
Gets the orbit fallback mode.
- Return type
Communicator.OrbitFallbackMode- Returns
orbit fallback mode
getOrbitTarget
- Communicator.Operator.CameraOrbitOperator.getOrbitTarget()
Gets the orbit target point.
- Return type
Communicator.Point3- Returns
orbit target
getPrimaryButton
- Communicator.Operator.CameraOrbitOperator.getPrimaryButton()
- Return type
Communicator.Button- Returns
the primary orbit button
isCurrentlyAnimating
- Communicator.Operator.CameraOrbitOperator.isCurrentlyAnimating()
- Return type
boolean
setBimOrbitEnabled
- Communicator.Operator.CameraOrbitOperator.setBimOrbitEnabled(bimOrbitEnabled)
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.
- Arguments
bimOrbitEnabled (
boolean()) –
- Return type
void
setCameraRotationMomentumEnabled
- Communicator.Operator.CameraOrbitOperator.setCameraRotationMomentumEnabled(val)
- Arguments
val (
boolean()) –
- Return type
void
setMapping
- Communicator.Operator.CameraOrbitOperator.setMapping(button, modifier)
Sets the button and key modifier mapping for the operator.
- Arguments
button (
Communicator.Button()) –modifier (
Communicator.KeyModifiers()) –
- Return type
void
setMomentumLossPerSecond
- Communicator.Operator.CameraOrbitOperator.setMomentumLossPerSecond(amountLost)
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.
- Arguments
amountLost (
number()) – Proportion of momentum lost per second
- Return type
void
setOrbitFallbackMode
- Communicator.Operator.CameraOrbitOperator.setOrbitFallbackMode(fallbackMode)
Sets the fallback mode. This is used to specify whether to orbit around a set target, the model center, or camera target.
- Arguments
fallbackMode (
Communicator.OrbitFallbackMode()) –
- Return type
void
setOrbitTarget
- Communicator.Operator.CameraOrbitOperator.setOrbitTarget(orbitTarget)
Sets the orbit target for the orbit fallback mode OrbitTarget.
- Arguments
orbitTarget (
Communicator.Point3()) –
- Return type
void
setPrimaryButton
- Communicator.Operator.CameraOrbitOperator.setPrimaryButton(button)
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.
- Arguments
button (
Communicator.Button()) –
- Return type
void
