SoCSOPointEditor¶

InventorModule¶

author	`MeVis Medical Solutions AG`
package	`MeVisLab/Standard`
dll	`SoCSO`
definition	SoCSO.def
see also	`SoView2DCSOExtensibleEditor`, `SoCSOVisualizationSettings`

Purpose¶

The module SoCSOPointEditor renders and interactively generates CSOs that consist of a single point.

Usage¶

Read the documentation of the SoView2DCSOExtensibleEditor on how to attach and parametrize editor modules.

Interaction¶

Click to create a new point CSO.

Windows¶

Main¶

CSO Creation Parameters¶

Input Fields¶

inVisualizationSettings¶

name: inVisualizationSettings, type: CSOVisualizationSettings(MLBase)¶: Attach a SoCSOVisualizationSettings module to overwrite the visual settings of CSOs.

Output Fields¶

self¶

name: self, type: SoNode¶

Parameter Fields¶

Field Index¶

`Add to group mode`: `Enum`	`Extension Id`: `String`	`requirePointerPositionMovementToCreateCSO`: `Bool`
`Allow Creation`: `Bool`	`Id`: `Integer`	`Restrict To Image Boundaries`: `Bool`
`Allow Modification`: `Bool`	`Interaction Forbidden Cursor`: `Enum`	`selectionCursor`: `Enum`
`allowSeedPointInteraction`: `Bool`	`Label`: `String`	`Should Empty Group Before Generating`: `Bool`
`Alpha (defaultPathPointAlpha)`: `Float`	`labelPrefixString`: `String`	`Should Render`: `Bool`
`Alpha (defaultSeedPointAlpha)`: `Float`	`Mode`: `Enum`	`Size`: `Float`
`Color (defaultPathPointColor)`: `Color`	`moduleCreatorId`: `Integer`	`Style (defaultPathPointStyle)`: `Enum`
`Color (defaultSeedPointColor)`: `Color`	`moduleCreatorString`: `String`	`Style (defaultSeedPointStyle)`: `Enum`
`Create Cursor`: `Enum`	`Move Seed Cursor`: `Enum`	`Value`: `Float`
`csoIdUnderMouseCursor`: `Integer`	`moveAllCursor`: `Enum`	`Voxel Snap Mode`: `Enum`
`Drawing Mode`: `Enum`	`pointerPositionEpsilonForCreatingCSO`: `Integer`	`Width`: `Float`

Visible Fields¶

Extension Id¶

name: extensionId, type: String, default: point¶

Sets an ID string that is used to synchronize editors and to decide the currently active editor for creation.

Read the documentation of the SoView2DCSOExtensibleEditor for more information.

Allow Creation¶

name: allowCreation, type: Bool, default: TRUE¶: If checked, this module is allowed to create a new CSO.

Allow Modification¶

name: allowModification, type: Bool, default: TRUE¶: If checked, existing CSOs of the type of this editor can be modified.

Should Render¶

name: shouldRender, type: Bool, default: TRUE¶: If checked, this editor renders CSOs that were created by this editor.

Interaction Forbidden Cursor¶

