CameraZoomOperator

class Operators.Camera.CameraZoomOperator()

Index

Methods

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

Methods

Operators.Camera.CameraZoomOperator.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.CameraZoomOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

Operators.Camera.CameraZoomOperator.getDollyZoomEnabled()

getDollyZoomEnabled(): boolean

Returns true if dolly zoom is enabled.

Returns: boolean

Operators.Camera.CameraZoomOperator.getMouseMoveZoomDelta()

getMouseMoveZoomDelta(): number

Gets the mouse move zoom delta

Returns: number

number

Operators.Camera.CameraZoomOperator.getMouseMoveZoomInverted()

getMouseMoveZoomInverted(): boolean

Returns: boolean

Operators.Camera.CameraZoomOperator.getMouseWheelAdjustCameraTarget()

getMouseWheelAdjustCameraTarget(): boolean

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

Returns: boolean

Operators.Camera.CameraZoomOperator.getMouseWheelZoomDelta()

getMouseWheelZoomDelta(): number

Gets the scrollwheel zoom delta

Returns: number

number

Operators.Camera.CameraZoomOperator.getMouseWheelZoomInverted()

getMouseWheelZoomInverted(): boolean

Returns: boolean

Operators.Camera.CameraZoomOperator.getPreserveViewAngle()

getPreserveViewAngle(): boolean

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

Returns: boolean

Operators.Camera.CameraZoomOperator.getZoomToMousePosition()

getZoomToMousePosition(): boolean

Returns: boolean

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

Operators.Camera.CameraZoomOperator.setDollyZoomEnabled()

setDollyZoomEnabled(dollyZoomEnabled: boolean): void

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

Parameters

dollyZoomEnabled: boolean

Returns: void

Operators.Camera.CameraZoomOperator.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.CameraZoomOperator.setMouseMoveZoomDelta()

setMouseMoveZoomDelta(delta: number): void

Sets the delta to zoom when moving the mouse

Parameters

delta: number

Returns: void

Operators.Camera.CameraZoomOperator.setMouseMoveZoomInverted()

setMouseMoveZoomInverted(inverted: boolean): void

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

Parameters

inverted: boolean

Returns: void

Operators.Camera.CameraZoomOperator.setMouseWheelAdjustCameraTarget()

setMouseWheelAdjustCameraTarget(value: boolean): void

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.

Parameters

value: boolean

Returns: void

Operators.Camera.CameraZoomOperator.setMouseWheelZoomDelta()

setMouseWheelZoomDelta(delta: number): void

Sets the delta to zoom when scrolling

Parameters

delta: number

Returns: void

Operators.Camera.CameraZoomOperator.setMouseWheelZoomInverted()

setMouseWheelZoomInverted(inverted: boolean): void

When true, scrolling up will zoom towards the model.

Parameters

inverted: boolean

Returns: void

Operators.Camera.CameraZoomOperator.setPreserveViewAngle()

setPreserveViewAngle(value: boolean): void

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.

Parameters

value: boolean

Returns: void

Operators.Camera.CameraZoomOperator.setZoomToMousePosition()

setZoomToMousePosition(zoom: boolean): void

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

Parameters

zoom: boolean

Returns: void