CameraTurntableOperator

class Communicator.Operator.CameraTurntableOperator()

Type aliases

CameraRotateFunction

Methods

addMapping()
clearMapping()
getCameraRotationMomentumEnabled()
getMomentum()
getMomentumLossPerSecond()
isAnimating()
isCurrentlyAnimating()
setCameraRotationMomentumEnabled()
setMapping()
setMomentumLossPerSecond()
setRotationAxis()
stopAnimation()
supportsAnimation()

Type aliases

CameraRotateFunction

Methods

addMapping

CameraTurntableOperator.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 (Button) –
modifier (KeyModifiers) – optional

Return type

void

clearMapping

CameraTurntableOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

getCameraRotationMomentumEnabled

CameraTurntableOperator.getCameraRotationMomentumEnabled()

Return type: boolean

getMomentum

CameraTurntableOperator.getMomentum()

Return type: number

getMomentumLossPerSecond

CameraTurntableOperator.getMomentumLossPerSecond()

Return type: number

isAnimating

CameraTurntableOperator.isAnimating()

Return type: boolean

isCurrentlyAnimating

CameraTurntableOperator.isCurrentlyAnimating()

Return type: boolean

setCameraRotationMomentumEnabled

CameraTurntableOperator.setCameraRotationMomentumEnabled(val)

Arguments

val (boolean()) –

Return type

void

setMapping

CameraTurntableOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments

button (Button) –
modifier (KeyModifiers) – optional

Return type

void

setMomentumLossPerSecond

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

setRotationAxis

CameraTurntableOperator.setRotationAxis(axis)

Sets the rotation axis.

Arguments

axis (Axis | Point3()) – Axis or [[Point3]] used to set the rotation axis.

Return type

boolean

stopAnimation

CameraTurntableOperator.stopAnimation()

Return type: void

supportsAnimation

CameraTurntableOperator.supportsAnimation()

Return type: boolean