CSOManager

MLModule

genre	CSOModule
status	stable
author	Olaf Konrad
package	MeVisLab/Standard
dll	MLCSO
definition	MLCSO.def
see also	SoView2DCSOEditor, CSOFilter
keywords	CSO, contour, segmentation, manager

Purpose

The module CSOManager allows for the setting parameters and default parameters for CSOs and CSOGroups, as well as for the maintaining the togetherness of CSOs and CSOGroups.

In general, there will be one CSOManager module per network, and this manager module holds a single CSOList object.

Usage

In a network, the CSOManager holds the CSOList object and all other modules are attached to its outCSOList output field.

However, a CSOLoad module may be attached to the manager's inCSOList input field, or even another CSOManager may be attached to the module's input; in the latter case, it is most likely that the module's Work directly on input CSOList field is checked so that the original CSOList is held in the CSOManager below, while the according manager is only used as a scripting interface for adding CSOGroups or adjusting parameters for existing items. Have a look at the example network for more details.

Details

The module's interface features two list views, one for all CSOs (and their associated CSOGroups), the other for all CSOGroups (and their associated CSOs). Beside these list views, the parameters for the currently selected CSOs and CSOGroups can be viewed an altered. Additionally, the default parameters for CSOs and CSOGroups can be adjusted and the notification and the selection behavior can be fine tuned.

Although CSOGroups have no visual counterpart, visual parameters can be set for them. Their use is optional, and if they are used, they overwrite the visual parameters of all contained CSOs. Since a CSO can be in multiple CSOGroups, the parameters of the first CSOGroup that was set are taken.

The module offers the performing of undo and redo operations as well as a limiting of the depth of the undo/redo stack. If the stack depth is changed to a smaller size while it is filled, the first excessive commands are removed.

Windows

CSOManager

Input Fields

inCSOList

name: inCSOList, type: MLBase

The input CSOList which is either copied or being worked directly on, depending on Work directly on input CSOList.

Output Fields

outCSOList

name: outCSOList, type: MLBase

The output CSOList.

Parameter Fields

Field Index

