SoView2DCSOEditor

InventorModule

genre	SoCSO
status	stable
author	Olaf Konrad
package	MeVisLab/Standard
dll	SoCSO
definition	SoCSO.def
see also	CSOManager, SoCSO3DVis
keywords	CSO, draw, edit

Purpose

The SoView2DCSOEditor allows for an editing and a drawing of CSOs.

Usage

Attach this module's output to a 2D viewer.

Attach a CSOManager to the module's inCSOList field, and a processor module (e.g., CSOFreehandProcessor, CSOIsoProcessor or CSOPrimitiveProcessor) to the module's inProcessor field.

Optionally, a StylePalette can be attached to the module's inStylePalette field.

Details

The SoView2DCSOEditor allows for some basic interaction with CSOs like selecting (multi- or single-selection) and moving all selected CSOs, copying and pasting, or performing undo / redo operations. The actual editing and generating of CSOs is performed in the attached processor module.

Although the actual appearance of the CSOs is managed in the processor by its default parameters (those parameters can be changed after the creation of a CSO in the CSOManager) some other parameters can be changed that are related to the visualization. These are the emphasizing on mouse-over events, the visualization of CSOs that do not lie directly on the currently visible slice and the showing of labels.

Interaction

The module can be used in the general interaction modes Edit and Move. In Edit mode, an existing CSO can be edited if the according processor for this CSO is attached to the editor. Editing can be the displacement of single seed points, the adding or removing of seed points, or the creation of a new CSO. The actual editing options depend on the type of the processor that is attached.

If a different processor than the one that has generated an existing CSO is attached while trying to interact with such a CSO, the editor is set to Move mode automatically. This means that such CSO can only be moved as a whole. The editor offers the same behavior if its general interaction mode is set to Move. Then, a CSO can be generated anew with an according processor, but once the CSO is finished, it can only be moved as a whole.

The editor allows for applying some operations like cut, copy, undo or redo by pressing a key (combination). Those combinations can be adjusted to fit your needs. However, if a combination is used doubly (like STRG+H for undo and for paste), the module detects this and displays an according error message on a status field. Note that the module does not change those double definitions.

If no processor is attached at all, the SoView2DCSOEditor can still perform basic tasks like selecting a CSO or moving a CSO as a whole.

Windows

Default Panel

Input Fields

inCSOList

name: inCSOList, type: MLBase

The input CSOList.

inProcessor

name: inProcessor, type: MLBase

An optional processor for the specific interaction (generation, editing).

inStylePalette

name: inStylePalette, type: MLBase

an optional style palette to provide visualization parameters.

Output Fields

self

name: self, type: SoNode

The Open Inventor scene.

Parameter Fields

Field Index

