CameraOrbitOperator

class Communicator.Operator.CameraOrbitOperator()

Type aliases

Methods

Type aliases

CameraRotateFunction

Methods

addMapping

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
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.

Return type

OrbitFallbackMode

Returns

orbit fallback mode

getOrbitTarget

CameraOrbitOperator.getOrbitTarget()

Gets the orbit target point.

Return type

Point3()

Returns

orbit target

getPrimaryButton

CameraOrbitOperator.getPrimaryButton()
Return type

Button

Returns

the primary orbit button

isAnimating

CameraOrbitOperator.isAnimating()
Return type

boolean

isCurrentlyAnimating

CameraOrbitOperator.isCurrentlyAnimating()
Return type

boolean

setBimOrbitEnabled

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

CameraOrbitOperator.setCameraRotationMomentumEnabled(val)
Arguments

  • val (boolean()) –

Return type

void

setMapping

CameraOrbitOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments
Return type

void

setMomentumLossPerSecond

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

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
Return type

void

setOrbitTarget

CameraOrbitOperator.setOrbitTarget(orbitTarget)

Sets the orbit target for the orbit fallback mode OrbitTarget.

Arguments
Return type

void

setPrimaryButton

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
Return type

void

stopAnimation

CameraOrbitOperator.stopAnimation()
Return type

void

supportsAnimation

CameraOrbitOperator.supportsAnimation()
Return type

boolean