addCSOtoGroup: Trigger	groupDefaultUseVoxelWrite: Bool	Size (groupDefaultSeedPointSize): Float
Alpha (groupSinglePathPointAlpha): Float	groupDisplayTree: String	Start New CSO: Trigger
Alpha (groupSingleSeedPointAlpha): Float	groupPaste: Trigger	Style (csoSinglePathPointStyle): Enum
Alpha (groupDefaultPathPointAlpha): Float	groupSelectedCSOItems: String	Style (csoSingleSeedPointStyle): Enum
Alpha (groupDefaultSeedPointAlpha): Float	groupSelectedItems: String	Style (groupSinglePathPointStyle): Enum
Alpha: (csoSinglePathPointAlpha): Float	groupSingleApply: Trigger	Style (groupSingleSeedPointStyle): Enum
Alpha: (csoSingleSeedPointAlpha): Float	groupSingleUseMarkerSettings: Bool	Style (groupDefaultPathPointStyle): Enum
breakCSOFromGroup: Trigger	groupSingleUseVisuals: Bool	Style (groupDefaultSeedPointStyle): Enum
Brighten:: Float	groupSingleUseVoxelWrite: Bool	Time Point Index (csoSingleTimePointIndex): Integer
Color (groupSinglePathPointColor): Color	groupTreeView: String	Time Point Index (groupSingleTimePointIndex): Integer
Color (groupSingleSeedPointColor): Color	Id (csoSingleId): Integer	Trigger finished notification: Trigger
Color (groupDefaultPathPointColor): Color	Id (groupSingleId): Integer	Trigger moved notification: Trigger
Color (groupDefaultSeedPointColor): Color	ignoreCSOListViewSelectionChanged: Bool	Trigger repaint notification: Trigger
Color: (csoSinglePathPointColor): Color	ignoreCSOSelectionChanged: Bool	Trigger selection notification: Trigger
Color: (csoSingleSeedPointColor): Color	ignoreGroupListViewSelectionChanged: Bool	Undo: Trigger
csoCopySelected: Trigger	ignoreGroupSelectionChanged: Bool	Undo Stack Limit: Integer
csoDisplayTree: String	Interaction Init: Trigger	Use (groupSingleUseTimePointIndex): Bool
csoPaste: Trigger	Label (csoSingleLabel): String	Use (groupSingleUseShowState): Bool
csoSelectedGroupItems: String	Label (csoDefaultLabel): String	Use (groupSingleUseVoxelizeState): Bool
csoSelectedItems: String	Label (groupSingleLabel): String	Use (groupSingleUseEditableState): Bool
csoSingleApply: Trigger	Label (groupDefaultLabel): String	Use (groupSingleUsePathPointStyle): Bool
csoTreeView: String	listDefaultRemoveEmptyGroupHandling: Enum	Use (groupSingleUsePathPointWidth): Bool
Delete (csoRemoveSelected): Trigger	listSingleRemoveEmptyGroupHandling: Enum	Use (groupSingleUsePathPointColor): Bool
Delete (groupRemoveSelected): Trigger	Maximum CSOs (groupSingleNumMaximumCSOs): Integer	Use (groupSingleUsePathPointAlpha): Bool
Delete Group CSO Handling: Enum	Maximum CSOs (groupDefaultNumMaximumCSOs): Integer	Use (groupSingleUseSeedPointStyle): Bool
Desc. (csoDefaultDescription): String	Mode (selectionLineWidthMode): Enum	Use (groupSingleUseSeedPointSize): Bool
Desc. (groupSingleDescription): String	Mode (csoSingleVoxelWriteMode): Enum	Use (groupSingleUseSeedPointColor): Bool
Desc. (groupDefaultDescription): String	Mode (groupDefaultVoxelWriteMode): Enum	Use (groupSingleUseSeedPointAlpha): Bool
Description: String	Mode: (selectionColoringMode): Enum	Use (groupSingleUseVoxelWriteMode): Bool
Editable (csoSingleEditableState): Bool	Mode: (groupSingleVoxelWriteMode): Enum	Use (groupSingleUseVoxelWriteValue): Bool
Editable (csoDefaultEditableState): Bool	Moved: Trigger	Use (groupDefaultUseShowState): Bool
Editable (groupSingleEditableState): Bool	New: Trigger	Use (groupDefaultUseVoxelizeState): Bool
Editable (groupDefaultEditableState): Bool	numCSOs: Integer	Use (groupDefaultUseEditableState): Bool
Enable (useSelectionCSONotification): Bool	numGroups: Integer	Use (groupDefaultUsePathPointStyle): Bool
Enable (useSelectionGroupNotification): Bool	numRedos: Integer	Use (groupDefaultUsePathPointWidth): Bool
Enable (useFinishedCSONotification): Bool	numSelectedCSOs: Integer	Use (groupDefaultUsePathPointColor): Bool
Enable (useFinishedGroupNotification): Bool	numSelectedGroups: Integer	Use (groupDefaultUsePathPointAlpha): Bool
Enable (useCSOMovedNotification): Bool	numUndos: Integer	Use (groupDefaultUseSeedPointStyle): Bool
Enable (useRepaintNotification): Bool	Overflow Handling (groupSingleOverflowHandling): Enum	Use (groupDefaultUseSeedPointSize): Bool
Enable (useInteractionInitNotification): Bool	Overflow Handling (groupDefaultOverflowHandling): Enum	Use (groupDefaultUseSeedPointColor): Bool
Enable (useStartNewCSONotification): Bool	Redo: Trigger	Use (groupDefaultUseSeedPointAlpha): Bool
Enable finished notifications: Bool	Remove All: Trigger	Use (groupDefaultUseVoxelWriteMode): Bool
Enable moved notifications: Bool	Remove CSO Handling (groupSingleRemoveFromGroupHandling): Enum	Use (groupDefaultUseVoxelWriteValue): Bool
Enable repaint notifications: Bool	Remove CSO Handling (groupDefaultRemoveFromGroupHandling): Enum	Value (csoSingleVoxelWriteValue): Float
Enable selection notifications: Bool	Repaint: Trigger	Value (groupDefaultVoxelWriteValue): Float
Enable Undo Redo: Bool	selectedCSOsGroupIds: String	Value:: Float
Finished (notifyOnFinishedCSO): Trigger	Selection (notifyOnSelectionCSO): Trigger	Voxelize (csoSingleVoxelizeState): Bool
Finished (notifyOnFinishedGroup): Trigger	Selection (notifyOnSelectionGroup): Trigger	Voxelize (csoDefaultVoxelizeState): Bool
Fixed: (selectionFixedColor): Color	selectLastCreatedGroup: Bool	Voxelize (groupSingleVoxelizeState): Bool
Fixed: (selectionFixedLineWidth): Float	Show (csoSingleShowState): Bool	Voxelize (groupDefaultVoxelizeState): Bool
groupCopySelected: Trigger	Show (csoDefaultShowState): Bool	Widen:: Float
groupDefaultTimePointIndex: Integer	Show (groupSingleShowState): Bool	Width (csoSinglePathPointWidth): Float
groupDefaultUseMarkerSettings: Bool	Show (groupDefaultShowState): Bool	Width (groupSinglePathPointWidth): Float
groupDefaultUseTimePointIndex: Bool	Size (csoSingleSeedPointSize): Float	Width (groupDefaultPathPointWidth): Float
groupDefaultUseVisuals: Bool	Size (groupSingleSeedPointSize): Float	Work directly on input CSOList: Bool

Visible Fields

Work directly on input CSOList

name: workDirectlyOnInputCSOList, type: Bool, default: FALSE

If checked, the module creates no internal CSOList object, but works on a pointer to a CSOList that is provided by the module's input.