Alignment: Enum	fixZOn: Bool	Shadow: Bool
Alpha: Bool	Font Size: Float	Shift: Enum
Alt: Enum	forceStartNewCSOKey: Enum	shouldTouchItselfInEvalEvent: Bool
boundingBoxAlpha: Float	forceStartNewCSOKeyModifier: Enum	shouldUpdateInteractionStateAndCSOId: Bool
boundingBoxColor: Color	General Interaction Mode: Enum	Show CSOs on all time points: Bool
Brighten (ghostStyleBrighten): Bool	General Label Alpha: Float	Show only parallel CSOs: Bool
Brighten (selectionBrightenColor): Float	General Label Color: Color	showBoundingBox: Bool
Brighten (mouseOverColorBrightenValue): Float	Global Alpha Factor: Float	showParallelDotProductLimitRadian: Float
Button 1: Enum	Highlight selected group members: Bool	Status (keyConfigurationStatus): String
Button 2: Enum	Icon File:: String	Status (nextInteractionStatus): Enum
Button 3: Enum	ignoreHandledEvents: Bool	Stipple: Bool
By selecting a CSO: Bool	in: Enum	Tesselation Alpha: Float
clipToSlice: Bool	internalIconFile: String	Tesselation Color: Color
color: Color	interpolationTargetColor: Color	tesselationWindingRule: Enum
Color Mode (selectionColoringMode): Enum	Line: Bool	Thickness:: Float
Color Mode (mouseOverColorMode): Enum	Line Width (selectionFixedLineWidth): Float	Toggle Mode Key: Enum
Control: Enum	Line Width (mouseOverLineWidthLineWidth): Float	triggerCopy: Trigger
Copy Key: Enum	Line Width Mode (selectionLineWidthMode): Enum	triggerCutCopy: Trigger
Copy Key Modifier: Enum	Line Width Mode (mouseOverLineWidthMode): Enum	triggerPaste: Trigger
createNewMode: Bool	maskValid: Bool	Undo Key: Enum
createNewModeRequest: Trigger	Mode (labelShowMode): Enum	Undo Key Modifier: Enum
Cursor currently over CSO id: Integer	Mode (ghostMode): Enum	Units: Bool
cursorShape: Enum	Mode (labelColorMode): Enum	Use (useIconFile): Bool
Cut Copy Key: Enum	Mode (tesselationColorMode): Enum	Use (enableMultiSelection): Bool
Cut Copy Key Modifier: Enum	Multi Selection Modifier: Enum	Use Anti Aliasing: Bool
Delete CSOKey: Enum	needsValidVoxel: Bool	Use auto leveling: Bool
Delete CSOKey Modifier: Enum	Overwrite Selection Visualization Settings: Bool	Use Hole Correction: Bool
Delete Seed Point Key: Enum	Paste Key: Enum	Use Index As: Enum
Delete Seed Point Key Modifier: Enum	Paste Key Modifier: Enum	Use Style Palette: Bool
Depth: Float	Redo Key: Enum	useInterpolationTargetColor: Bool
Drawing on: Bool	Redo Key Modifier: Enum	Wants all events: Bool
Editing on: Bool	renderOnSlab: Bool	Wants key events: Bool
Enable highlighting: Bool	Repaint: Bool	wantsMouseWheelEvents: Bool
Fade Out Min Alpha: Float	Scale: Enum	Widen (selectionWidenLineWidth): Float
Fill Closed CSOs: Bool	Selection changed: Bool	Widen (mouseOverLineWidthWidenValue): Float
Finishing: Bool	Selection Tolerance: Float	X: Float
Fixed (selectionFixedColor): Color	Set pasted CSOs as selected: Bool	Y: Float
Fixed (mouseOverColorColor): Color	setEventHandled: Bool

Visible Fields

Drawing on

name: drawingOn, type: Bool, default: TRUE

If checked, the module renders the CSOs in OpenGL on the viewer the module is attached to.

Editing on

name: editingOn, type: Bool, default: TRUE

If checked, the module allows for editing of CSOs.

Selection Tolerance

name: selectionTolerance, type: Float, default: 24, minimum: 0

This determines the distance in pixel to a seed point or a path point that is needed to lead to a selection.

Button 1

name: button1, type: Enum, default: PRESSED

These parameter determines which mouse button (combination) leads to an active event.

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

Button 2

name: button2, type: Enum, default: IGNORED

These parameter determines which mouse button (combination) leads to an active event.

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

Button 3

name: button3, type: Enum, default: IGNORED

These parameter determines which mouse button (combination) leads to an active event.

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

Shift

name: shift, type: Enum, default: IGNORED

This parameter determines further how to produce an active event.

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

Control

name: control, type: Enum, default: IGNORED

This parameter determines further how to produce an active event.

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

Alt

name: alt, type: Enum, default: IGNORED

This parameter determines further how to produce an active event.

Values:

Title	Name
Pressed	PRESSED
Released	RELEASED
Ignored	IGNORED

Wants all events

name: wantsAllEvents, type: Bool, default: TRUE

If checked, the module processes all mouse and keyboard events.

Wants key events

name: wantsKeyEvents, type: Bool, default: TRUE

If checked, the module processes all keyboard events.

Repaint

name: shouldListenToRepaintEvents, type: Bool, default: TRUE

If checked, the module redraws on receiving a repaint event.

Selection changed