name: interactionForbiddenCursor, type: Enum, default: FORBIDDEN_CURSOR¶: Defines the mouse cursor shown when an interaction is forbidden.

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
Cross 4 Cursor	CROSS_4_CURSOR
Cross 5 Cursor	CROSS_5_CURSOR
Cross 6 Cursor	CROSS_6_CURSOR
Cross 7 Cursor	CROSS_7_CURSOR
Cross 8 Cursor	CROSS_8_CURSOR
Cross 9 Cursor	CROSS_9_CURSOR
Lut Cursor	LUT_CURSOR
Lut 1 Cursor	LUT_1_CURSOR
Lut 2 Cursor	LUT_2_CURSOR
Lut 3 Cursor	LUT_3_CURSOR
Slicing Cursor	SLICING_CURSOR
Other Cursor 0	OTHER_CURSOR_0
Other Cursor 1	OTHER_CURSOR_1
Other Cursor 2	OTHER_CURSOR_2
Other Cursor 3	OTHER_CURSOR_3
Other Cursor 4	OTHER_CURSOR_4
Other Cursor 5	OTHER_CURSOR_5
Other Cursor 6	OTHER_CURSOR_6
Other Cursor 7	OTHER_CURSOR_7
Other Cursor 8	OTHER_CURSOR_8
Other Cursor 9	OTHER_CURSOR_9
Other Cursor 10	OTHER_CURSOR_10
Other Cursor 11	OTHER_CURSOR_11
Other Cursor 12	OTHER_CURSOR_12
Other Cursor 13	OTHER_CURSOR_13
Other Cursor 14	OTHER_CURSOR_14
Other Cursor 15	OTHER_CURSOR_15
Other Cursor 16	OTHER_CURSOR_16
Other Cursor 17	OTHER_CURSOR_17
Other Cursor 18	OTHER_CURSOR_18
Other Cursor 19	OTHER_CURSOR_19
Other Cursor 20	OTHER_CURSOR_20
Other Cursor 21	OTHER_CURSOR_21
Other Cursor 22	OTHER_CURSOR_22
Other Cursor 23	OTHER_CURSOR_23
Other Cursor 24	OTHER_CURSOR_24
Other Cursor 25	OTHER_CURSOR_25
Other Cursor 26	OTHER_CURSOR_26
Other Cursor 27	OTHER_CURSOR_27
Other Cursor 28	OTHER_CURSOR_28
Other Cursor 29	OTHER_CURSOR_29
Other Cursor 30	OTHER_CURSOR_30
Other Cursor 31	OTHER_CURSOR_31
Other Cursor 32	OTHER_CURSOR_32
Other Cursor 33	OTHER_CURSOR_33
Other Cursor 34	OTHER_CURSOR_34
Other Cursor 35	OTHER_CURSOR_35
Other Cursor 36	OTHER_CURSOR_36
Other Cursor 37	OTHER_CURSOR_37
Other Cursor 38	OTHER_CURSOR_38
Other Cursor 39	OTHER_CURSOR_39
Other Cursor 40	OTHER_CURSOR_40
Other Cursor 41	OTHER_CURSOR_41
Other Cursor 42	OTHER_CURSOR_42
Other Cursor 43	OTHER_CURSOR_43
Other Cursor 44	OTHER_CURSOR_44
Other Cursor 45	OTHER_CURSOR_45
Other Cursor 46	OTHER_CURSOR_46
Other Cursor 47	OTHER_CURSOR_47
Other Cursor 48	OTHER_CURSOR_48
Other Cursor 49	OTHER_CURSOR_49
Other Cursor 50	OTHER_CURSOR_50
Other Cursor 51	OTHER_CURSOR_51
Other Cursor 52	OTHER_CURSOR_52
Other Cursor 53	OTHER_CURSOR_53
Other Cursor 54	OTHER_CURSOR_54
Other Cursor 55	OTHER_CURSOR_55
Other Cursor 56	OTHER_CURSOR_56
Other Cursor 57	OTHER_CURSOR_57
Other Cursor 58	OTHER_CURSOR_58
Other Cursor 59	OTHER_CURSOR_59
Other Cursor 60	OTHER_CURSOR_60
Other Cursor 61	OTHER_CURSOR_61
Other Cursor 62	OTHER_CURSOR_62
Other Cursor 63	OTHER_CURSOR_63
Other Cursor 64	OTHER_CURSOR_64
Other Cursor 65	OTHER_CURSOR_65
Other Cursor 66	OTHER_CURSOR_66
Other Cursor 67	OTHER_CURSOR_67
Other Cursor 68	OTHER_CURSOR_68
Other Cursor 69	OTHER_CURSOR_69
Blank Cursor	BLANK_CURSOR

Create Cursor¶