Remove All

name: removeAllCSOsAndGroups, type: Trigger

If pressed, all CSOs and CSOGroups (without selecting any) are being removed.

Delete (csoRemoveSelected)

name: csoRemoveSelected, type: Trigger

If pressed, the currently selected CSOs are being deleted.

New

name: groupCreateNew, type: Trigger

If pressed, a new CSOGroup is being created.

Delete (groupRemoveSelected)

name: groupRemoveSelected, type: Trigger

If pressed, the currently selected CSOGroups are being deleted.

Mode: (selectionColoringMode)

name: selectionColoringMode, type: Enum, default: SelectionColorModeFixed

Defines how the selected CSOs should be colored.

Values:

Title	Name	Description
Brighten	SelectionColorModeBrighten	Selected CSOs are brightened by the Brighten:, but maintain their general color.
Fixed	SelectionColorModeFixed	Selected CSOs are rendered in the color set by Fixed:.

Mode (selectionLineWidthMode)

name: selectionLineWidthMode, type: Enum, default: SelectionLineWidthWiden

Defines how the line width of selected CSOs is changed.

Values:

Title	Name	Description
Widen	SelectionLineWidthWiden	Selected CSOs are rendered in a relative line width to their original width, altered by Widen:.
Fixed	SelectionLineWidthFixed	Selected CSOs are rendered with an absolute line width, set by Fixed:.

Brighten:

name: selectionBrightenColor, type: Float, default: 0.2

Sets an offset to the brightness of the color of selected CSOs.

Fixed: (selectionFixedColor)

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

Sets an absolute color of selected CSOs.

Widen:

name: selectionWidenLineWidth, type: Float, default: 1

Sets an offset line width for selected CSOs.

Fixed: (selectionFixedLineWidth)

name: selectionFixedLineWidth, type: Float, default: 2

Sets an absolute line width of selected CSOs.

Id (csoSingleId)

name: csoSingleId, type: Integer, persistent: no

Shows the unique id of the (first) selected CSO. Can not be modified.

Label (csoSingleLabel)

name: csoSingleLabel, type: String, persistent: no

Shows and sets the label of the (first) selected CSO.

Description

name: csoSingleDescription, type: String, persistent: no

Shows and sets the description of the (first) selected CSO.

Time Point Index (csoSingleTimePointIndex)

name: csoSingleTimePointIndex, type: Integer, persistent: no

Shows the timepoint index of the (first) selected CSO.

Show (csoSingleShowState)

name: csoSingleShowState, type: Bool, persistent: no

If checked, the (first) selected CSO is shown by SoCSO3DVis and SoView2DCSOEditor.

Voxelize (csoSingleVoxelizeState)

name: csoSingleVoxelizeState, type: Bool, persistent: no

If checked, the (first) selected CSO is voxelized by CSOConvertToImage or CSOConvertTo3DMask.

Editable (csoSingleEditableState)

name: csoSingleEditableState, type: Bool, persistent: no

If checked, the (first) selected CSO can be edited by a processor attached to the SoView2DCSOEditor or the editor itself.

Width (csoSinglePathPointWidth)

name: csoSinglePathPointWidth, type: Float, minimum: 1, maximum: 16, persistent: no

Sets the line width of the (first) selected CSO.

Style (csoSinglePathPointStyle)

name: csoSinglePathPointStyle, type: Enum, persistent: no

Defines the line style of the (first) selected CSO.

Values:

Title	Name	Description
None	LineStyleNone	The CSO' path points are not drawn.
Solid	LineStyleSolid	The CSO is drawn as a solid line.
Dashed	LineStyleDashed	The CSO is drawn as a dashed line.
Dotted	LineStyleDotted	The CSO is drawn as a dotted line.
Short Dashed	LineStyleShortDashed	The CSO is drawn as a short dashed line (this is somewhat between dashed and dotted).

Color: (csoSinglePathPointColor)

name: csoSinglePathPointColor, type: Color, persistent: no

Sets the color of the (first) selected CSO.

Alpha: (csoSinglePathPointAlpha)

name: csoSinglePathPointAlpha, type: Float, minimum: 0, maximum: 1, persistent: no

Sets the alpha value of the (first) selected CSO.

Style (csoSingleSeedPointStyle)

name: csoSingleSeedPointStyle, type: Enum, persistent: no, deprecated name: csoSingleMarkerMode

Defines the style of the seed points.

Values:

Title	Name	Description
None	MarkerModeNone	No marker is shown at a seed point location.
Rect	MarkerModeRect	Rectangular markers are shown at the seed point locations.
Circle	MarkerModeCircle	Circular markers are shown at the seed point locations.

Color: (csoSingleSeedPointColor)

name: csoSingleSeedPointColor, type: Color, persistent: no

Sets the color of the markers representing the CSO's seed points.

Alpha: (csoSingleSeedPointAlpha)

