Detailed Description

A class that wraps CSOEvents objects for use in scripting.

Member Enumeration Documentation

◆ CSOEventType

Enumeration for specifying the exact type of event.

Enumerator
NONE	Empty event.
MODULE_EVENT	Event triggered by module code.
CSOLIST_EVENT_GROUP_OPEN	Opening an event group.
CSOLIST_EVENT_GROUP_CLOSE	Closing an event group.
CSOLIST_CLEAR	Clearing the CSOList.
CSOLIST_CLONE	Cloning the CSOList.
CSOLIST_MERGE	Merging the CSOList with another CSOList.
CSOLIST_LOAD	Loading the CSOList.
CSO_ADD	Adding a CSO to the CSOList.
CSO_REMOVE	Removing a CSO from the CSOList.
CSO_MODIFICATION	Changing a CSO by a CSOModificator algorithm.
CSO_COPY	Copying the CSO.
CSO_CLOSING	Closing the CSO geometrically.
CSO_OPENING	Opening the CSO geometrically.
CSO_GEOMETRY_CHANGE	Changing the geometry of the CSO.
CSO_DELETE_SEEDPOINT	Deleting a seed point from the CSO.
CSO_MOUSE_OVER_CHANGE	Changing the mouse-over state of the CSO.
CSO_SELECTION_CHANGE	Changing the selection state of the CSO.
CSO_USER_DATA_CHANGE	Changing user data stored in the CSO.
CSO_VISUAL_ATTRIBUTE_CHANGE	Changing any visual attribute of the CSO.
CSO_LABEL	Changing the label string of the CSO.
CSO_DESCRIPTION	Changing the description string of the CSO.
CSO_TIMEPOINT_INDEX	Changing the time point index of the CSO.
CSO_SHOW_STATE	Changing the show state of the CSO.
CSO_EDITABLE_STATE	Changing the editable state of the CSO.
CSO_VOXELIZE_STATE	Changing the voxelize state of the CSO.
CSO_VOXEL_WRITE_MODE	Changing the voxel write mode of the CSO.
CSO_VOXEL_WRITE_VALUE	Changing the voxel write value of the CSO.
GROUP_ADD	Adding a CSOGroup to the CSOList.
GROUP_REMOVE	Removing a CSOGroup from the CSOList.
GROUP_CLEAR	Clearing a CSOGroup's internals without removing the CSOGroup itself.
GROUP_COPY	Copying the CSOGroup.
CSO_ADD_TO_GROUP	Adding a CSO to the CSOGroup.
CSO_REMOVE_FROM_GROUP	Removing a CSO from the CSOGroup.
GROUP_SELECTION_CHANGE	Changing the selection state of the CSOGroup.
GROUP_USER_DATA_CHANGE	Changing user data stored in the CSOGroup.
GROUP_VISUAL_ATTRIBUTE_CHANGE	Changing any visual attribute of the CSOGroup.
GROUP_LABEL	Changing the label string of the CSOGroup.
GROUP_DESCRIPTION	Changing the description string of the CSOGroup.
GROUP_TIMEPOINT_INDEX	Changing the time point index of the CSOGroup.
GROUP_SHOW_STATE	Changing the show state of the CSOGroup.
GROUP_EDITABLE_STATE	Changing the editable state of the CSOGroup.
GROUP_VOXELIZE_STATE	Changing the voxelize state of the CSOGroup.
GROUP_VOXEL_WRITE_MODE	Changing the voxel write mode of the CSOGroup.
GROUP_VOXEL_WRITE_VALUE	Changing the voxel write value of the CSOGroup.
CSO_INTERACTION	Starting/ending an interaction with the CSO.
CSO_CREATION	Starting/ending the interactive creation of a CSO.
NUM_CSO_EVENTS	The number of event enum entries.

Member Function Documentation

◆ csoIds

QList< unsigned int > MLCSOEventWrapper::csoIds ( ) const

slot

Returns the vector with CSO IDs.

◆ customMessage

QString MLCSOEventWrapper::customMessage ( ) const

slot

Returns the custom message string. This can be used to identify the method or the subroutine from where the event is sent.

◆ eventType

CSOEventType MLCSOEventWrapper::eventType ( ) const

slot

Returns the event type.

◆ eventTypeName

QString MLCSOEventWrapper::eventTypeName ( ) const

slot

Returns the event type as a string - please do not expect that these strings will stay the same (they are only meant for debugging).

Rather use eventType with the CSOEventType constants.

◆ groupIds

QList< unsigned int > MLCSOEventWrapper::groupIds ( ) const

slot

Returns the vector with CSOGroup ID.

◆ isPostCommand

bool MLCSOEventWrapper::isPostCommand ( ) const

slot

Returns whether the event is a post-command.

◆ isPreCommand

bool MLCSOEventWrapper::isPreCommand ( ) const

slot

Returns whether the event is a pre-command.

◆ senderName

QString MLCSOEventWrapper::senderName ( ) const

slot

Returns the sender name string. This is typically the module instance name from where the event is sent.

◆ senderType

QString MLCSOEventWrapper::senderType ( ) const

slot

Returns the sender type string. This is typically the module type from where the event is sent.