CameraZoomOperator

class Operators.Camera.CameraZoomOperator()

Methods

addMapping()
clearMapping()
getDollyZoomEnabled()
getMouseMoveZoomDelta()
getMouseMoveZoomInverted()
getMouseWheelAdjustCameraTarget()
getMouseWheelZoomDelta()
getMouseWheelZoomInverted()
getPreserveViewAngle()
getZoomToMousePosition()
setDollyZoomEnabled()
setMapping()
setMouseMoveZoomDelta()
setMouseMoveZoomInverted()
setMouseWheelAdjustCameraTarget()
setMouseWheelZoomDelta()
setMouseWheelZoomInverted()
setPreserveViewAngle()
setZoomToMousePosition()

Methods

addMapping

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

CameraZoomOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

getDollyZoomEnabled

CameraZoomOperator.getDollyZoomEnabled()

Returns true if dolly zoom is enabled.

Return type: boolean

getMouseMoveZoomDelta

CameraZoomOperator.getMouseMoveZoomDelta()

Gets the mouse move zoom delta

Returns: number
Return type: number

getMouseMoveZoomInverted

CameraZoomOperator.getMouseMoveZoomInverted()

Return type: boolean

getMouseWheelAdjustCameraTarget

CameraZoomOperator.getMouseWheelAdjustCameraTarget()

Returns whether the camera target will be updated to the selection position while zooming. See [[setMouseWheelAdjustCameraTarget]].

Return type: boolean

getMouseWheelZoomDelta

CameraZoomOperator.getMouseWheelZoomDelta()

Gets the scrollwheel zoom delta

Returns: number
Return type: number

getMouseWheelZoomInverted

CameraZoomOperator.getMouseWheelZoomInverted()

Return type: boolean

getPreserveViewAngle

CameraZoomOperator.getPreserveViewAngle()

Gets whether to maintain a constant view angle while zooming. See [[setPreserveViewAngle]].

Return type: boolean

getZoomToMousePosition

CameraZoomOperator.getZoomToMousePosition()

Returns: boolean When true, the zoom will be towards the mouse position. When false, the zoom will be towards the center of the screen.
Return type: boolean

setDollyZoomEnabled

CameraZoomOperator.setDollyZoomEnabled(dollyZoomEnabled)

Arguments

dollyZoomEnabled (boolean()) – None

When dolly zoom is enabled, the camera position will move towards the camera target when zooming.

MoveCameraPositon
Return type: void

setMapping

CameraZoomOperator.setMapping(button, modifier)

Arguments

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

Sets the button and key modifier mapping for the operator.

Return type: void

setMouseMoveZoomDelta

CameraZoomOperator.setMouseMoveZoomDelta(delta)

Arguments

delta (number()) – None

Sets the delta to zoom when moving the mouse

Return type: void

setMouseMoveZoomInverted

CameraZoomOperator.setMouseMoveZoomInverted(inverted)

Arguments

inverted (boolean()) – None

When true, moving the mouse up will zoom towards the model.

Return type: void

setMouseWheelAdjustCameraTarget

CameraZoomOperator.setMouseWheelAdjustCameraTarget(value)

Arguments

value (boolean()) – None

When enabled, the camera target will be updated to the selection position while zooming. This can provide a better zoom behavior in perspective projection mode, but comes at the cost of performing a selection on the model during each mouse scroll, which may not be ideal for performance on large models.

This setting is disabled by default.

Return type: void

setMouseWheelZoomDelta

CameraZoomOperator.setMouseWheelZoomDelta(delta)

Arguments

delta (number()) – None

Sets the delta to zoom when scrolling

Return type: void

setMouseWheelZoomInverted

CameraZoomOperator.setMouseWheelZoomInverted(inverted)

Arguments

inverted (boolean()) – None

When true, scrolling up will zoom towards the model.

Return type: void

setPreserveViewAngle

CameraZoomOperator.setPreserveViewAngle(value)

Arguments

value (boolean()) – None

Sets whether to maintain a constant view angle while zooming. If enabled, when zooming causes the camera’s field of view to shrink or grow, the camera’s position will also be moved toward or away from the target, respectively.

This may prevent confusing camera behavior when perspective projection is used or might be used. When using only orthographic projection, it is better to disable this.

If mouse wheel zoom is being using in conjunction with window zoom this setting should be the same in both.

This setting is enabled by default.

Return type: void

setZoomToMousePosition

CameraZoomOperator.setZoomToMousePosition(zoom)

Arguments

zoom (boolean()) – None

When set, the zoom will be towards the mouse position. When not set, the zoom will be from the center of the screen.

Return type: void