name: csoSingleSeedPointAlpha, type: Float, minimum: 0, maximum: 1, persistent: no

Sets the alpha of the markers representing the CSO's seed points.

Size (csoSingleSeedPointSize)

name: csoSingleSeedPointSize, type: Float, persistent: no

Sets the size of the markers representing the CSO's seed points.

Mode (csoSingleVoxelWriteMode)

name: csoSingleVoxelWriteMode, type: Enum, persistent: no

Defines the voxel write mode of the (first) selected CSO.

This mode sets how the voxel value is determined when converting the CSO into a voxel mask by either CSOConvertToImage or CSOConvertTo3DMask.

Values:

Title	Name	Description
Id	VoxelWriteModeId	The target voxels have the id of the CSO as a value.
Const	VoxelWriteModeConst	The target voxels have a constant set by Value as a value.
Const Plus Id	VoxelWriteModeConstPlusId	The target voxels have their id added to the Value as a value.
Module	VoxelWriteModeModule	The converting module sets the target voxels' values.

Value (csoSingleVoxelWriteValue)

name: csoSingleVoxelWriteValue, type: Float, persistent: no

Sets the voxel value of target voxels.

Label (csoDefaultLabel)

name: csoDefaultLabel, type: String

Sets the default label for newly generated CSOs.

Desc. (csoDefaultDescription)

name: csoDefaultDescription, type: String

Sets the description string for newly generated CSOs.

Show (csoDefaultShowState)

name: csoDefaultShowState, type: Bool, default: TRUE

Sets the show state for newly generated CSOs.

Voxelize (csoDefaultVoxelizeState)

name: csoDefaultVoxelizeState, type: Bool, default: TRUE

Sets the voxelization state of newly generated CSOs.

Editable (csoDefaultEditableState)

name: csoDefaultEditableState, type: Bool, default: TRUE

Sets the edit state of newly generated CSOs.

Id (groupSingleId)

name: groupSingleId, type: Integer, persistent: no

Shows the id of the (first) selected CSOGroup.

Label (groupSingleLabel)

name: groupSingleLabel, type: String, persistent: no

Shows and sets the label of the (first) selected CSOGroup.

Desc. (groupSingleDescription)

name: groupSingleDescription, type: String, persistent: no

Shows and sets the description string of the (first) selected CSOGroup.

Use (groupSingleUseTimePointIndex)

name: groupSingleUseTimePointIndex, type: Bool, persistent: no

If checked, the CSOGroup overwrites the timepoint index of all contained CSOs.

Time Point Index (groupSingleTimePointIndex)

name: groupSingleTimePointIndex, type: Integer, persistent: no

Sets the timepoint index of the (first) selected CSOGroups.

Use (groupSingleUseShowState)

name: groupSingleUseShowState, type: Bool, persistent: no

If checked, the CSOGroup overwrites the show state of all contained CSOs.

Show (groupSingleShowState)

name: groupSingleShowState, type: Bool, persistent: no

Sets the show state of the (first) selected CSOGroups.

Voxelize (groupSingleVoxelizeState)

name: groupSingleVoxelizeState, type: Bool, persistent: no

Sets the voxelization state of the (first) selected CSOGroup.

Use (groupSingleUseVoxelizeState)

name: groupSingleUseVoxelizeState, type: Bool, persistent: no

If checked, the CSOGroup overwrites the voxelize state of all contained CSOs.

Use (groupSingleUseEditableState)

name: groupSingleUseEditableState, type: Bool, persistent: no

If checked, the CSOGroup overwrites the editable state of all contained CSOs.

Editable (groupSingleEditableState)

name: groupSingleEditableState, type: Bool, persistent: no

Sets the editable state of the (first) selected CSOGroup.

Use (groupSingleUsePathPointStyle)

name: groupSingleUsePathPointStyle, type: Bool, persistent: no

If checked, the CSOGroup overwrites the path point style of all contained CSOs.

Style (groupSinglePathPointStyle)

name: groupSinglePathPointStyle, type: Enum, persistent: no

Defines the line style of the (first) selected CSOGroup.

Values:

Title	Name	Description
None	LineStyleNone	The CSO' path points are not drawn.
Solid	LineStyleSolid	The CSOs are drawn as solid lines.
Dashed	LineStyleDashed	The CSOs are drawn as dashed lines.
Dotted	LineStyleDotted	The CSOs are drawn as dotted lines.
Short Dashed	LineStyleShortDashed	The CSOs are drawn as short dashed lines (this is somewhat between dashed and dotted).

Use (groupSingleUsePathPointWidth)

name: groupSingleUsePathPointWidth, type: Bool, persistent: no

If checked, the CSOGroup overwrites the path point width of all contained CSOs.

Width (groupSinglePathPointWidth)

name: groupSinglePathPointWidth, type: Float, minimum: 1, maximum: 16, persistent: no

Sets the line width of the (first) selected CSOGroups.