name: createCursor, type: Enum, default: CROSS_POINT_CURSOR¶: Defines the mouse cursor shown when a new point CSO can be created.

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
Cross 4 Cursor	CROSS_4_CURSOR
Cross 5 Cursor	CROSS_5_CURSOR
Cross 6 Cursor	CROSS_6_CURSOR
Cross 7 Cursor	CROSS_7_CURSOR
Cross 8 Cursor	CROSS_8_CURSOR
Cross 9 Cursor	CROSS_9_CURSOR
Lut Cursor	LUT_CURSOR
Lut 1 Cursor	LUT_1_CURSOR
Lut 2 Cursor	LUT_2_CURSOR
Lut 3 Cursor	LUT_3_CURSOR
Slicing Cursor	SLICING_CURSOR
Other Cursor 0	OTHER_CURSOR_0
Other Cursor 1	OTHER_CURSOR_1
Other Cursor 2	OTHER_CURSOR_2
Other Cursor 3	OTHER_CURSOR_3
Other Cursor 4	OTHER_CURSOR_4
Other Cursor 5	OTHER_CURSOR_5
Other Cursor 6	OTHER_CURSOR_6
Other Cursor 7	OTHER_CURSOR_7
Other Cursor 8	OTHER_CURSOR_8
Other Cursor 9	OTHER_CURSOR_9
Other Cursor 10	OTHER_CURSOR_10
Other Cursor 11	OTHER_CURSOR_11
Other Cursor 12	OTHER_CURSOR_12
Other Cursor 13	OTHER_CURSOR_13
Other Cursor 14	OTHER_CURSOR_14
Other Cursor 15	OTHER_CURSOR_15
Other Cursor 16	OTHER_CURSOR_16
Other Cursor 17	OTHER_CURSOR_17
Other Cursor 18	OTHER_CURSOR_18
Other Cursor 19	OTHER_CURSOR_19
Other Cursor 20	OTHER_CURSOR_20
Other Cursor 21	OTHER_CURSOR_21
Other Cursor 22	OTHER_CURSOR_22
Other Cursor 23	OTHER_CURSOR_23
Other Cursor 24	OTHER_CURSOR_24
Other Cursor 25	OTHER_CURSOR_25
Other Cursor 26	OTHER_CURSOR_26
Other Cursor 27	OTHER_CURSOR_27
Other Cursor 28	OTHER_CURSOR_28
Other Cursor 29	OTHER_CURSOR_29
Other Cursor 30	OTHER_CURSOR_30
Other Cursor 31	OTHER_CURSOR_31
Other Cursor 32	OTHER_CURSOR_32
Other Cursor 33	OTHER_CURSOR_33
Other Cursor 34	OTHER_CURSOR_34
Other Cursor 35	OTHER_CURSOR_35
Other Cursor 36	OTHER_CURSOR_36
Other Cursor 37	OTHER_CURSOR_37
Other Cursor 38	OTHER_CURSOR_38
Other Cursor 39	OTHER_CURSOR_39
Other Cursor 40	OTHER_CURSOR_40
Other Cursor 41	OTHER_CURSOR_41
Other Cursor 42	OTHER_CURSOR_42
Other Cursor 43	OTHER_CURSOR_43
Other Cursor 44	OTHER_CURSOR_44
Other Cursor 45	OTHER_CURSOR_45
Other Cursor 46	OTHER_CURSOR_46
Other Cursor 47	OTHER_CURSOR_47
Other Cursor 48	OTHER_CURSOR_48
Other Cursor 49	OTHER_CURSOR_49
Other Cursor 50	OTHER_CURSOR_50
Other Cursor 51	OTHER_CURSOR_51
Other Cursor 52	OTHER_CURSOR_52
Other Cursor 53	OTHER_CURSOR_53
Other Cursor 54	OTHER_CURSOR_54
Other Cursor 55	OTHER_CURSOR_55
Other Cursor 56	OTHER_CURSOR_56
Other Cursor 57	OTHER_CURSOR_57
Other Cursor 58	OTHER_CURSOR_58
Other Cursor 59	OTHER_CURSOR_59
Other Cursor 60	OTHER_CURSOR_60
Other Cursor 61	OTHER_CURSOR_61
Other Cursor 62	OTHER_CURSOR_62
Other Cursor 63	OTHER_CURSOR_63
Other Cursor 64	OTHER_CURSOR_64
Other Cursor 65	OTHER_CURSOR_65
Other Cursor 66	OTHER_CURSOR_66
Other Cursor 67	OTHER_CURSOR_67
Other Cursor 68	OTHER_CURSOR_68
Other Cursor 69	OTHER_CURSOR_69
Blank Cursor	BLANK_CURSOR

Move Seed Cursor¶

