SoView2DPosition

InventorModule

genre	Interaction
author	Florian Link
package	MeVisLab/Standard
dll	SoView2D
definition	view2d.def
see also	SoView2D
keywords	cursor, mouse, draw, extension

Purpose

The module SoView2DPosition shows the last clicked position in a 2D viewer.

The position is shown as a cursor for which different models are available.

Windows

Default Panel

Output Fields

self

name: self, type: SoNode

Parameter Fields

Field Index

Alt: Enum	doubleClicked: Trigger	Selection Tolerance: Float
Axial: Color	Draw editing rectangle: Bool	Set to create mode: Bool
Blending Off Slice: Float	Drawing On: Bool	setEventHandled: Bool
Blending On Slice: Float	Editing On: Bool	singleClicked: Trigger
Border Width: Float	First Slice World Position: Vector3	Size (in voxels): Integer
clipToSlice: Bool	fixZOn: Bool	Spacing (in voxels): Integer
Color: Color	ignoreHandledEvents: Bool	Update On Motion: Bool
Color Axes: Bool	Line Width: Float	Update On Press: Bool
Color Border: Bool	maskValid: Bool	Update On Release: Bool
Cooperative: Bool	Model: Enum	wantsAllEvents: Bool
Coronal: Color	needsValidVoxel: Bool	wantsKeyEvents: Bool
Create: Trigger	renderOnSlab: Bool	wantsMouseWheelEvents: Bool
cursorShape: Enum	Sagittal: Color	World Position: Vector3

Visible Fields

Drawing On

name: drawingOn, type: Bool, default: TRUE

f checked, the module draws a position cursor.

Editing On

name: editingOn, type: Bool, default: TRUE

If checked, the cursor can be interactively set.

Color

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

Sets the color of the cursor.

Selection Tolerance

name: selectionTolerance, type: Float, default: 4, minimum: 2, maximum: 40, deprecated name: selectDistance

Sets a selection tolerance in pixel.

The selection tolerance determines how far away the mouse cursor needs to be from the position marker to update the position field.

Alt

name: alt, type: Enum, default: IGNORED

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

Set to create mode

name: createNewMode, type: Bool, default: FALSE

If checked and in cooperation mode, the module is in creating mode (leaving the edit mode for other cooperative modules).

Create

name: createNewModeRequest, type: Trigger

If pressed, the module announces that it is in creating mode (leaving edit modes for other cooperative modules).

World Position

name: worldPosition, type: Vector3, default: -1 -1 -1, deprecated name: currentWorldPos

Sets and shows the cursor position in world coordinates.

First Slice World Position

name: firstSliceWorldPosition, type: Vector3, default: -1 -1 -1

Shows a position that is computed by converting the world position to voxel coordinates and converting this voxel position back to world coordinates relative to the first slice of the image.

Model

name: drawingModel, type: Enum, default: DRAWINGMODEL_CROSSHAIRS

Defines the rendered model of the cursor.

Values:

Title	Name
Crosshairs	DRAWINGMODEL_CROSSHAIRS
Circle	DRAWINGMODEL_CIRCLE
Voxel Rect	DRAWINGMODEL_VOXEL_RECT
Ellipse	DRAWINGMODEL_ELLIPSE

Size (in voxels)

name: drawingModelSize, type: Integer, default: -1, minimum: -1

Sets the size of the cursor in voxel.

If the cursor is a crosshair cursor and the size is set to -1, the cursor spans the whole slice.

Spacing (in voxels)

name: crossHairSpacing, type: Integer, default: 0, minimum: 0

Sets the spacing of the crosshair cursor from the middle point.

Draw editing rectangle

name: drawEditingRect, type: Bool, default: TRUE

If checked, an editing rectangle is drawn in at the cursor position if in crosshair mode.

Blending On Slice

name: blendOnto, type: Float, default: 1, minimum: 0, maximum: 1

Sets the transparency for position cursors that lie directly on the visible slice.

Blending Off Slice

name: blendOutside, type: Float, default: 0, minimum: 0, maximum: 1

Sets the transparency for position cursors that do not lie directly on the visible slice.

Line Width

name: lineWidth, type: Float, default: 1, minimum: 1

Sets the line width.

Color Axes

name: colorAxes, type: Bool, default: FALSE

If checked, the axes of the crosshair cursor can be color separately.

Sagittal

name: sagittalColor, type: Color, default: 1 0 0

Sets the color for the sagittal axis.

Coronal

name: coronalColor, type: Color, default: 0.172549024224281 0.886274516582489 0.0117647061124444

Sets the color for the coronal axis.

Axial

name: axialColor, type: Color, default: 0.00784313771873713 0.952941179275513 0.968627452850342

Sets the color for the axial axis.

Update On Press

name: updateOnPress, type: Bool, default: TRUE

If checked, the module updates the cursor position on pressing the defined mouse button.