name: shouldListenToSelectionChangedEvents, type: Bool, default: TRUE

If checked, the module redraws on receiving a selection event.

Finishing

name: shouldListenToFinishedEvents, type: Bool, default: TRUE

If checked, the module redraws on receiving a finished event.

General Interaction Mode

name: generalInteractionMode, type: Enum, default: INTERACTION_MODE_EDIT

This option toggles the general interaction behavior of this module. The behavior can also be toggled by pressing an according key (Toggle Mode Key).

Values:

Title	Name
Edit	INTERACTION_MODE_EDIT
Move	INTERACTION_MODE_MOVE

Toggle Mode Key

name: generalInteractionModeToggleKey, type: Enum, default: TOGGLE_MODE_ALT

If the chosen keyboard modifier is being held down, the general interaction mode is toggled, i.e. if the module is in Edit mode, the Move mode is turned on and vice versa. See General Interaction Mode.

Values:

Title	Name
None	TOGGLE_MODE_NONE
Alt	TOGGLE_MODE_ALT
Control	TOGGLE_MODE_CONTROL
Shift	TOGGLE_MODE_SHIFT

Use Anti Aliasing

name: useAntiAliasing, type: Bool, default: TRUE

If checked, the CSOs are rendered with an anti-aliasing.

Show CSOs on all time points

name: showCSOsOnAllTimePoints, type: Bool, default: FALSE

If checked, CSOs with a different timepoint index than the shown slice(s) are shown.

Otherwise, only those CSOs with the same timepoint index as the shown slice(s) are shown.

Show only parallel CSOs

name: showOnlyParallelCSOs, type: Bool, default: FALSE

If checked, only CSOs that are parallel to the currently shown slice(s) are shown. See Thickness:.

Thickness:

name: showParallelThickness, type: Float, default: 1, minimum: 0

Sets the thickness of a point cloud of the seed points of a CSO be counted to be parallel to the current slice.

Use auto leveling

name: shouldLevelCSO, type: Bool, default: FALSE

If checked, the currently edited CSOs is being auto-levelled after finishing the interaction.

The resulting CSOs is always in-plane.

Use Style Palette

name: useStylePalette, type: Bool, default: FALSE

If checked, the optional StylePalette is used to provide visual parameters.

Use Index As

name: stylePaletteUseIndexAs, type: Enum, default: USE_INDEX_FOR_CSO

Determines how the optional style palette is accessed.

Make sure that a style palette is attached and that the option Use Style Palette is checked.

Values:

Title	Name
Cso	USE_INDEX_FOR_CSO
Group	USE_INDEX_FOR_GROUP

Mode (labelShowMode)

name: labelShowMode, type: Enum, default: LABEL_SHOW_NONE

Sets the lable show mode. The labels can provide additional information about a rendered CSO.

Values:

Title	Name	Description
None	LABEL_SHOW_NONE	No label is shown.
Cso Label	LABEL_SHOW_CSO_LABEL	The label string of a CSO is shown.
Cso Description	LABEL_SHOW_CSO_DESCRIPTION	The description string of a CSO is shown.
Cso Id	LABEL_SHOW_CSO_ID	The id of a CSO is shown.
Cso Index	LABEL_SHOW_CSO_INDEX	The index of a CSO is shown.
Cso Length	LABEL_SHOW_CSO_LENGTH	The length of a CSO is shown. The unit of the length is adjustable with Scale.
Cso Area	LABEL_SHOW_CSO_AREA	The area of a CSO is shown. The unit of the length is adjustable with Scale.
Group Label	LABEL_SHOW_GROUP_LABEL	The label string of the CSOGroup the CSO is in is shown.
Group Description	LABEL_SHOW_GROUP_DESCRIPTION	The description string of the CSOGroup the CSO is in is shown.
Group Id	LABEL_SHOW_GROUP_ID	The id of the CSOGroup the CSO is in is shown.
Group Index	LABEL_SHOW_GROUP_INDEX	The index of the CSOGroup the CSO is in is shown.

Alignment

name: labelAlignmentMode, type: Enum, default: LABEL_ALIGN_CENTER