name: moveSeedCursor, type: Enum, default: CROSS_CURSOR¶: Defines the mouse cursor shown when a hit point CSO is moved.

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
Cross 4 Cursor	CROSS_4_CURSOR
Cross 5 Cursor	CROSS_5_CURSOR
Cross 6 Cursor	CROSS_6_CURSOR
Cross 7 Cursor	CROSS_7_CURSOR
Cross 8 Cursor	CROSS_8_CURSOR
Cross 9 Cursor	CROSS_9_CURSOR
Lut Cursor	LUT_CURSOR
Lut 1 Cursor	LUT_1_CURSOR
Lut 2 Cursor	LUT_2_CURSOR
Lut 3 Cursor	LUT_3_CURSOR
Slicing Cursor	SLICING_CURSOR
Other Cursor 0	OTHER_CURSOR_0
Other Cursor 1	OTHER_CURSOR_1
Other Cursor 2	OTHER_CURSOR_2
Other Cursor 3	OTHER_CURSOR_3
Other Cursor 4	OTHER_CURSOR_4
Other Cursor 5	OTHER_CURSOR_5
Other Cursor 6	OTHER_CURSOR_6
Other Cursor 7	OTHER_CURSOR_7
Other Cursor 8	OTHER_CURSOR_8
Other Cursor 9	OTHER_CURSOR_9
Other Cursor 10	OTHER_CURSOR_10
Other Cursor 11	OTHER_CURSOR_11
Other Cursor 12	OTHER_CURSOR_12
Other Cursor 13	OTHER_CURSOR_13
Other Cursor 14	OTHER_CURSOR_14
Other Cursor 15	OTHER_CURSOR_15
Other Cursor 16	OTHER_CURSOR_16
Other Cursor 17	OTHER_CURSOR_17
Other Cursor 18	OTHER_CURSOR_18
Other Cursor 19	OTHER_CURSOR_19
Other Cursor 20	OTHER_CURSOR_20
Other Cursor 21	OTHER_CURSOR_21
Other Cursor 22	OTHER_CURSOR_22
Other Cursor 23	OTHER_CURSOR_23
Other Cursor 24	OTHER_CURSOR_24
Other Cursor 25	OTHER_CURSOR_25
Other Cursor 26	OTHER_CURSOR_26
Other Cursor 27	OTHER_CURSOR_27
Other Cursor 28	OTHER_CURSOR_28
Other Cursor 29	OTHER_CURSOR_29
Other Cursor 30	OTHER_CURSOR_30
Other Cursor 31	OTHER_CURSOR_31
Other Cursor 32	OTHER_CURSOR_32
Other Cursor 33	OTHER_CURSOR_33
Other Cursor 34	OTHER_CURSOR_34
Other Cursor 35	OTHER_CURSOR_35
Other Cursor 36	OTHER_CURSOR_36
Other Cursor 37	OTHER_CURSOR_37
Other Cursor 38	OTHER_CURSOR_38
Other Cursor 39	OTHER_CURSOR_39
Other Cursor 40	OTHER_CURSOR_40
Other Cursor 41	OTHER_CURSOR_41
Other Cursor 42	OTHER_CURSOR_42
Other Cursor 43	OTHER_CURSOR_43
Other Cursor 44	OTHER_CURSOR_44
Other Cursor 45	OTHER_CURSOR_45
Other Cursor 46	OTHER_CURSOR_46
Other Cursor 47	OTHER_CURSOR_47
Other Cursor 48	OTHER_CURSOR_48
Other Cursor 49	OTHER_CURSOR_49
Other Cursor 50	OTHER_CURSOR_50
Other Cursor 51	OTHER_CURSOR_51
Other Cursor 52	OTHER_CURSOR_52
Other Cursor 53	OTHER_CURSOR_53
Other Cursor 54	OTHER_CURSOR_54
Other Cursor 55	OTHER_CURSOR_55
Other Cursor 56	OTHER_CURSOR_56
Other Cursor 57	OTHER_CURSOR_57
Other Cursor 58	OTHER_CURSOR_58
Other Cursor 59	OTHER_CURSOR_59
Other Cursor 60	OTHER_CURSOR_60
Other Cursor 61	OTHER_CURSOR_61
Other Cursor 62	OTHER_CURSOR_62
Other Cursor 63	OTHER_CURSOR_63
Other Cursor 64	OTHER_CURSOR_64
Other Cursor 65	OTHER_CURSOR_65
Other Cursor 66	OTHER_CURSOR_66
Other Cursor 67	OTHER_CURSOR_67
Other Cursor 68	OTHER_CURSOR_68
Other Cursor 69	OTHER_CURSOR_69
Blank Cursor	BLANK_CURSOR

Should Empty Group Before Generating¶

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

If checked, a target CSOGroup is emptied before adding a newly created CSO into it.

This option depends on the Add to group mode.

Add to group mode¶

name: addCSOToGroupMode, type: Enum, default: GROUP_NONE¶: Defines whether and how a newly created CSO is added to a CSOGroup.

Values:

Title

Name

Description

None

GROUP_NONE

A newly created CSO is not added to any group.

By Label

GROUP_BY_LABEL

A newly created CSO is added to a CSOGroup that is given by a label in Label.

If a CSOGroup with the given label does not already exist, it is created before being filled.

The label “” is invalid; adding a CSO to the CSOGroup with label “” means adding the CSO to no CSOGroup.

