SoView2DCSOExtensibleEditor¶

InventorModule¶

author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`SoCSO`
definition	SoCSO.def
inherits from	`SoView2DExtension`
keywords	`roi`, `spline`, `polygon`, `polyline`

Purpose¶

The module SoView2DCSOExtensibleEditor manages attached CSO editors and renderers and offers an optional default renderer for all types of CSOs.

Usage¶

Attach one or multiple CSO editors/renderers to the inExtensions field.

If multiple editors/renderers should be attached, use a SoGroup to group them and attach the group to this module.

The field Creator Extension Id takes a string that identifies the editor that should be used for creating a new CSO. Set the string to be the same as the extensionId string on any attached editor.

Alternatively, the field Creator Extension Id can be set to __default where the first found eligible editor is used to create a new CSO.

The configuration of the key commands and mouse button mask can be done with a SoInteractionMapping module.

Windows¶

Default Panel¶

../../../Modules/Inventor/SoCSO/mhelp/Images/Screenshots/SoView2DCSOExtensibleEditor._default.png

Input Fields¶

inCSOList¶

name: inCSOList, type: CSOList(MLBase)¶: Attach a CSOList.

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

inExtensions¶

name: inExtensions, type: SoNode¶: Attach a CSO editor or a SoGroup where multiple CSO editors/renderers are attached to.

inVisualizationSettings¶

name: inVisualizationSettings, type: CSOVisualizationSettings(MLBase)¶: Attach a SoCSOVisualizationSettings module to control the appearance of CSOs.

inTransformationProvider¶

name: inTransformationProvider, type: TransformationProvider(MLBase)¶: For accessing this object via scripting see the Scripting Reference: MLTransformationProviderWrapper.

Output Fields¶

self¶

name: self, type: SoNode¶

Parameter Fields¶

Field Index¶

`Allow Selection With Default Renderer`: `Bool`	`Creator Extension Id`: `String`	`Needs Valid Voxel`: `Bool`
`Alt`: `Enum`	`CSO Id Under Mouse`: `Integer`	`Remove all enabled`: `Bool`
`Always create a new CSO`: `Bool`	`cursorShape`: `Enum`	`Render`: `Enum`
`alwaysModifyExistingCSOs`: `Bool`	`Drawing On`: `Bool`	`Render left-over CSOs with default renderer`: `Bool`
`Button1`: `Enum`	`Editing On`: `Bool`	`renderOnSlab`: `Bool`
`Button2`: `Enum`	`fixZOn`: `Bool`	`Selection Tolerance`: `Float`
`Button3`: `Enum`	`ignoreHandledEvents`: `Bool`	`setEventHandled`: `Bool`
`cancelGeneration`: `Trigger`	`Interact only with selected CSO`: `Bool`	`Shift`: `Enum`
`clipToSlice`: `Bool`	`interactionProviderID`: `String`	`Update CSO id under mouse`: `Bool`
`color`: `Color`	`Is creating new CSO`: `Bool`	`updateImageStatisticsOnFinishInteraction`: `Bool`
`Control`: `Enum`	`Is editing existing CSO`: `Bool`	`wantsAllEvents`: `Bool`
`createNewMode`: `Bool`	`Keys enabled`: `Bool`	`wantsKeyEvents`: `Bool`
`createNewModeRequest`: `Trigger`	`maskValid`: `Bool`	`wantsMouseWheelEvents`: `Bool`

Visible Fields¶

Drawing On¶

name: drawingOn, type: Bool, default: TRUE¶: If checked, the attached editors render CSOs.

Editing On¶

name: editingOn, type: Bool, default: TRUE¶: If checked, editing of the rendered CSOs is possible.

Selection Tolerance¶

name: selectionTolerance, type: Float, default: 16, minimum: 0¶: Sets a selection tolerance (distance) in pixel.

Needs Valid Voxel¶

name: needsValidVoxel, type: Bool, default: FALSE¶: Restrict interaction to the area of the image underlay. Also see SoCSOPointEditor.restrictToImageBoundaries.

Button1¶