Use (groupSingleUsePathPointColor)

name: groupSingleUsePathPointColor, type: Bool, persistent: no

If checked, the CSOGroup overwrites the path point color of all contained CSOs.

Color (groupSinglePathPointColor)

name: groupSinglePathPointColor, type: Color, persistent: no

Sets the color of the (first) selected CSOGroups.

Use (groupSingleUsePathPointAlpha)

name: groupSingleUsePathPointAlpha, type: Bool, persistent: no

If checked, the CSOGroup overwrites the path point alpha value of all contained CSOs.

Alpha (groupSinglePathPointAlpha)

name: groupSinglePathPointAlpha, type: Float, minimum: 0, maximum: 1, persistent: no

Sets the alpha value of the (first) selected CSOGroups.

Use (groupSingleUseSeedPointStyle)

name: groupSingleUseSeedPointStyle, type: Bool, persistent: no

If checked, the CSOGroup overwrites the seed point style of all contained CSOs.

Style (groupSingleSeedPointStyle)

name: groupSingleSeedPointStyle, type: Enum, persistent: no, deprecated name: groupSingleMarkerMode

Defines the seed point style of all contained CSOs.

Values:

Title	Name
None	MarkerModeNone
Rect	MarkerModeRect
Circle	MarkerModeCircle

Use (groupSingleUseSeedPointSize)

name: groupSingleUseSeedPointSize, type: Bool, persistent: no

If checked, the CSOGroup overwrites the seed point size of all contained CSOs.

Size (groupSingleSeedPointSize)

name: groupSingleSeedPointSize, type: Float, persistent: no

Sets the size of the markers representing the seed points of the (first) selected CSOGroup.

Use (groupSingleUseSeedPointColor)

name: groupSingleUseSeedPointColor, type: Bool, persistent: no

If checked, the CSOGroup overwrites the seed point color of all contained CSOs.

Color (groupSingleSeedPointColor)

name: groupSingleSeedPointColor, type: Color, persistent: no

Sets the color of the markers representing the seed points of the (first) selected CSOGroup.

Use (groupSingleUseSeedPointAlpha)

name: groupSingleUseSeedPointAlpha, type: Bool, persistent: no

If checked, the CSOGroup overwrites the seed point alpha of all contained CSOs.

Alpha (groupSingleSeedPointAlpha)

name: groupSingleSeedPointAlpha, type: Float, minimum: 0, maximum: 1, persistent: no

Sets the alpha value of the markers representing the seed points of the (first) selected CSOGroup.

Use (groupSingleUseVoxelWriteMode)

name: groupSingleUseVoxelWriteMode, type: Bool, persistent: no

If checked, the CSOGroup overwrites the voxel write mode of all contained CSOs.

Mode: (groupSingleVoxelWriteMode)

name: groupSingleVoxelWriteMode, type: Enum, persistent: no

Definess the voxelization mode of the (first) selected CSOGroup.

Values:

Title	Name
Id	VoxelWriteModeId
Const	VoxelWriteModeConst
Const Plus Id	VoxelWriteModeConstPlusId
Module	VoxelWriteModeModule

Use (groupSingleUseVoxelWriteValue)

name: groupSingleUseVoxelWriteValue, type: Bool, persistent: no

If checked, the CSOGroup overwrites the voxel write value of all contained CSOs.

Value:

name: groupSingleVoxelWriteValue, type: Float, persistent: no

Sets the voxel write value of the (first) selected CSOGroup.

Maximum CSOs (groupSingleNumMaximumCSOs)

name: groupSingleNumMaximumCSOs, type: Integer, persistent: no

Sets the maximum number of CSOs that can be in a group before the Overflow Handling is applied.

A value of 0 means no limit in the number of CSOs.

Overflow Handling (groupSingleOverflowHandling)

name: groupSingleOverflowHandling, type: Enum, persistent: no

Defines how the CSOGroup should handle the situation when a CSO is added so that the Maximum CSOs is reached.

Values:

Title	Name	Description
Remove First	RemoveFirst	Remove the first CSO.
Remove Last	RemoveLast	Remove the last CSO.
Remove All	RemoveAll	Remove all previous CSOs.
Ignore New	IgnoreNew	Ignore the new CSO and do not add it to the group.

Remove CSO Handling (groupSingleRemoveFromGroupHandling)

name: groupSingleRemoveFromGroupHandling, type: Enum, persistent: no

Defines how a CSO is handled if removed from a CSOGroup.

Values:

Title	Name	Description
Always	RemoveAlways	A CSO is being removed from the CSOList if it is removed from a CSOGroup.
Never	RemoveNever	A CSO is left in the CSOList if removed from a CSOGroup.
If In No Group	RemoveIfInNoGroup	A CSO is removed from the CSOList if it is no CSOGroup after being removed from a CSOGroup.

Delete Group CSO Handling

