CameraTurntableOperator

class Operators.Camera.CameraTurntableOperator()

Methods

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

Methods

addMapping

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

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()) – None

Return type

void

setMapping

CameraTurntableOperator.setMapping(button, modifier)

Arguments

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

Sets the button and key modifier mapping for the operator.

Return type: void

setMomentumLossPerSecond

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

setRotationAxis

CameraTurntableOperator.setRotationAxis(axis)

Arguments

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

Sets the rotation axis.

Return type: boolean

stopAnimation

CameraTurntableOperator.stopAnimation()

Return type: void

supportsAnimation

CameraTurntableOperator.supportsAnimation()

Return type: boolean