SoView2DRigidRegistrationEditor

InventorModule

genre	View2D
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	SoView2D
definition	view2d.def
inherits from	SoView2DExtension
keywords	manual, rigid, affine, registration, editor, widget

Purpose

The module SoView2DRigidRegistrationEditor provides a manual editor for a rigid registration.

Usage

The Matrix field always contains the current transformation matrix to apply on the image to register and is updated on-the-fly when interacting.

There is a Reset button that allows for resetting the transformation.

The Default field contains the initial transformation, which is also applied when the Reset button is pressed.

Details

This module uses Managed Interaction to handle mouse and keyboard inputs. This means that modules like SoInteractionInfo or SoInteractionMapping apply for this module.

Interaction

Click on the center spot to move the rotation center.

Click on the wheel around this spot to rotate the transformation and click anywhere else to translate the transformation.

Windows

Default Panel

Input Fields

inUndoContext

name: inUndoContext, type: UndoContext(MLBase)

Connect this input to the output of a UndoManager module to get undo handling.

For accessing this object via scripting, see the Scripting Reference: MLUndoContextWrapper.

Output Fields

self

name: self, type: SoNode

The Open Inventor scene graph node; in this case, the module itself.

Parameter Fields

Field Index

Alt: Enum	Drawing On: Bool	Reset Rotation Wheel Center: Trigger
Button1: Enum	Editing On: Bool	rotationCenterWorld: Vector3
Button2: Enum	fixZOn: Bool	selectionTolerance: Float
Button3: Enum	Fraction of viewer size: Float	setEventHandled: Bool
Center (resolvedCenterImageFile): String	Global Alpha: Float	Shadow: Color
Center (rotationRelativeCenterRadius): Float	Highlight: Color	Shift: Enum
centerImageFile: String	ignoreHandledEvents: Bool	singleClicked: Trigger
clipToSlice: Bool	Inactive: Color	wantsAllEvents: Bool
color: Color	interactionProviderID: String	wantsKeyEvents: Bool
Control: Enum	maskValid: Bool	wantsMouseWheelEvents: Bool
createNewMode: Bool	Matrix: Matrix	Wheel: String
createNewModeRequest: Trigger	Maximum size in pixels: Float	Wheel (maximum): Float
cursorShape: Enum	Minimum size in pixels: Float	Wheel (minimum): Float
Default: Matrix	needsValidVoxel: Bool	wheelImageFile: String
doubleClicked: Trigger	renderOnSlab: Bool
Draw shadow: Bool	Reset: Trigger

Visible Fields

Drawing On

name: drawingOn, type: Bool, default: TRUE

If checked, the rendering of the widget is enabled.

see also SoView2DExtension.drawingOn

Editing On

name: editingOn, type: Bool, default: TRUE

If checked, the editing of the transformation is enabled.

see also SoView2DExtension.editingOn

Button1

name: button1, type: Enum, default: PRESSED

Defines the default mouse button configuration.

see also SoView2DExtension.button1

Button2

name: button2, type: Enum, default: IGNORED

Defines the default mouse button configuration.

see also SoView2DExtension.button2

Button3

name: button3, type: Enum, default: IGNORED

Defines the default mouse button configuration.

see also SoView2DExtension.button3

Shift

name: shift, type: Enum, default: IGNORED

Defines the default mouse button configuration.

see also SoView2DExtension.shift

Control

name: control, type: Enum, default: IGNORED

Defines the default mouse button configuration.

see also SoView2DExtension.control

Alt

name: alt, type: Enum, default: IGNORED

Defines the default mouse button configuration.

see also SoView2DExtension.alt

Matrix

name: outputMatrix, type: Matrix, persistent: no

Shows the current transformation.

This matrix is transposed relative to the normal Open Inventor matrix representation, which is unusual. The used representation is in ML matrix format.

Default