name: groupSingleDeleteGroupCSOHandling, type: Enum, default: RemoveIfInNoGroup

Defines how a CSOGroup is handled after CSOs have been removed from it.

Values:

Title	Name	Description
Always	RemoveAlways	The CSOGroup is removed whenever a CSO is being removed from the CSOGroup.
Never	RemoveNever	The CSOGroup is left in the CSOList even if a CSO has been removed from it.
If In No Group	RemoveIfInNoGroup	The CSOGroup is removed from the CSOList if no CSOs are left in it.

Label (groupDefaultLabel)

name: groupDefaultLabel, type: String

Sets the default label for newly generated CSOGroups.

Desc. (groupDefaultDescription)

name: groupDefaultDescription, type: String

Sets the default description string of newly generated CSOGroups.

Use (groupDefaultUseShowState)

name: groupDefaultUseShowState, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrite the show state of contained CSOs.

Show (groupDefaultShowState)

name: groupDefaultShowState, type: Bool, default: TRUE

Sets the default show state for newly generated CSOGroups.

Use (groupDefaultUseVoxelizeState)

name: groupDefaultUseVoxelizeState, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the voxelize state of contained CSOs.

Voxelize (groupDefaultVoxelizeState)

name: groupDefaultVoxelizeState, type: Bool, default: TRUE

Sets the default voxelize state for newly generated CSOGroups.

Use (groupDefaultUseEditableState)

name: groupDefaultUseEditableState, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the editable state of contained CSOs.

Editable (groupDefaultEditableState)

name: groupDefaultEditableState, type: Bool, default: TRUE

Sets the default editable state for newly generated CSOGroups.

Use (groupDefaultUsePathPointStyle)

name: groupDefaultUsePathPointStyle, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the path point style of contained CSOs.

Style (groupDefaultPathPointStyle)

name: groupDefaultPathPointStyle, type: Enum, default: LineStyleSolid

Defines the default line style of newly generated CSOGroups.

Values:

Title	Name
None	LineStyleNone
Solid	LineStyleSolid
Dashed	LineStyleDashed
Dotted	LineStyleDotted
Short Dashed	LineStyleShortDashed

Use (groupDefaultUsePathPointWidth)

name: groupDefaultUsePathPointWidth, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the path point width of contained CSOs.

Width (groupDefaultPathPointWidth)

name: groupDefaultPathPointWidth, type: Float, default: 1, minimum: 1, maximum: 16

Sets the default line width for newly generated CSOGroups.

Use (groupDefaultUsePathPointColor)

name: groupDefaultUsePathPointColor, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the path point color of contained CSOs.

Color (groupDefaultPathPointColor)

name: groupDefaultPathPointColor, type: Color, default: 1 1 1

Sets the default color for newly generated CSOGroups.

Use (groupDefaultUsePathPointAlpha)

name: groupDefaultUsePathPointAlpha, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the path point alpha of contained CSOs.

Alpha (groupDefaultPathPointAlpha)

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

Set the default alpha value for newly generated CSOGroups.

Use (groupDefaultUseSeedPointStyle)

name: groupDefaultUseSeedPointStyle, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the seed point style of contained CSOs.

Style (groupDefaultSeedPointStyle)

name: groupDefaultSeedPointStyle, type: Enum, default: MarkerModeRect, deprecated name: groupDefaultMarkerMode

Defines the seed point style of all new created, contained CSO.

Values:

Title	Name
None	MarkerModeNone
Rect	MarkerModeRect
Circle	MarkerModeCircle

Use (groupDefaultUseSeedPointSize)

name: groupDefaultUseSeedPointSize, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the seed point size of contained CSOs.

Size (groupDefaultSeedPointSize)

name: groupDefaultSeedPointSize, type: Float, default: 3

If checked, newly generated CSOGroups will overwrited the marker size of contained CSOs.

Use (groupDefaultUseSeedPointColor)

name: groupDefaultUseSeedPointColor, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the seed point color of contained CSOs.

Color (groupDefaultSeedPointColor)

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

If checked, newly generated CSOGroups will overwrited the marker color of contained CSOs.

Use (groupDefaultUseSeedPointAlpha)

name: groupDefaultUseSeedPointAlpha, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the seed point alpha of contained CSOs.

Alpha (groupDefaultSeedPointAlpha)

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

If checked, newly generated CSOGroups will overwrited the marker alpha value of contained CSOs.

Use (groupDefaultUseVoxelWriteMode)

name: groupDefaultUseVoxelWriteMode, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the voxel write mode of contained CSOs.

Mode (groupDefaultVoxelWriteMode)

name: groupDefaultVoxelWriteMode, type: Enum, default: VoxelWriteModeModule

Defines the voxel write mode of newly generated CSOGroups.

Values:

Title	Name
Id	VoxelWriteModeId
Const	VoxelWriteModeConst
Const Plus Id	VoxelWriteModeConstPlusId
Module	VoxelWriteModeModule