Sets the alignment of a shown label in relation to the CSO's bounding box

Values:

Title	Name
Top Left	LABEL_ALIGN_TOP_LEFT
Top Right	LABEL_ALIGN_TOP_RIGHT
Bottom Left	LABEL_ALIGN_BOTTOM_LEFT
Bottom Right	LABEL_ALIGN_BOTTOM_RIGHT
Top	LABEL_ALIGN_TOP
Bottom	LABEL_ALIGN_BOTTOM
Left	LABEL_ALIGN_LEFT
Right	LABEL_ALIGN_RIGHT
Center	LABEL_ALIGN_CENTER

Scale

name: labelUnitScale, type: Enum, default: LABEL_UNIT_SCALE_MM

Sets the unit scale of lenght and area if shown as a label.

Values:

Title	Name
Mm	LABEL_UNIT_SCALE_MM
Cm	LABEL_UNIT_SCALE_CM
M	LABEL_UNIT_SCALE_M

Units

name: showLabelUnits, type: Bool, default: TRUE

If checked, displayed length and area labels also show the unit scale.

Font Size

name: labelFontSize, type: Float, default: 12

The font size for labels.

Shadow

name: labelUseTextShadow, type: Bool, default: TRUE

If checked, the labels are rendered with a shadow for enhanced readability.

X

name: labelMarginX, type: Float, default: 2

Margin for placement of a label in x-direction. Effect depends on the setting of Alignment.

Y

name: labelMarginY, type: Float, default: 2

Margin for placement of a label in y-direction. Effect depends on the setting of Alignment.

Mode (ghostMode)

name: ghostMode, type: Enum, default: GHOST_BOTH_SIDES

Sets the ghost mode for contours.

A ghost CSO is a contour that is visible although it exists on a slice lower or higher than the currently shown slice(s).

Values:

Title	Name	Description
Both Sides	GHOST_BOTH_SIDES	CSOs on lower and on higher slices are shown as ghosts.
Front Side	GHOST_FRONT_SIDE	Only the CSOs that lie on lower slices than the current slice(s) are shown as ghosts.
Back Side	GHOST_BACK_SIDE	Only the CSOs that lie on higher slices than the current slice(s) are shown as ghosts.
None	GHOST_NONE	Only the CSOs on the current slice(s) are shown.

in

name: ghostUnitMode, type: Enum, default: GHOST_UNIT_SLICE

Determines the units for the Depth.

Values:

Title	Name	Description
Mm	GHOST_UNIT_MM	The distance from the current slice(s) to potential ghost CSOs is measured in mm.
Slice	GHOST_UNIT_SLICE	The distance from the current slice(s) to potential ghost CSOs is measured in number of slices.

Alpha

name: ghostStyleAlpha, type: Bool, default: TRUE

If checked, ghost CSOs that are farther away from the current slice(s) are rendered with a higher transparency.

Stipple

name: ghostStyleStipple, type: Bool, default: TRUE

If checked, ghost CSOs that are farther away from the current slice(s) are rendered with a looser stippling pattern.

Line

name: ghostStyleLineWidth, type: Bool, default: FALSE

If checked, ghost CSOs that are farther away from the current slice(s) are rendered with a different line width, depending if they are on higher or lower slices.

Brighten (ghostStyleBrighten)

name: ghostStyleBrighten, type: Bool, default: FALSE

If checked, ghost CSOs that are farther away from the current slice(s) are rendered in a different brightness, depending if they are on higher or lower slices.

Depth

name: ghostDepth, type: Float, default: 5

Sets the distance to the current slice(s), in which ghost CSOs should still be visible. See in.

Fade Out Min Alpha

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

Sets the minimum alpha value which is used when the fade-out distance is reached. I.e. if this is set to a value greater than 0, all CSOs are drawn. Also affects the stippling pattern of ghost CSOs.

General Label Color

name: generalLabelColor, type: Color, default: 1 1 1

Sets a general color for labels. See Mode.

General Label Alpha

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

Sets a general alpha value for labels. See Mode.