name: defaultOutputMatrix, type: Matrix, default: 1 0 0 0, 0 1 0 0, 0 0 1 0, 0 0 0 1

Sets the default value for Matrix. When set, this will also set Matrix and reset the undo/redo stack.

This value will be used when the Reset button is pressed.

Reset

name: reset, type: Trigger

When pressed, the Matrix is restored to the value of Default. Reset the rotationCenterWorld to the center of the image and clear the undo/redo stack.

Reset Rotation Wheel Center

name: resetRotationWheelCenter, type: Trigger

When pressed, the rotation center of the rotation wheel is reset to the middle of the image.

Wheel

name: resolvedWheelImageFile, type: String, persistent: no

Sets an image that will be used to display the rotation wheel.

Usually, one should not need to change this image. The image needs to have only one gray channel and one alpha channel.

Center (resolvedCenterImageFile)

name: resolvedCenterImageFile, type: String, persistent: no

Sets an image that will be used to display the rotation center.

Usually, one should not need to change this image. The image needs to have only one gray channel and one alpha channel. Note that the size of this image relative to wheelImageFile is retained in the display.

Center (rotationRelativeCenterRadius)

name: rotationRelativeCenterRadius, type: Float, default: 0.1

Sets the radius of the region around the rotation center used to drag the rotation center.

This size is relative to the size of wheelImageFile.

Wheel (minimum)

name: minRelativeWheelRadius, type: Float, default: 0.80000001

Sets the minimum radius of the region around the rotation center used to rotate the transformation.

This size is relative to the size of wheelImageFile.

Wheel (maximum)

name: maxRelativeWheelRadius, type: Float, default: 1

Sets the maximum radius of the region around the rotation center used to rotate the transformation.

This size is relative to the size of wheelImageFile.

Inactive

name: inactiveColor, type: Color, default: 0.25 0.25 0.375

Sets the color of the wheel/center spot when not active.

Highlight

name: highlightColor, type: Color, default: 1 1 1

Sets the active color of the wheel/center spot.

Shadow

name: shadowColor, type: Color, default: 0 0 0

Sets the color of the wheel’s/center spot’s shadow.

Draw shadow

name: drawShadow, type: Bool, default: TRUE

If checked, a shadow in Shadow is rendered.

Global Alpha

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

Sets the global alpha value for all rendering (active and inactive, including shadow).

Fraction of viewer size

name: sizeViewerPercentage, type: Float, default: 0.69999999

Sets the fraction of the viewer size the wheel should normally have.

Minimum size in pixels

name: minWheelSizeInPixels, type: Float, default: 200

Sets the minimum size of the wheel in pixels.

Maximum size in pixels

name: maxWheelSizeInPixels, type: Float, default: 800

Sets the maximum size of the wheel in pixels.

Hidden Fields

interactionProviderID

name: interactionProviderID, type: String

see SoView2DExtension.interactionProviderID

maskValid

name: maskValid, type: Bool, persistent: no

fixZOn

name: fixZOn, type: Bool, default: TRUE

color

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

see SoView2DExtension.color

selectionTolerance

name: selectionTolerance, type: Float, default: 4

needsValidVoxel

name: needsValidVoxel, type: Bool, default: FALSE

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

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: FALSE

cursorShape

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR

This is not used.

see also SoView2DExtension.cursorShape

singleClicked

name: singleClicked, type: Trigger, persistent: no

doubleClicked

name: doubleClicked, type: Trigger, persistent: no

rotationCenterWorld

name: rotationCenterWorld, type: Vector3, default: 0 0 0

Sets current rotation center in world coordinates.

When rotating the transformation, it is rotated around this spot.

wheelImageFile

name: wheelImageFile, type: String, default: $(LOCAL)/images/registrationWheel.png

Version of Wheel that has common file locations encoded as variables.

centerImageFile

name: centerImageFile, type: String, default: $(LOCAL)/images/rotationCenter.png

Version of Center that has common file locations encoded as variables.