By Id

GROUP_BY_ID

A newly created CSO is added to a CSOGroup that is given by an ID in Id.

If a CSOGroup with the given ID does not already exist, it is created before being filled.

The ID -1 is invalid; adding a CSO to the CSOGroup with ID -1 means adding the CSO to no CSOGroup.

Label¶

name: addCSOToGroupLabel, type: String¶: Sets a label for a group that should be associated with a newly created CSO.

Id¶

name: addCSOToGroupId, type: Integer, default: -1, minimum: -1¶: Sets an ID for a group that should be associated with a newly created CSO.

Style (defaultPathPointStyle)¶

name: defaultPathPointStyle, type: Enum, default: PATH_POINTS_STYLE_SOLID¶: Defines a default line style for a newly created CSO.

Values:

Title	Name	Description
None	PATH_POINTS_STYLE_NONE	Path points are invisible.
Solid	PATH_POINTS_STYLE_SOLID	Path points are rendered as a solid line.
Dashed	PATH_POINTS_STYLE_DASHED	Path points are rendered as a dashed line.
Dotted	PATH_POINTS_STYLE_DOTTED	Path points are rendered as a dotted line.
Short Dashed	PATH_POINTS_STYLE_SHORT_DASHED	Path points are rendered as a short dashed line.

Width¶

name: defaultPathPointWidth, type: Float, default: 1, minimum: 1, maximum: 8¶: Sets a default line width for newly created CSOs.

Color (defaultPathPointColor)¶

name: defaultPathPointColor, type: Color, default: 1 1 1¶: Sets a default line color for newly created CSOs.

Alpha (defaultPathPointAlpha)¶

name: defaultPathPointAlpha, type: Float, default: 1, minimum: 0, maximum: 1¶: Sets a default line alpha value for newly created CSOs.

Style (defaultSeedPointStyle)¶

name: defaultSeedPointStyle, type: Enum, default: SEED_POINT_STYLE_RECTANGLE¶: Defines a default seed point style for newly created CSOs.

Values:

Title	Name	Description
None	SEED_POINT_STYLE_NONE	Seed points are invisible.
Rectangle	SEED_POINT_STYLE_RECTANGLE	Seed points are rendered as rectangles.
Circle	SEED_POINT_STYLE_CIRCLE	Seed points are rendered as circles.
Fixed Size Circle	SEED_POINT_STYLE_FIXED_SIZE_CIRCLE	Seed points are rendered as filled circles with a fixed size.
Triangle	SEED_POINT_STYLE_TRIANGLE	Seed points are rendered as triangles.
Filled Rectangle	SEED_POINT_STYLE_FILLED_RECTANGLE	Seed points are rendered as filled rectangles.
Filled Circle	SEED_POINT_STYLE_FILLED_CIRCLE	Seed points are rendered as filled circles.
Filled Triangle	SEED_POINT_STYLE_FILLED_TRIANGLE	Seed points are rendered as filled triangles.
Dashed Rectangle	SEED_POINT_STYLE_DASHED_RECTANGLE	Seed points are rendered as dashed rectangles.

Size¶

name: defaultSeedPointSize, type: Float, default: 3, minimum: 1, maximum: 16¶: Sets the default size for seed points for newly created CSOs.

Color (defaultSeedPointColor)¶

name: defaultSeedPointColor, type: Color, default: 1 1 1¶: Sets the default color for seed points for newly created CSOs.

Alpha (defaultSeedPointAlpha)¶

name: defaultSeedPointAlpha, type: Float, default: 1, minimum: 0, maximum: 1¶: Sets the default alpha value for seed points for newly created CSOs.

Mode¶

name: defaultVoxelWriteMode, type: Enum, default: VOXEL_WRITE_MODULE¶: Defines the default voxel write mode for newly created CSOs.

Values:

Title	Name	Deprecated Name	Description
Id	VOXEL_WRITE_ID	VOXEL_VALUE_ID	The CSO ID is used as a voxel write value.
Const	VOXEL_WRITE_CONST	VOXEL_VALUE_CONST	A constant value is used as a voxel write value. This constant value is set by `Value`.
Const Plus Id	VOXEL_WRITE_CONST_PLUS_ID	VOXEL_VALUE_CONST_PLUS_ID	The CSO ID added to the constant value is used as a voxel write value.
Module	VOXEL_WRITE_MODULE	VOXEL_VALUE_MODULE	The voxelizing module sets the voxel write value.

Value¶