Mode (labelColorMode)

name: labelColorMode, type: Enum, default: COLOR_GENERAL

Determines how the CSO labels are colored.

Values:

Title	Name	Description
General	COLOR_GENERAL	The general color and alpha value are used for rendering labels.
As Cso	COLOR_AS_CSO	The color and alpha value for labels are the same as the individual CSO.

Fill Closed CSOs

name: useTesselation, type: Bool, default: FALSE

If checked, the displayed CSOs are being filled by OpenGL.

Note that holes in CSOs are not diplayed correctly.

Use Hole Correction

name: useHoleCorrection, type: Bool, default: FALSE

If checked, filled overlapping CSOs will be visualized as if the rendering was XORed.

That means that if there is one CSO enclosing another one, the inner CSO will not be filled and thus forms a hole.

Mode (tesselationColorMode)

name: tesselationColorMode, type: Enum, default: COLOR_AS_CSO

Determines how the fillings of CSOs are colored.

Values:

Title	Name	Description
General	COLOR_GENERAL	The general color and alpha value is used for rendering the fillings.
As Cso	COLOR_AS_CSO	The color and the alpha value are the same as the individual CSO.

Tesselation Color

name: tesselationColor, type: Color, default: 0.899999976158142 0.5 0.899999976158142

Sets a general color for the filling. See Mode.

Tesselation Alpha

name: tesselationAlpha, type: Float, default: 0.2, minimum: 0, maximum: 1

Sets a general alpha value for the filling. See Mode.

Global Alpha Factor

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

Sets a global alpha value for rendering CSOs which is multiplied with all alpha values (of seed points and path points).

Overwrite Selection Visualization Settings

name: overwriteSelectionVisualizationSettings, type: Bool, default: FALSE

If checked, the visualization parameters for selection are overwritten by the editor.

Otherwise, those settings can be changed centrally in the CSOManager.

Color Mode (selectionColoringMode)

name: selectionColoringMode, type: Enum, default: SELECTION_COLOR_MODE_FIXED

The color mode for selections. Depends on Overwrite Selection Visualization Settings.

Values:

Title	Name	Description
Brighten	SELECTION_COLOR_MODE_BRIGHTEN	A selected CSO's color is brightened by Brighten.
Fixed	SELECTION_COLOR_MODE_FIXED	A selected CSO's color is set to Fixed.

Brighten (selectionBrightenColor)

name: selectionBrightenColor, type: Float, default: 0.2

A brighten value for selected CSOs. See Color Mode.

Fixed (selectionFixedColor)

name: selectionFixedColor, type: Color, default: 1 1 0.600000023841858, deprecated name: selectionFallbackColor

A fixed color for selected CSOs. See Color Mode.

Line Width Mode (selectionLineWidthMode)

name: selectionLineWidthMode, type: Enum, default: SELECTION_LINE_WIDEN

The line width mode for selections. Depends on Overwrite Selection Visualization Settings.

Values:

Title	Name	Description
Widen	SELECTION_LINE_WIDEN	A selected CSO's line width is widened by Widen.
Fixed	SELECTION_LINE_FIXED	A selected CSO's line width is set to Line Width.

Widen (selectionWidenLineWidth)

name: selectionWidenLineWidth, type: Float, default: 1, deprecated name: selectionFallbackWidth

A widening line width value for selected CSOs. See Line Width Mode.

Line Width (selectionFixedLineWidth)

name: selectionFixedLineWidth, type: Float, default: 1

A fixed line width value for selected CSOs. See Line Width Mode.

By selecting a CSO

name: selectGroupsParsProToto, type: Bool, default: TRUE

If checked, a whole CSOGroup is selected if one member CSO is being selected.

Highlight selected group members

name: highlightSelectedGroups, type: Bool, default: FALSE

If checked, all CSOs of a selected CSOGroup are highlighted.

Set pasted CSOs as selected

name: setPastedCSOsSelected, type: Bool, default: FALSE

If checked, pasted CSO(s) are being selected automatically after being pasted.

Enable highlighting

