SoView2DPlane¶

InventorModule¶

genre	`Plane`
author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`SoView2D`
definition	view2d.def
see also	`SoView2D`
inherits from	`SoView2DExtension`
keywords	`intersect`, `cut`, `extension`

Purpose¶

The module SoView2DPlane displays a plane in 2D (mostly by displaying the crossing line of the plane with the viewing plane) and allows for an interactive placing and orienting of the plane.

Interaction¶

To adjust the plane interactively, click and drag into the viewer in the vicinity of the plane (which is most likely visible as its crossing line with the viewer’s plane).

If the module is in the Interaction Mode Both, a dragging in the middle third of the plane (crossing line) causes a translation while a dragging in the outer thirds of the plane causes a rotation around an axis that lies in the middle and is perpendicular to the viewer’s plane.

The interaction mode can be changed to only rotate or only translate the plane. Furthermore, an external rotation axis can be provided.

Windows¶

Default Panel¶

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

Output Fields¶

self¶

name: self, type: SoNode¶

Parameter Fields¶

Field Index¶

`allowMoveExternalRotationAxis`: `Bool`	`fixZOn`: `Bool`	`Show normal indicator`: `Bool`
`Alt`: `Enum`	`ignoreHandledEvents`: `Bool`	`singleClicked`: `Trigger`
`Blend Max`: `Float`	`Interaction Mode`: `Enum`	`Size`: `Integer`
`Blend Min`: `Float`	`interactionProviderID`: `String`	`translationLineFraction`: `Float`
`centerGapSize`: `Float`	`maskValid`: `Bool`	`translationRangeMax`: `Float`
`clipToSlice`: `Bool`	`maskValidAndHit`: `Bool`	`translationRangeMin`: `Float`
`Color`: `Color`	`needsValidVoxel`: `Bool`	`Use`: `Bool`
`createNewMode`: `Bool`	`Offset`: `Float`	`useAntiAliasing`: `Bool`
`createNewModeRequest`: `Trigger`	`Plane`: `Plane`	`useMouseCursors`: `Bool`
`cursorShape`: `Enum`	`renderOnSlab`: `Bool`	`useTranslationRange`: `Bool`
`doubleClicked`: `Trigger`	`rotationDifference`: `Matrix`	`wantsAllEvents`: `Bool`
`Drawing On`: `Bool`	`selectionTolerance`: `Float`	`wantsKeyEvents`: `Bool`
`Editing On`: `Bool`	`setEventHandled`: `Bool`	`wantsMouseWheelEvents`: `Bool`
`External Rotation Axis`: `Vector3`	`shadowOn`: `Bool`
`fixedLineWidth`: `Bool`	`Shape`: `Enum`

Visible Fields¶

Drawing On¶

name: drawingOn, type: Bool, default: TRUE¶: If checked, the (crossing with the) plane is rendered.

Editing On¶

name: editingOn, type: Bool, default: FALSE¶: If checked, the plane can be modified interactively.

Color¶

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

Alt¶

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

see SoView2DExtension.alt

Plane¶

name: plane, type: Plane, default: 0 0 1 1¶: Sets and shows the plane parametrization of the current plane.

Blend Min¶

name: blendMin, type: Float, default: 0.1, minimum: 0, maximum: 1¶: Sets the minimum blending factor that is used for planes that are more parallel to the current viewer’s plane.

Blend Max¶

name: blendMax, type: Float, default: 1, minimum: 0, maximum: 1¶: Sets the maximum blending factor that is used for planes that are more orthogonal to the current viewer’s plane.

Show normal indicator¶

name: normalOn, type: Bool, default: FALSE, deprecated name: showNormal¶: If checked, normal indicators are rendered as triangles pointing in normal direction.

Use¶

name: externalRotationAxisOn, type: Bool, default: FALSE¶: If checked, an external rotation axis can be set. The interactive rotation uses the axis specified in External Rotation Axis.

External Rotation Axis¶

name: externalRotationAxis, type: Vector3, default: 0 0 0¶: Sets the fixed rotation axis for interactive rotation.

Size¶

name: normalSize, type: Integer, default: 10, minimum: 0, maximum: 50¶: Sets the size of the normal indicator.

Offset¶

name: normalOffset, type: Float, default: 0, minimum: -1, maximum: 1¶: Sets an offset value for the normal indicator.

Shape¶

name: normalShape, type: Enum, default: TRIANGLE¶: Defines the shape for the normal indicator.

Values:

Title	Name
Triangle	TRIANGLE
Arrow	ARROW

Interaction Mode¶

name: interactionMode, type: Enum, default: BOTH¶: Defines the interaction mode.

Values:

Title	Name	Description
Translate	TRANSLATE	The plane can only be translated interactively.
Rotate	ROTATE	The plane can only be rotated interactively.
Both	BOTH	The plane be translated and rotated interactively, depending on where the plane is clicked.

Hidden Fields¶

interactionProviderID¶

name: interactionProviderID, type: String¶

see SoView2DExtension.interactionProviderID

maskValid¶

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

fixZOn¶

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

selectionTolerance¶

name: selectionTolerance, type: Float, default: 4, deprecated name: selectDistance¶

needsValidVoxel¶

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

see SoView2DExtension.needsValidVoxel

wantsAllEvents¶

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

wantsKeyEvents¶

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

wantsMouseWheelEvents¶

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

setEventHandled¶

name: setEventHandled, type: Bool, default: FALSE, deprecated name: setHandled¶

see SoView2DExtension.setEventHandled

ignoreHandledEvents¶

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

see SoView2DExtension.ignoreHandledEvents

createNewMode¶

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

see SoView2DExtension.createNewMode

createNewModeRequest¶

name: createNewModeRequest, type: Trigger¶

see SoView2DExtension.createNewModeRequest

renderOnSlab¶

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

clipToSlice¶

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

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¶

maskValidAndHit¶

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

useTranslationRange¶

name: useTranslationRange, type: Bool, default: FALSE¶: If checked, the plane position is restricted while dragging; uses translationRangeMin and translationRangeMax.

translationRangeMin¶

name: translationRangeMin, type: Float, default: -1¶: Sets a minimum value for the ‘d’ component of the Plane.

translationRangeMax¶

name: translationRangeMax, type: Float, default: 1¶: Sets a maximum value for the ‘d’ component of the Plane.

shadowOn¶

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

allowMoveExternalRotationAxis¶

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

centerGapSize¶

name: centerGapSize, type: Float, default: 0¶

Sets the size of the gap in the plane line around the External Rotation Axis.

Only works if Use and fixedLineWidth are both set to true.

rotationDifference¶

name: rotationDifference, type: Matrix, default: 0 0 0 0, 0 0 0 0, 0 0 0 0, 0 0 0 0¶

translationLineFraction¶

name: translationLineFraction, type: Float, default: 0.5, minimum: 0, maximum: 1¶

fixedLineWidth¶

name: fixedLineWidth, type: Bool, default: FALSE¶: If checked, the plane is rendered as a line of width 1, even if the plane is not perpendicular to the image plane.

useAntiAliasing¶

name: useAntiAliasing, type: Bool, default: TRUE¶: If checked, anti-aliasing for rendering the plane line and the normal indicators is used.

useMouseCursors¶

name: useMouseCursors, type: Bool, default: TRUE¶: If checked, specialized mouse cursors are used for translation and rotation (instead of the shape specified by cursorShape).