name: defaultVoxelWriteValue, type: Float, default: 1024¶: Sets a constant value that is used as voxel write value or an offset of that.

Drawing Mode¶

name: drawingMode, type: Enum, default: POINT_DRAWING_MODE_POINT¶: Defines the drawing mode for this CSO.

Values:

Title	Name	Description
Point	POINT_DRAWING_MODE_POINT	The CSO is drawn as a point.
Crosshair	POINT_DRAWING_MODE_CROSSHAIR	The CSO is drawn as a crosshair.

Voxel Snap Mode¶

name: voxelSnapMode, type: Enum, default: SNAP_OFF¶

Defines the voxel snap mode.

Generally, when the point CSO is created, it is placed at the center of the image’s voxel in the z-direction.

Values:

Title	Name	Description
Off	SNAP_OFF	Voxel snapping is disabled. The point CSO is placed at the mouse cursor.
Xy	SNAP_XY	The point CSO snaps to the center of a voxel in the x- and y-directions.
Z	SNAP_Z	The point CSO snaps to the center of a voxel in the z-direction.
Xyz	SNAP_XYZ	The point CSO snaps to the center of a voxel in the x-, y-, and z-directions.

Restrict To Image Boundaries¶

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

If checked, new or edited points are restricted to the area of the image underlay.

This supersedes the flag SoView2DCSOExtensibleEditor.needsValidVoxel, which restricts the entire interaction with CSOs to the area of the image underlay. So you should only use one of these flags and leave the other one off.

Hidden Fields¶

allowSeedPointInteraction¶

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

If checked, a seed point can interactively be moved.

Otherwise, the entire CSO is moved.

selectionCursor¶

name: selectionCursor, type: Enum, default: POINTING_HAND_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
Cross 4 Cursor	CROSS_4_CURSOR
Cross 5 Cursor	CROSS_5_CURSOR
Cross 6 Cursor	CROSS_6_CURSOR
Cross 7 Cursor	CROSS_7_CURSOR
Cross 8 Cursor	CROSS_8_CURSOR
Cross 9 Cursor	CROSS_9_CURSOR
Lut Cursor	LUT_CURSOR
Lut 1 Cursor	LUT_1_CURSOR
Lut 2 Cursor	LUT_2_CURSOR
Lut 3 Cursor	LUT_3_CURSOR
Slicing Cursor	SLICING_CURSOR
Other Cursor 0	OTHER_CURSOR_0
Other Cursor 1	OTHER_CURSOR_1
Other Cursor 2	OTHER_CURSOR_2
Other Cursor 3	OTHER_CURSOR_3
Other Cursor 4	OTHER_CURSOR_4
Other Cursor 5	OTHER_CURSOR_5
Other Cursor 6	OTHER_CURSOR_6
Other Cursor 7	OTHER_CURSOR_7
Other Cursor 8	OTHER_CURSOR_8
Other Cursor 9	OTHER_CURSOR_9
Other Cursor 10	OTHER_CURSOR_10
Other Cursor 11	OTHER_CURSOR_11
Other Cursor 12	OTHER_CURSOR_12
Other Cursor 13	OTHER_CURSOR_13
Other Cursor 14	OTHER_CURSOR_14
Other Cursor 15	OTHER_CURSOR_15
Other Cursor 16	OTHER_CURSOR_16
Other Cursor 17	OTHER_CURSOR_17
Other Cursor 18	OTHER_CURSOR_18
Other Cursor 19	OTHER_CURSOR_19
Other Cursor 20	OTHER_CURSOR_20
Other Cursor 21	OTHER_CURSOR_21
Other Cursor 22	OTHER_CURSOR_22
Other Cursor 23	OTHER_CURSOR_23
Other Cursor 24	OTHER_CURSOR_24
Other Cursor 25	OTHER_CURSOR_25
Other Cursor 26	OTHER_CURSOR_26
Other Cursor 27	OTHER_CURSOR_27
Other Cursor 28	OTHER_CURSOR_28
Other Cursor 29	OTHER_CURSOR_29
Other Cursor 30	OTHER_CURSOR_30
Other Cursor 31	OTHER_CURSOR_31
Other Cursor 32	OTHER_CURSOR_32
Other Cursor 33	OTHER_CURSOR_33
Other Cursor 34	OTHER_CURSOR_34
Other Cursor 35	OTHER_CURSOR_35
Other Cursor 36	OTHER_CURSOR_36
Other Cursor 37	OTHER_CURSOR_37
Other Cursor 38	OTHER_CURSOR_38
Other Cursor 39	OTHER_CURSOR_39
Other Cursor 40	OTHER_CURSOR_40
Other Cursor 41	OTHER_CURSOR_41
Other Cursor 42	OTHER_CURSOR_42
Other Cursor 43	OTHER_CURSOR_43
Other Cursor 44	OTHER_CURSOR_44
Other Cursor 45	OTHER_CURSOR_45
Other Cursor 46	OTHER_CURSOR_46
Other Cursor 47	OTHER_CURSOR_47
Other Cursor 48	OTHER_CURSOR_48
Other Cursor 49	OTHER_CURSOR_49
Other Cursor 50	OTHER_CURSOR_50
Other Cursor 51	OTHER_CURSOR_51
Other Cursor 52	OTHER_CURSOR_52
Other Cursor 53	OTHER_CURSOR_53
Other Cursor 54	OTHER_CURSOR_54
Other Cursor 55	OTHER_CURSOR_55
Other Cursor 56	OTHER_CURSOR_56
Other Cursor 57	OTHER_CURSOR_57
Other Cursor 58	OTHER_CURSOR_58
Other Cursor 59	OTHER_CURSOR_59
Other Cursor 60	OTHER_CURSOR_60
Other Cursor 61	OTHER_CURSOR_61
Other Cursor 62	OTHER_CURSOR_62
Other Cursor 63	OTHER_CURSOR_63
Other Cursor 64	OTHER_CURSOR_64
Other Cursor 65	OTHER_CURSOR_65
Other Cursor 66	OTHER_CURSOR_66
Other Cursor 67	OTHER_CURSOR_67
Other Cursor 68	OTHER_CURSOR_68
Other Cursor 69	OTHER_CURSOR_69
Blank Cursor	BLANK_CURSOR