name: enableMouseOverHighlighting, type: Bool, default: TRUE

If checked, CSOs under the mouse cursor are highlighted. See Color Mode and Line Width Mode.

Color Mode (mouseOverColorMode)

name: mouseOverColorMode, type: Enum, default: HIGHLIGHT_COLOR_MODE_FIXED

The color mode for mouse over highlighting. Depends on Enable highlighting.

Values:

Title	Name	Description
Brighten	HIGHLIGHT_COLOR_MODE_BRIGHTEN	The color of a CSO under the mouse cursor is brightened by Brighten.
Fixed	HIGHLIGHT_COLOR_MODE_FIXED	The color of a CSO under the mouse cursor is set to Fixed.

Brighten (mouseOverColorBrightenValue)

name: mouseOverColorBrightenValue, type: Float, default: 0.80000001

A brighten value for the CSO under the mouse curosr. See Color Mode.

Fixed (mouseOverColorColor)

name: mouseOverColorColor, type: Color, default: 1 1 1

A color for the CSO under the mouse curosr. See Color Mode.

Line Width Mode (mouseOverLineWidthMode)

name: mouseOverLineWidthMode, type: Enum, default: HIGHLIGHT_LINE_WIDEN

The line width mode for mouse over highlighting. Depends on Enable highlighting.

Values:

Title	Name	Description
Widen	HIGHLIGHT_LINE_WIDEN	The line width of a CSO under the mouse cursor is widened by Widen.
Fixed	HIGHLIGHT_LINE_FIXED	The line width of a CSO under the mouse cursor is set to Line Width.

Widen (mouseOverLineWidthWidenValue)

name: mouseOverLineWidthWidenValue, type: Float, default: 0

A line width widen value for the CSO under the mouse curosr. See Line Width Mode.

Line Width (mouseOverLineWidthLineWidth)

name: mouseOverLineWidthLineWidth, type: Float, default: 1

A line width value for the CSO under the mouse curosr. See Line Width Mode.

Cursor currently over CSO id

name: currentlyUnderMouseCursorCSOId, type: Integer, default: 0

Displays the id of the CSO that is currently under the mouse cursor.

Use (useIconFile)

name: useIconFile, type: Bool, default: FALSE

If checked, the optional attached StylePalette uses an icon file specified in Icon File:.

Icon File:

name: iconFile, type: String, default: $(MLAB_MeVisLab_Standard)/Modules/Resources/Images/markerIcons.tif

An optional icon file for the optional StylePalette. Depends on Use.

Cut Copy Key Modifier

name: cutCopyKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_CONTROL

Modifier key for the cut&copy key command.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Copy Key Modifier

name: copyKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_CONTROL

Modifier key for the copy key command.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Paste Key Modifier

name: pasteKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_CONTROL

Modifier key for the paste key command.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Undo Key Modifier

name: undoKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_CONTROL

Modifier key for the undo key command.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Redo Key Modifier

name: redoKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_CONTROL

Modifier key for the redo key command.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Delete Seed Point Key Modifier

name: deleteSeedPointKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_NONE

Modifier key for the deleteSeedPoint key command.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Delete CSOKey Modifier

name: deleteCSOKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_SHIFT

Modifier key for the deleteCSO key command.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Multi Selection Modifier

name: multiSelectionKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_CONTROL

Modifier key for the multi-selection.

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

Use (enableMultiSelection)

name: enableMultiSelection, type: Bool, default: TRUE

If checked, multi-selection is allowed. See Multi Selection Modifier.

Cut Copy Key

name: cutCopyKey, type: Enum, default: EDIT_OP_KEY_X

The key for the cut&copy command.

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

Copy Key

name: copyKey, type: Enum, default: EDIT_OP_KEY_C

The key for the cut command.

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

Paste Key

name: pasteKey, type: Enum, default: EDIT_OP_KEY_V

The key for the paste command.

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

Undo Key

name: undoKey, type: Enum, default: EDIT_OP_KEY_Z

The key for the undo command.

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

Redo Key

name: redoKey, type: Enum, default: EDIT_OP_KEY_Y

