SoDiagram2DZoom

InventorModule
genre Diagram
authors Tobias Block, Olaf Konrad
package MeVisLab/Standard
dll SoDiagram2D
definition SoDiagram2D.def
see also SoDiagram2D, SoDiagram2DAxisZoom

Purpose

The module SoDiagram2DZoom zooms a diagram interactively.

The module offers two zoom modes: zooming by drawing a rubber band selection and zooming by turning the mouse wheel.

Usage

At the moment, the module only works with the left mouse button (in conjunction with an adjustable modified key) and with the mouse wheel.

Details

The zoom factor can be restricted on the panel of the module SoDiagram2D.

Windows

Default Panel

../../../Modules/Inventor/SoDiagram2D/mhelp/Images/Screenshots/SoDiagram2DZoom._default.png

Output Fields

self

name: self, type: SoNode

Parameter Fields

Visible Fields

Extension enabled

name: isEnabled, type: Bool, default: TRUE

If checked, the module is enabled.

Shift

name: shift, type: Enum, default: IGNORED

Sets the state of the SHIFT key to lead to an event.

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

Control

name: control, type: Enum, default: IGNORED

Sets the state of the CONTROL key to lead to an event.

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

Alt

name: alt, type: Enum, default: IGNORED

Sets the state of the ALT key to lead to an event.

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

Enabled (isSelectionZoomEnabled)

name: isSelectionZoomEnabled, type: Bool, default: TRUE

If checked, the module allows to draw a rubber band rectangle onto the diagram. The selected portion of the diagram is zoomed on releasing the mouse button.

In this mode, pressing the right mouse button unzooms the diagram.

Color

name: color, type: Color, default: 0.759999990463257 0.850000023841858 1

Sets the color of the selection rectangle in rubber band mode.

Opacity

name: opacity, type: Float, default: 0.5, minimum: 0, maximum: 1

Sets the opacity of the selection rectangle in rubber band mode.

Show border

name: border, type: Bool, default: TRUE

If checked, a border is rendered around the rubber band selection.

Animate

name: animateSelectionZoom, type: Bool, default: FALSE

If checked, the zooming is animated instead of being immediate.

Enabled (isScrollingZoomEnabled)

name: isScrollingZoomEnabled, type: Bool, default: FALSE

If checked, the zooming with the mouse wheel is enabled.

Zoom Factor

name: scrollZoomFactor, type: Float, default: 0.1

Sets the zoom factor for one tick of the mouse wheel.

Rotation Value

name: scrollWheelRotationValue, type: Float, default: 120

Sets the rotation value for one tick of the mouse wheel.

Ease Factor

name: animationEaseFactor, type: Float, default: 0.60000002, minimum: 0.1, maximum: 1

Sets the ease factor for the zoom animation. This can be considered being a speed factor with 0.1 as the slowest and 1 as the fastest zoom animation speed.

Stop Epsilon

name: animationEpsilon, type: Float, default: 0.001

Sets an epsilon factor for the zoom animation.

This factor also influences the animation speed.

Adapt Mouse Cursor

name: adaptMouseCursor, type: Bool, default: FALSE

If checked, the mouse cursor is set to be a magnifying glass.

Restrict Zoom Out To Diagram Area

name: restrictZoomOutToDiagramArea, type: Bool, default: FALSE

If checked, the module restricts the zooming out of a diagram.

Zoom In

name: zoomIn, type: Trigger

If pressed, the module zooms into the diagram.

Zoom Out

name: zoomOut, type: Trigger

If pressed, the module zooms out of the diagram.

Reset Zoom

name: resetZoom, type: Trigger

If pressed, all zoom is reset.

Auto (restrictAutoXMin)

name: restrictAutoXMin, type: Bool, default: TRUE

If checked, the module computes the restricting minimum value for the x-axis.

Auto (restrictAutoXMax)

name: restrictAutoXMax, type: Bool, default: TRUE

If checked, the module computes the restricting maximum value for the x-axis.

Auto (restrictAutoYMin)

name: restrictAutoYMin, type: Bool, default: TRUE

If checked, the module computes the restricting minimum value for the y-axis.

Auto (restrictAutoYMax)

name: restrictAutoYMax, type: Bool, default: TRUE

If checked, the module computes the restricting maximum value for the y-axis.

X Min

name: restrictXMin, type: Float, default: 0

Sets the minimum value for the x-axis range as a zoom restriction.

X Max

name: restrictXMax, type: Float, default: 1

Sets the maximum value for the x-axis range as a zoom restriction.

Y Min

name: restrictYMin, type: Float, default: 0

Sets the minimum value for the y-axis range as a zoom restriction.

Y Max

name: restrictYMax, type: Float, default: 1

Sets the maximum value for the y-axis range as a zoom restriction.

Hidden Fields

isEditingEnabled

name: isEditingEnabled, type: Bool, default: TRUE

button1

name: button1, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

button2

name: button2, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

button3

name: button3, type: Enum, default: IGNORED

Values:

Title Name
Pressed PRESSED
Released RELEASED
Ignored IGNORED

animateScrollingZoom

name: animateScrollingZoom, type: Bool, default: FALSE

zoomInOutValue

name: zoomInOutValue, type: Float, default: 0.2