CameraTurntableOperator

class Operators.Camera.CameraTurntableOperator()

Index

Methods

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

Methods

Operators.Camera.CameraTurntableOperator.addMapping()

inherited

addMapping(button: Button, modifier: KeyModifiers?): void

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.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.Camera.CameraTurntableOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

Operators.Camera.CameraTurntableOperator.getCameraRotationMomentumEnabled()

inherited

getCameraRotationMomentumEnabled(): boolean

Returns: boolean

Operators.Camera.CameraTurntableOperator.getMomentum()

inherited

getMomentum(): number

Returns: number

Operators.Camera.CameraTurntableOperator.getMomentumLossPerSecond()

inherited

getMomentumLossPerSecond(): number

Returns: number

Operators.Camera.CameraTurntableOperator.isAnimating()

inherited

isAnimating(): boolean

Returns: boolean

Operators.Camera.CameraTurntableOperator.isCurrentlyAnimating()

inherited

isCurrentlyAnimating(): boolean

Returns: boolean

Operators.Camera.CameraTurntableOperator.setCameraRotationMomentumEnabled()

inherited

setCameraRotationMomentumEnabled(val: boolean): void

Parameters

val: boolean

Returns: void

Operators.Camera.CameraTurntableOperator.setMapping()

inherited

setMapping(button: Button, modifier: KeyModifiers?): void

Sets the button and key modifier mapping for the operator.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.Camera.CameraTurntableOperator.setMomentumLossPerSecond()

inherited

setMomentumLossPerSecond(amountLost: number): void

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.

Parameters

amountLost: number

Proportion of momentum lost per second

Returns: void

Operators.Camera.CameraTurntableOperator.setRotationAxis()

setRotationAxis(axis: (Point3 | Axis)): boolean

Sets the rotation axis.

Parameters

axis: (Point3 | Axis)

[[Axis]] or [[Point3]] used to set the rotation axis.

Returns: boolean

Operators.Camera.CameraTurntableOperator.stopAnimation()

inherited

stopAnimation(): void

Returns: void

Operators.Camera.CameraTurntableOperator.supportsAnimation()

inherited

supportsAnimation(): boolean

Returns: boolean