The key for the redo command.

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

Delete Seed Point Key

name: deleteSeedPointKey, type: Enum, default: EDIT_OP_KEY_DELETE

The key for the deleteSeePoint command.

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

Delete CSOKey

name: deleteCSOKey, type: Enum, default: EDIT_OP_KEY_DELETE

The key for the deleteCSO command.

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

Status (keyConfigurationStatus)

name: keyConfigurationStatus, type: String, persistent: no

Displays the status of the key command assignment.

If a key / modifier combination is assigned twice, this field will display an error message.

Status (nextInteractionStatus)

name: nextInteractionStatus, type: Enum, default: INTERACTIVE_MODE_START_CSO

Displays the current interaction state.

Values:

Title	Name
Start Cso	INTERACTIVE_MODE_START_CSO
Edit Cso	INTERACTIVE_MODE_EDIT_CSO
Move Cso	INTERACTIVE_MODE_MOVE_CSO
Insert Seed	INTERACTIVE_MODE_INSERT_SEED
Select Cso	INTERACTIVE_MODE_SELECT_CSO
Close Cso	INTERACTIVE_MODE_CLOSE_CSO

Hidden Fields

maskValid

name: maskValid, type: Bool, default: FALSE

fixZOn

name: fixZOn, type: Bool, default: TRUE

color

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

needsValidVoxel

name: needsValidVoxel, type: Bool, default: TRUE

wantsMouseWheelEvents

name: wantsMouseWheelEvents, type: Bool, default: FALSE

setEventHandled

name: setEventHandled, type: Bool, default: FALSE

ignoreHandledEvents

name: ignoreHandledEvents, type: Bool, default: FALSE

createNewMode

name: createNewMode, type: Bool, default: FALSE

createNewModeRequest

name: createNewModeRequest, type: Trigger

renderOnSlab

name: renderOnSlab, type: Bool, default: FALSE

clipToSlice

name: clipToSlice, type: Bool, default: FALSE

cursorShape

name: cursorShape, type: Enum, default: UNDEFINED_CURSOR

Values:

Title	Name
Undefined Cursor	UNDEFINED_CURSOR
Default Cursor	DEFAULT_CURSOR
Forbidden Cursor	FORBIDDEN_CURSOR
Pointing Hand Cursor	POINTING_HAND_CURSOR
Open Hand Cursor	OPEN_HAND_CURSOR
Closed Hand Cursor	CLOSED_HAND_CURSOR
Move All Cursor	MOVE_ALL_CURSOR
Move Hori Cursor	MOVE_HORI_CURSOR
Move Vert Cursor	MOVE_VERT_CURSOR
Move Fdiag Cursor	MOVE_FDIAG_CURSOR
Move Bdiag Cursor	MOVE_BDIAG_CURSOR
Move Inout Cursor	MOVE_INOUT_CURSOR
Rotate X Cursor	ROTATE_X_CURSOR
Rotate Y Cursor	ROTATE_Y_CURSOR
Rotate Z Cursor	ROTATE_Z_CURSOR
Rotate Xy Cursor	ROTATE_XY_CURSOR
Zoom Cursor	ZOOM_CURSOR
Zoom In Cursor	ZOOM_IN_CURSOR
Zoom Out Cursor	ZOOM_OUT_CURSOR
Cross Cursor	CROSS_CURSOR
Cross Plus Cursor	CROSS_PLUS_CURSOR
Cross Minus Cursor	CROSS_MINUS_CURSOR
Cross Move Cursor	CROSS_MOVE_CURSOR
Cross Rotate Cursor	CROSS_ROTATE_CURSOR
Cross Rect Cursor	CROSS_RECT_CURSOR
Cross Oval Cursor	CROSS_OVAL_CURSOR
Cross Vector Cursor	CROSS_VECTOR_CURSOR
Cross Freeform Cursor	CROSS_FREEFORM_CURSOR
Cross Point Cursor	CROSS_POINT_CURSOR
Cross Line Cursor	CROSS_LINE_CURSOR
Cross Curve Cursor	CROSS_CURVE_CURSOR
Cross Polyline Cursor	CROSS_POLYLINE_CURSOR
Cross Polygon Cursor	CROSS_POLYGON_CURSOR
Cross Fill Cursor	CROSS_FILL_CURSOR
Cross Link Cursor	CROSS_LINK_CURSOR
Cross 0 Cursor	CROSS_0_CURSOR
Cross 1 Cursor	CROSS_1_CURSOR
Cross 2 Cursor	CROSS_2_CURSOR
Cross 3 Cursor	CROSS_3_CURSOR
Lut Cursor	LUT_CURSOR
Slicing Cursor	SLICING_CURSOR

