SoView2DRectangle¶

InventorModule¶

genre	`Interaction`
author	`Florian Link`
package	`MeVisLab/Standard`
dll	`SoView2D`
definition	view2d.def
see also	`SoView2D`
keywords	`cut`, `select`, `extension`

Purpose¶

The module SoView2DRectangle allows for a drawing and interactive adjustment of a 2D rectangle in a 2D viewer.

Note: although this mode is called SoView2D*Rectangle*, it actually draws a 3D box.

Interaction¶

Click and drag with the adjusted key modifier and mouse button to span a rectangle.

The first click determines the start position and the end position is set on a release event.

Windows¶

Default Panel¶

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

Output Fields¶

self¶

name: self, type: SoNode¶

Parameter Fields¶

Field Index¶

`Allow Drag`: `Bool`	`doubleClicked`: `Trigger`	`renderOnSlab`: `Bool`
`alt`: `Enum`	`Drawing On`: `Bool`	`resetToImage`: `Bool`
`Blend Inside`: `Float`	`Editing On`: `Bool`	`Select Outside`: `Bool`
`Blend Onto`: `Float`	`End World Pos`: `Vector3`	`Selection Tolerance`: `Float`
`Blend Outside`: `Float`	`Fix Z`: `Bool`	`setEventHandled`: `Bool`
`clipToSlice`: `Bool`	`ignoreHandledEvents`: `Bool`	`Shade Exterior`: `Float`
`Color`: `Color`	`Line Blend Inside`: `Float`	`singleClicked`: `Trigger`
`Cooperative`: `Bool`	`Line Blend Onto`: `Float`	`Start World Pos`: `Vector3`
`Create`: `Trigger`	`Line Blend Outside`: `Float`	`wantsAllEvents`: `Bool`
`Create Mode`: `Bool`	`maskValid`: `Bool`	`wantsKeyEvents`: `Bool`
`cursorShape`: `Enum`	`needsValidVoxel`: `Bool`	`wantsMouseWheelEvents`: `Bool`

Visible Fields¶

Drawing On¶

name: drawingOn, type: Bool, default: TRUE¶: If checked, the 3D box is drawn.

Editing On¶

name: editingOn, type: Bool, default: TRUE¶: If checked, the 3D box can interactively be edited.

Fix Z¶

name: fixZOn, type: Bool, default: FALSE¶: If checked, the interaction with an existing marker (node of box) happens in the marker's original z-position.

Color¶

name: color, type: Color, default: 1 1 1¶: Sets the color of the rendered rectangle.

Selection Tolerance¶

name: selectionTolerance, type: Float, default: 4, minimum: 2, maximum: 40, deprecated name: selectDistance¶: Sets a distance the mouse needs to be moved after clicking to activate an interaction.

Create Mode¶

name: createNewMode, type: Bool, default: FALSE¶: If checked and in cooperation mode, the module is allowed to create new boxes.

Create¶

name: createNewModeRequest, type: Trigger¶: If pressed and in cooperation mode, the module is set to be in creation mode.

Start World Pos¶

name: startWorldPos, type: Vector3, default: -1 -1 -1¶: Shows and sets the start position of the 3D box.

End World Pos¶

name: endWorldPos, type: Vector3, default: -1 -1 -1¶: Shows and sets the end position of the 3D box.

Blend Inside¶

name: blendInside, type: Float, default: 0.2, minimum: 0, maximum: 1¶: Sets an alpha factor for rendering the faces of the box if the current slice crosses the box.

Blend Onto¶

name: blendOnto, type: Float, default: 0.5, minimum: 0, maximum: 1¶: Sets an alpha factor for rendering the faces of the 3D box that lie directly on the current viewer's slice.

Blend Outside¶

name: blendOutside, type: Float, default: 0, minimum: 0, maximum: 1¶: Sets an alpha factor for rendering the faces of the box if the current slice does not cross the box at all.

Line Blend Inside¶

name: lineBlendInside, type: Float, default: 0.5, minimum: 0, maximum: 1¶: Sets an alpha factor for rendering the edges of the box if the current slice crosses the box.

Line Blend Onto¶

name: lineBlendOnto, type: Float, default: 0.69999999, minimum: 0, maximum: 1¶: Sets an alpha factor for rendering the edges of the box if the current slice crosses the box.

Line Blend Outside¶

name: lineBlendOutside, type: Float, default: 0, minimum: 0, maximum: 1¶: Sets an alpha factor for rendering the edges of the box if the current slice does not cross the box at all.

Select Outside¶

name: selectOutside, type: Bool, default: FALSE¶: If enabled, the rectangle can be selected outside of its z range if blendOutside or lineBlendOutside > 0.

Allow Drag¶

name: allowDrag, type: Bool, default: FALSE¶: If checked, an existing rectangle can be translated by clicking it in the interior and dragging it on the viewer.

Cooperative¶

name: cooperative, type: Bool, default: FALSE¶: If checked, the module evaluates internal states so that if other module actually set this state, an interaction is evaluated by only one module.

Shade Exterior¶

name: shadeExterior, type: Float, default: 0, minimum: 0, maximum: 1¶: Sets a darkening factor of the image outside the rectangle. Default is 0 (that is: not darken at all).

Hidden Fields¶

maskValid¶

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

needsValidVoxel¶

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

alt¶

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

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

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: CROSS_CURSOR¶