name: button1, type: Enum, default: PRESSED¶: Defines the mask for mouse button 1.

Button2¶

name: button2, type: Enum, default: IGNORED¶: Defines the mask for mouse button 2.

Button3¶

name: button3, type: Enum, default: IGNORED¶: Defines the mask for mouse button 3.

Shift¶

name: shift, type: Enum, default: IGNORED¶: Defines the mask for the SHIFT key.

Control¶

name: control, type: Enum, default: IGNORED¶: Defines the mask for the CONTROL key.

Alt¶

name: alt, type: Enum, default: IGNORED¶: Defines the mask for the ALT key.

Creator Extension Id¶

name: creatorExtensionId, type: String, default: __default¶

Sets an extension id of an attached editor that creates a new CSO.

If this field is set to __default, the first attached editor is used to create a new CSO.

Always create a new CSO¶

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

If checked, a new CSO is always created if an appropriate editor is found.

Otherwise, an existing CSO is selected on clicking into a viewer.

Keys enabled¶

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

If checked, key commands are enabled.

By default, the keyboard commands

Shortcut	Effect
CTRL+Z	Undo
CTRL+Y	Redo
CTRL+C	Copy selected CSO.
CTRL+X	Cut selected CSO.
CTRL+V	Paste selected CSO.
DEL	Delete selected seed point.
SHIFT+DEL	Delete selected CSO.
ESC	Reset the current state

are available.

Remove all enabled¶

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

If checked, the module react on a keyboard shortcut to remove all CSOs and CSOGroups.

Default shortcut is CTRL+Q.

Interact only with selected CSO¶

name: interactOnlyWithSelectedCSO, type: Bool, default: FALSE¶: If checked, interaction (modification) is only allowed with selected CSOs.

Render left-over CSOs with default renderer¶

name: renderLeftOverCSOsWithDefaultRenderer, type: Bool, default: TRUE¶: If checked, an internal default renderer is used for rendering all CSOs without a specific, attached editor.

Allow Selection With Default Renderer¶

name: allowSelectionWithDefaultRenderer, type: Bool, default: TRUE¶: If checked, all rendered CSO can be selected even if no specialized editor is attached.

Render¶

name: renderCSOsOnImagesDependingOnCreationMode, type: Enum, default: ON_ALL_IMAGES¶: Defines on which images the CSOs should be rendered on. This is decided by the imageInstanceSOP which is stored as userData in the CSO on creation.

Values:

Title	Name	Description
On All Images	ON_ALL_IMAGES	CSOs are rendered on all images, the imageInstanceSOP is ignored.
Only On Images They Were Created On	ONLY_ON_IMAGES_THEY_WERE_CREATED_ON	The CSOs are rendered only on the images they were created on.
Only On Images They Were Not Created On	ONLY_ON_IMAGES_THEY_WERE_NOT_CREATED_ON	The CSOs are rendered only on images they were NOT created on. This mode is useful to render CSOs with different visualization settings on secondary captures.
Only On Images They Can Be Transformed To	ONLY_ON_IMAGES_THEY_CAN_BE_TRANSFORMED_TO

Update CSO id under mouse¶

name: updateCSOIdUnderMouseCursor, type: Bool, default: FALSE¶: If checked, the field CSO Id Under Mouse is updated on each mouse movement.

CSO Id Under Mouse¶

name: csoIdUnderMouseCursor, type: Integer, persistent: no¶

Shows the id of the CSO currently under the mouse cursor.

This field is only touched if its value changes.

If the field Update CSO id under mouse is off, this field is never updated.

Is creating new CSO¶

name: isCreatingNewCSO, type: Bool, persistent: no¶: Shows whether any editor is currently creating a new CSO.

Is editing existing CSO¶

name: isEditingExistingCSO, type: Bool, persistent: no¶: Shows whether any editor is editing/modifying an existing CSO.

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

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¶

see SoView2DExtension.cursorShape

alwaysModifyExistingCSOs¶

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

cancelGeneration¶

name: cancelGeneration, type: Trigger¶

updateImageStatisticsOnFinishInteraction¶

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