Use (groupDefaultUseVoxelWriteValue)

name: groupDefaultUseVoxelWriteValue, type: Bool, default: FALSE

If checked, newly generated CSOGroups will overwrited the voxel write value of contained CSOs.

Value (groupDefaultVoxelWriteValue)

name: groupDefaultVoxelWriteValue, type: Float, default: 1024

Sets the voxel write value of contained CSOs.

Maximum CSOs (groupDefaultNumMaximumCSOs)

name: groupDefaultNumMaximumCSOs, type: Integer, default: 0

Sets the default maximum number of CSOs for newly generated CSOGroups.

Overflow Handling (groupDefaultOverflowHandling)

name: groupDefaultOverflowHandling, type: Enum, default: RemoveFirst

Defines the default overflow handling of newly generated CSOGroups.

Values:

Title	Name
Remove First	RemoveFirst
Remove Last	RemoveLast
Remove All	RemoveAll
Ignore New	IgnoreNew

Remove CSO Handling (groupDefaultRemoveFromGroupHandling)

name: groupDefaultRemoveFromGroupHandling, type: Enum, default: RemoveIfInNoGroup

Defines the default removal handling of newly generated CSOGroups.

Values:

Title	Name
Always	RemoveAlways
Never	RemoveNever
If In No Group	RemoveIfInNoGroup

Enable Undo Redo

name: enableUndoRedo, type: Bool, default: TRUE

If checked, undo/redo functionality is enabled for the CSOList. Undo/Redo is implemented for adding, removing and modifying CSOs, as well as for combining and breaking CSOs with CSOGroups.

Attribute changes can not be undone by the undo-manager.

Undo

name: undo, type: Trigger

If pressed, the last undoable action is undone.

Redo

name: redo, type: Trigger

If pressed, the last undo is redone.

Undo Stack Limit

name: undoStackLimit, type: Integer, default: 16, minimum: -1, maximum: 64

Sets the limit of the undo/redo stack.

If the undo/redo stack is full and the stack size decreased, the first actions are removed from the stack.

Enable (useSelectionCSONotification)

name: useSelectionCSONotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to selections of CSOs.

Enable (useSelectionGroupNotification)

name: useSelectionGroupNotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to selections of CSOGroups.

Enable (useFinishedCSONotification)

name: useFinishedCSONotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to finishing of CSOs (e.g., adding, removing a CSO).

Enable (useFinishedGroupNotification)

name: useFinishedGroupNotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to finishing of CSOGroups (e.g., adding or removing a CSOGroup).

Enable (useCSOMovedNotification)

name: useCSOMovedNotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to finished moving of CSOs.

Enable (useRepaintNotification)

name: useRepaintNotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to repaint notifications (e.g., finishing operations and modifications).

Enable (useInteractionInitNotification)

name: useInteractionInitNotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to interaction intialization notifications (e.g., deleting of a CSO or a single seed point).

Enable (useStartNewCSONotification)

name: useStartNewCSONotification, type: Bool, default: FALSE

If checked, the CSOList is able to fire and react to starting notifications (e.g., start drawing of a new CSO).

Selection (notifyOnSelectionCSO)

name: notifyOnSelectionCSO, type: Trigger

If checked, the CSOList is able to fire and react to selections of CSOs.

Selection (notifyOnSelectionGroup)

name: notifyOnSelectionGroup, type: Trigger

This field is triggered from inside the module whenever the CSOList receives a selection notification.

Finished (notifyOnFinishedCSO)

name: notifyOnFinishedCSO, type: Trigger

This field is triggered from inside the module whenever the CSOList receives a selection notification.

Finished (notifyOnFinishedGroup)

name: notifyOnFinishedGroup, type: Trigger

This field is triggered from inside the module whenever the CSOList receives a finished notification.

Moved

name: notifyOnCSOMoved, type: Trigger

This field is triggered from inside the module whenever the CSOList receives a moved notification.

Repaint

name: notifyOnRepaint, type: Trigger

This field is triggered from inside the module whenever the CSOList receives a repaint notification.

Interaction Init

name: notifyOnInteractionInit, type: Trigger

This field is triggered from inside the module whenever the CSOList receives a interaction initialization notification.

Start New CSO

name: notifyOnStartNewCSO, type: Trigger

This field is triggered from inside the module whenever the CSOList receives a start new CSO notification.

Enable selection notifications

name: enableSelectionNotification, type: Bool, default: TRUE

If checked, the selection notifications are enabled for the CSOList.

Enable finished notifications

name: enableFinishedNotification, type: Bool, default: TRUE

If checked, the finished notifications are enabled for the CSOList.

Enable moved notifications

name: enableCSOMovedNotification, type: Bool, default: TRUE

If checked, the moved notifications are enabled for the CSOList.

Enable repaint notifications

name: enableRepaintNotification, type: Bool, default: TRUE

If checked, the repaint notifications are enabled for the CSOList.