csoIdUnderMouseCursor¶

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

Shows the ID of the CSO currently under the mouse cursor, i.e., the CSO that will receive mouse events.

This field is only touched if its value changes.

moduleCreatorId¶

name: moduleCreatorId, type: Integer, default: 0¶: Sets a creator ID. This ID is stored in the CSO as user data.

moduleCreatorString¶

name: moduleCreatorString, type: String, default: SoCSOPointEditor¶: Sets a module creator string. This string is stored in the CSO as user data.

labelPrefixString¶

name: labelPrefixString, type: String, default: CSO¶: Sets a label prefix string. This string is stored in the CSO as user data.

requirePointerPositionMovementToCreateCSO¶

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

If checked, a new CSO is only created if the mouse is dragged more than pointerPositionEpsilonForCreatingCSO pixels.

Otherwise, no CSO is generated on releasing the mouse. Use this option to prevent points or otherwise too short CSOs.

pointerPositionEpsilonForCreatingCSO¶

name: pointerPositionEpsilonForCreatingCSO, type: Integer, default: 1¶: Sets a minimum movement epsilon in pixels before a new CSO is created on dragging the mouse.

moveAllCursor¶

name: moveAllCursor, type: Enum, default: MOVE_ALL_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
Cross 4 Cursor	CROSS_4_CURSOR
Cross 5 Cursor	CROSS_5_CURSOR
Cross 6 Cursor	CROSS_6_CURSOR
Cross 7 Cursor	CROSS_7_CURSOR
Cross 8 Cursor	CROSS_8_CURSOR
Cross 9 Cursor	CROSS_9_CURSOR
Lut Cursor	LUT_CURSOR
Lut 1 Cursor	LUT_1_CURSOR
Lut 2 Cursor	LUT_2_CURSOR
Lut 3 Cursor	LUT_3_CURSOR
Slicing Cursor	SLICING_CURSOR
Other Cursor 0	OTHER_CURSOR_0
Other Cursor 1	OTHER_CURSOR_1
Other Cursor 2	OTHER_CURSOR_2
Other Cursor 3	OTHER_CURSOR_3
Other Cursor 4	OTHER_CURSOR_4
Other Cursor 5	OTHER_CURSOR_5
Other Cursor 6	OTHER_CURSOR_6
Other Cursor 7	OTHER_CURSOR_7
Other Cursor 8	OTHER_CURSOR_8
Other Cursor 9	OTHER_CURSOR_9
Other Cursor 10	OTHER_CURSOR_10
Other Cursor 11	OTHER_CURSOR_11
Other Cursor 12	OTHER_CURSOR_12
Other Cursor 13	OTHER_CURSOR_13
Other Cursor 14	OTHER_CURSOR_14
Other Cursor 15	OTHER_CURSOR_15
Other Cursor 16	OTHER_CURSOR_16
Other Cursor 17	OTHER_CURSOR_17
Other Cursor 18	OTHER_CURSOR_18
Other Cursor 19	OTHER_CURSOR_19
Other Cursor 20	OTHER_CURSOR_20
Other Cursor 21	OTHER_CURSOR_21
Other Cursor 22	OTHER_CURSOR_22
Other Cursor 23	OTHER_CURSOR_23
Other Cursor 24	OTHER_CURSOR_24
Other Cursor 25	OTHER_CURSOR_25
Other Cursor 26	OTHER_CURSOR_26
Other Cursor 27	OTHER_CURSOR_27
Other Cursor 28	OTHER_CURSOR_28
Other Cursor 29	OTHER_CURSOR_29
Other Cursor 30	OTHER_CURSOR_30
Other Cursor 31	OTHER_CURSOR_31
Other Cursor 32	OTHER_CURSOR_32
Other Cursor 33	OTHER_CURSOR_33
Other Cursor 34	OTHER_CURSOR_34
Other Cursor 35	OTHER_CURSOR_35
Other Cursor 36	OTHER_CURSOR_36
Other Cursor 37	OTHER_CURSOR_37
Other Cursor 38	OTHER_CURSOR_38
Other Cursor 39	OTHER_CURSOR_39
Other Cursor 40	OTHER_CURSOR_40
Other Cursor 41	OTHER_CURSOR_41
Other Cursor 42	OTHER_CURSOR_42
Other Cursor 43	OTHER_CURSOR_43
Other Cursor 44	OTHER_CURSOR_44
Other Cursor 45	OTHER_CURSOR_45
Other Cursor 46	OTHER_CURSOR_46
Other Cursor 47	OTHER_CURSOR_47
Other Cursor 48	OTHER_CURSOR_48
Other Cursor 49	OTHER_CURSOR_49
Other Cursor 50	OTHER_CURSOR_50
Other Cursor 51	OTHER_CURSOR_51
Other Cursor 52	OTHER_CURSOR_52
Other Cursor 53	OTHER_CURSOR_53
Other Cursor 54	OTHER_CURSOR_54
Other Cursor 55	OTHER_CURSOR_55
Other Cursor 56	OTHER_CURSOR_56
Other Cursor 57	OTHER_CURSOR_57
Other Cursor 58	OTHER_CURSOR_58
Other Cursor 59	OTHER_CURSOR_59
Other Cursor 60	OTHER_CURSOR_60
Other Cursor 61	OTHER_CURSOR_61
Other Cursor 62	OTHER_CURSOR_62
Other Cursor 63	OTHER_CURSOR_63
Other Cursor 64	OTHER_CURSOR_64
Other Cursor 65	OTHER_CURSOR_65
Other Cursor 66	OTHER_CURSOR_66
Other Cursor 67	OTHER_CURSOR_67
Other Cursor 68	OTHER_CURSOR_68
Other Cursor 69	OTHER_CURSOR_69
Blank Cursor	BLANK_CURSOR

