SoView2DPosition¶

InventorModule¶

genre	`Interaction`
author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`SoView2D`
definition	view2d.def
see also	`SoView2D`
inherits from	`SoView2DExtension`
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¶

../../../Modules/Inventor/SoView2D/mhelp/Images/Screenshots/SoView2DPosition._default.png

Output Fields¶

self¶

name: self, type: SoNode¶

Parameter Fields¶

Field Index¶

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

Visible Fields¶

Drawing On¶

name: drawingOn, type: Bool, default: TRUE¶: If 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.

Button1¶

name: button1, type: Enum, default: PRESSED¶

see SoView2DExtension.button1

Button2¶

name: button2, type: Enum, default: IGNORED¶

see SoView2DExtension.button2

Button3¶

name: button3, type: Enum, default: IGNORED¶

see SoView2DExtension.button3

Shift¶

name: shift, type: Enum, default: IGNORED¶

see SoView2DExtension.shift

Control¶

name: control, type: Enum, default: IGNORED¶

see SoView2DExtension.control

Alt¶

name: alt, type: Enum, default: IGNORED¶

see SoView2DExtension.alt

Set to create mode¶

name: createNewMode, type: Bool, default: FALSE¶

see SoView2DExtension.createNewMode

Create¶

name: createNewModeRequest, type: Trigger¶

see SoView2DExtension.createNewModeRequest

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, persistent: no¶: 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
Crosshairs With Circle	DRAWINGMODEL_CROSSHAIRS_WITH_CIRCLE

Size Unit¶

name: drawingModelSizeUnit, type: Enum, default: SIZEUNIT_VOXEL¶

Values:

Title	Name
Voxel	SIZEUNIT_VOXEL
World	SIZEUNIT_WORLD
Screen	SIZEUNIT_SCREEN

Size¶

name: drawingModelSize, type: Float, 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¶

name: crossHairSpacing, type: Float, 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¶

interactionProviderID¶

name: interactionProviderID, type: String¶

see SoView2DExtension.interactionProviderID

maskValid¶

name: maskValid, type: Bool, persistent: no¶

fixZOn¶

name: fixZOn, type: Bool, default: TRUE¶

needsValidVoxel¶

name: needsValidVoxel, type: Bool, default: TRUE¶

see SoView2DExtension.needsValidVoxel

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¶

see SoView2DExtension.setEventHandled

ignoreHandledEvents¶

name: ignoreHandledEvents, type: Bool, default: FALSE¶

see SoView2DExtension.ignoreHandledEvents

renderOnSlab¶

name: renderOnSlab, type: Bool, default: FALSE¶

clipToSlice¶

name: clipToSlice, type: Bool, default: FALSE¶

cursorShape¶

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR¶

see SoView2DExtension.cursorShape

singleClicked¶

name: singleClicked, type: Trigger, persistent: no¶

doubleClicked¶

name: doubleClicked, type: Trigger, persistent: no¶

linePattern¶

name: linePattern, type: Integer, default: 65535¶