Update On Motion

name: updateOnMotion, type: Bool, default: TRUE

If checked, the module updates the cursor position on moving the mouse with the defined mouse button held down.

Update On Release

name: updateOnRelease, type: Bool, default: FALSE

If checked, the module updates the cursor position on releasing the defined mouse button.

Cooperative

name: cooperative, type: Bool, default: FALSE

If checked, the module does not evaluate events marked by other modules as being handled.

Color Border

name: colorBorder, type: Bool, default: FALSE

If checked, a border in the color according to the viewing direction is drawn around the viewer.

Border Width

name: colorBorderWidth, type: Float, default: 2, minimum: 1

Sets the width of the border.

Hidden Fields

maskValid

name: maskValid, type: Bool, default: FALSE

fixZOn

name: fixZOn, type: Bool, default: TRUE

needsValidVoxel

name: needsValidVoxel, type: Bool, default: TRUE

wantsAllEvents

name: wantsAllEvents, type: Bool, default: FALSE

wantsKeyEvents

name: wantsKeyEvents, type: Bool, default: FALSE

wantsMouseWheelEvents

name: wantsMouseWheelEvents, type: Bool, default: FALSE

setEventHandled

name: setEventHandled, type: Bool, default: FALSE

ignoreHandledEvents

name: ignoreHandledEvents, type: Bool, default: FALSE

renderOnSlab

name: renderOnSlab, type: Bool, default: FALSE

clipToSlice

name: clipToSlice, type: Bool, default: FALSE

cursorShape

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR

Values:

Title	Name
Undefined Cursor	UNDEFINED_CURSOR
Default Cursor	DEFAULT_CURSOR
Forbidden Cursor	FORBIDDEN_CURSOR
Pointing Hand Cursor	POINTING_HAND_CURSOR
Open Hand Cursor	OPEN_HAND_CURSOR
Closed Hand Cursor	CLOSED_HAND_CURSOR
Move All Cursor	MOVE_ALL_CURSOR
Move Hori Cursor	MOVE_HORI_CURSOR
Move Vert Cursor	MOVE_VERT_CURSOR
Move Fdiag Cursor	MOVE_FDIAG_CURSOR
Move Bdiag Cursor	MOVE_BDIAG_CURSOR
Move Inout Cursor	MOVE_INOUT_CURSOR
Rotate X Cursor	ROTATE_X_CURSOR
Rotate Y Cursor	ROTATE_Y_CURSOR
Rotate Z Cursor	ROTATE_Z_CURSOR
Rotate Xy Cursor	ROTATE_XY_CURSOR
Zoom Cursor	ZOOM_CURSOR
Zoom In Cursor	ZOOM_IN_CURSOR
Zoom Out Cursor	ZOOM_OUT_CURSOR
Cross Cursor	CROSS_CURSOR
Cross Plus Cursor	CROSS_PLUS_CURSOR
Cross Minus Cursor	CROSS_MINUS_CURSOR
Cross Move Cursor	CROSS_MOVE_CURSOR
Cross Rotate Cursor	CROSS_ROTATE_CURSOR
Cross Rect Cursor	CROSS_RECT_CURSOR
Cross Oval Cursor	CROSS_OVAL_CURSOR
Cross Vector Cursor	CROSS_VECTOR_CURSOR
Cross Freeform Cursor	CROSS_FREEFORM_CURSOR
Cross Point Cursor	CROSS_POINT_CURSOR
Cross Line Cursor	CROSS_LINE_CURSOR
Cross Curve Cursor	CROSS_CURVE_CURSOR
Cross Polyline Cursor	CROSS_POLYLINE_CURSOR
Cross Polygon Cursor	CROSS_POLYGON_CURSOR
Cross Fill Cursor	CROSS_FILL_CURSOR
Cross Link Cursor	CROSS_LINK_CURSOR
Cross 0 Cursor	CROSS_0_CURSOR
Cross 1 Cursor	CROSS_1_CURSOR
Cross 2 Cursor	CROSS_2_CURSOR
Cross 3 Cursor	CROSS_3_CURSOR
Lut Cursor	LUT_CURSOR
Slicing Cursor	SLICING_CURSOR
Cross 4 Cursor	CROSS_4_CURSOR
Cross 5 Cursor	CROSS_5_CURSOR
Cross 6 Cursor	CROSS_6_CURSOR
Cross 7 Cursor	CROSS_7_CURSOR
Cross 8 Cursor	CROSS_8_CURSOR
Cross 9 Cursor	CROSS_9_CURSOR
Lut 1 Cursor	LUT_1_CURSOR
Lut 2 Cursor	LUT_2_CURSOR
Lut 3 Cursor	LUT_3_CURSOR

singleClicked

name: singleClicked, type: Trigger

doubleClicked

name: doubleClicked, type: Trigger