SoCSOPointEditor¶

Purpose¶

Usage¶

Interaction¶

Windows¶

Main¶

CSO Creation Parameters¶

Input Fields¶

inVisualizationSettings¶

Output Fields¶

self¶

Parameter Fields¶

Field Index¶

Visible Fields¶

Extension Id¶

Allow Creation¶

Allow Modification¶

Should Render¶

Interaction Forbidden Cursor¶

Create Cursor¶

Move Seed Cursor¶

Should Empty Group Before Generating¶

Add to group mode¶

Label¶

Id¶

Style (defaultPathPointStyle)¶

Width¶

Color (defaultPathPointColor)¶

Alpha (defaultPathPointAlpha)¶

Style (defaultSeedPointStyle)¶

Size¶

Color (defaultSeedPointColor)¶

Alpha (defaultSeedPointAlpha)¶

Mode¶

Value¶

Drawing Mode¶

Voxel Snap Mode¶

Restrict To Image Boundaries¶

Hidden Fields¶

allowSeedPointInteraction¶

selectionCursor¶

csoIdUnderMouseCursor¶

moduleCreatorId¶

moduleCreatorString¶

labelPrefixString¶

requirePointerPositionMovementToCreateCSO¶

pointerPositionEpsilonForCreatingCSO¶

moveAllCursor¶

Table of Contents

Quick search