useInterpolationTargetColor

name: useInterpolationTargetColor, type: Bool, default: TRUE

interpolationTargetColor

name: interpolationTargetColor, type: Color, default: 1 0 0

showBoundingBox

name: showBoundingBox, type: Bool, default: FALSE

boundingBoxAlpha

name: boundingBoxAlpha, type: Float, default: 0.5, minimum: 0, maximum: 1

boundingBoxColor

name: boundingBoxColor, type: Color, default: 1 1 1

tesselationWindingRule

name: tesselationWindingRule, type: Enum, default: WR_ODD

Values:

Title	Name
Odd	WR_ODD
Nonzero	WR_NONZERO
Positive	WR_POSITIVE
Negative	WR_NEGATIVE
Abs Geq Two	WR_ABS_GEQ_TWO

internalIconFile

name: internalIconFile, type: String

triggerCutCopy

name: triggerCutCopy, type: Trigger

triggerCopy

name: triggerCopy, type: Trigger

triggerPaste

name: triggerPaste, type: Trigger

shouldUpdateInteractionStateAndCSOId

name: shouldUpdateInteractionStateAndCSOId, type: Bool, default: TRUE

shouldTouchItselfInEvalEvent

name: shouldTouchItselfInEvalEvent, type: Bool, default: TRUE

forceStartNewCSOKeyModifier

name: forceStartNewCSOKeyModifier, type: Enum, default: EDIT_OP_KEY_MOD_NONE

Values:

Title	Name
None	EDIT_OP_KEY_MOD_NONE
Alt	EDIT_OP_KEY_MOD_ALT
Control	EDIT_OP_KEY_MOD_CONTROL
Shift	EDIT_OP_KEY_MOD_SHIFT

forceStartNewCSOKey

name: forceStartNewCSOKey, type: Enum, default: EDIT_OP_KEY_F

Values:

Title	Name
A	EDIT_OP_KEY_A
B	EDIT_OP_KEY_B
C	EDIT_OP_KEY_C
D	EDIT_OP_KEY_D
E	EDIT_OP_KEY_E
F	EDIT_OP_KEY_F
G	EDIT_OP_KEY_G
H	EDIT_OP_KEY_H
I	EDIT_OP_KEY_I
J	EDIT_OP_KEY_J
K	EDIT_OP_KEY_K
L	EDIT_OP_KEY_L
M	EDIT_OP_KEY_M
N	EDIT_OP_KEY_N
O	EDIT_OP_KEY_O
P	EDIT_OP_KEY_P
Q	EDIT_OP_KEY_Q
R	EDIT_OP_KEY_R
S	EDIT_OP_KEY_S
T	EDIT_OP_KEY_T
U	EDIT_OP_KEY_U
V	EDIT_OP_KEY_V
W	EDIT_OP_KEY_W
X	EDIT_OP_KEY_X
Y	EDIT_OP_KEY_Y
Z	EDIT_OP_KEY_Z
Space	EDIT_OP_KEY_SPACE
Enter	EDIT_OP_KEY_ENTER
Delete	EDIT_OP_KEY_DELETE
Bckspc	EDIT_OP_KEY_BCKSPC

showParallelDotProductLimitRadian

name: showParallelDotProductLimitRadian, type: Float, default: 0

Adjusts an angle limit for the comparison whether a CSO is parallel to a slice.

This has only an effect if Show only parallel CSOs is checked.