Trigger selection notification

name: triggerSelectionNotification, type: Trigger

If pressed, a selection notification is sent to the CSOList.

Trigger finished notification

name: triggerFinishedNotification, type: Trigger

If pressed, a finished notification is sent to the CSOList.

Trigger moved notification

name: triggerCSOMovedNotification, type: Trigger

If pressed, a moved notification is sent to the CSOList.

Trigger repaint notification

name: triggerRepaintNotification, type: Trigger

If pressed, a repaint notification is sent to the CSOList.

Hidden Fields

csoDisplayTree

name: csoDisplayTree, type: String, persistent: no

groupDisplayTree

name: groupDisplayTree, type: String, persistent: no

csoSelectedItems

name: csoSelectedItems, type: String, persistent: no

A space-separated string of all CSO ids that are selected. This string can be set from extern (i.e., scripting) to set the CSOs with the given ids as being selected.

groupSelectedItems

name: groupSelectedItems, type: String, persistent: no

A space-separated string of all CSOGroup ids that are selected. This string can be set from extern (i.e., scripting) to set the CSOGroups with the given ids as being selected.

groupSelectedCSOItems

name: groupSelectedCSOItems, type: String, persistent: no

csoSelectedGroupItems

name: csoSelectedGroupItems, type: String, persistent: no

addCSOtoGroup

name: addCSOtoGroup, type: Trigger

If pressed, the selected CSOs are being combines with the selected CSOGroups.

breakCSOFromGroup

name: breakCSOFromGroup, type: Trigger

If pressed, the selected CSOs are being removed from the selected CSOGroups.

csoCopySelected

name: csoCopySelected, type: Trigger

If pressed, the selected CSOs are being copied. See csoPaste.

csoPaste

name: csoPaste, type: Trigger

If pressed, the copied CSOs are being pasted into the CSOList. See csoCopySelected.

selectLastCreatedGroup

name: selectLastCreatedGroup, type: Bool, default: TRUE

groupCopySelected

name: groupCopySelected, type: Trigger

If pressed, the selected CSOGroups are being copied. See groupPaste.

groupPaste

name: groupPaste, type: Trigger

If pressed, the copied CSOGroups are being pasted into the CSOList. See groupCopySelected.

csoSingleApply

name: csoSingleApply, type: Trigger

groupDefaultUseTimePointIndex

name: groupDefaultUseTimePointIndex, type: Bool, default: FALSE

groupDefaultTimePointIndex

name: groupDefaultTimePointIndex, type: Integer, default: 0

groupSingleApply

name: groupSingleApply, type: Trigger

listSingleRemoveEmptyGroupHandling

name: listSingleRemoveEmptyGroupHandling, type: Enum, default: RemoveAlways

Values:

Title	Name
Always	RemoveAlways
Never	RemoveNever

listDefaultRemoveEmptyGroupHandling

name: listDefaultRemoveEmptyGroupHandling, type: Enum, default: RemoveAlways

Values:

Title	Name
Always	RemoveAlways
Never	RemoveNever

numUndos

name: numUndos, type: Integer, default: 0

numRedos

name: numRedos, type: Integer, default: 0

groupDefaultUseVoxelWrite

name: groupDefaultUseVoxelWrite, type: Bool, default: FALSE

groupDefaultUseVisuals

name: groupDefaultUseVisuals, type: Bool, default: FALSE

groupSingleUseMarkerSettings

name: groupSingleUseMarkerSettings, type: Bool, persistent: no

groupDefaultUseMarkerSettings

name: groupDefaultUseMarkerSettings, type: Bool, default: FALSE

groupSingleUseVisuals

name: groupSingleUseVisuals, type: Bool, persistent: no

groupSingleUseVoxelWrite

name: groupSingleUseVoxelWrite, type: Bool, persistent: no

csoTreeView

name: csoTreeView, type: String

groupTreeView

name: groupTreeView, type: String

ignoreCSOSelectionChanged

name: ignoreCSOSelectionChanged, type: Bool, persistent: no

ignoreCSOListViewSelectionChanged

name: ignoreCSOListViewSelectionChanged, type: Bool, persistent: no

ignoreGroupSelectionChanged

name: ignoreGroupSelectionChanged, type: Bool, persistent: no

ignoreGroupListViewSelectionChanged

name: ignoreGroupListViewSelectionChanged, type: Bool, persistent: no

numCSOs

name: numCSOs, type: Integer, default: 0

The number of CSO in the CSOList.

numGroups

name: numGroups, type: Integer, default: 0

The number of CSOGroups in the CSOList.

numSelectedCSOs

name: numSelectedCSOs, type: Integer, default: 0

The number of currently selected CSOs in the CSOList.

numSelectedGroups

name: numSelectedGroups, type: Integer, default: 0

The number of currently selected CSOGroups in the CSOList.

selectedCSOsGroupIds

name: selectedCSOsGroupIds, type: String