MLCSOEventWrapper Class Reference

#include <mlCSOEventWrapper.h>

Inherits QObject.

Public Types
enum	CSOEventType {   NONE = ml::CSOEvent::NONE , MODULE_EVENT = ml::CSOEvent::MODULE_EVENT , CSOLIST_EVENT_GROUP_OPEN = ml::CSOEvent::CSOLIST_EVENT_GROUP_OPEN , CSOLIST_EVENT_GROUP_CLOSE = ml::CSOEvent::CSOLIST_EVENT_GROUP_CLOSE ,   CSOLIST_CLEAR = ml::CSOEvent::CSOLIST_CLEAR , CSOLIST_CLONE = ml::CSOEvent::CSOLIST_CLONE , CSOLIST_MERGE = ml::CSOEvent::CSOLIST_MERGE , CSOLIST_LOAD = ml::CSOEvent::CSOLIST_LOAD ,   CSO_ADD = ml::CSOEvent::CSO_ADD , CSO_REMOVE = ml::CSOEvent::CSO_REMOVE , CSO_MODIFICATION = ml::CSOEvent::CSO_MODIFICATION , CSO_COPY = ml::CSOEvent::CSO_COPY ,   CSO_CLOSING = ml::CSOEvent::CSO_CLOSING , CSO_OPENING = ml::CSOEvent::CSO_OPENING , CSO_GEOMETRY_CHANGE = ml::CSOEvent::CSO_GEOMETRY_CHANGE , CSO_DELETE_SEEDPOINT = ml::CSOEvent::CSO_DELETE_SEEDPOINT ,   CSO_MOUSE_OVER_CHANGE = ml::CSOEvent::CSO_MOUSE_OVER_CHANGE , CSO_SELECTION_CHANGE = ml::CSOEvent::CSO_SELECTION_CHANGE , CSO_USER_DATA_CHANGE = ml::CSOEvent::CSO_USER_DATA_CHANGE , CSO_VISUAL_ATTRIBUTE_CHANGE = ml::CSOEvent::CSO_VISUAL_ATTRIBUTE_CHANGE ,   CSO_LABEL = ml::CSOEvent::CSO_LABEL , CSO_DESCRIPTION = ml::CSOEvent::CSO_DESCRIPTION , CSO_TIMEPOINT_INDEX = ml::CSOEvent::CSO_TIMEPOINT_INDEX , CSO_SHOW_STATE = ml::CSOEvent::CSO_SHOW_STATE ,   CSO_EDITABLE_STATE = ml::CSOEvent::CSO_EDITABLE_STATE , CSO_VOXELIZE_STATE = ml::CSOEvent::CSO_VOXELIZE_STATE , CSO_VOXEL_WRITE_MODE = ml::CSOEvent::CSO_VOXEL_WRITE_MODE , CSO_VOXEL_WRITE_VALUE = ml::CSOEvent::CSO_VOXEL_WRITE_VALUE ,   GROUP_ADD = ml::CSOEvent::GROUP_ADD , GROUP_REMOVE = ml::CSOEvent::GROUP_REMOVE , GROUP_CLEAR = ml::CSOEvent::GROUP_CLEAR , GROUP_COPY = ml::CSOEvent::GROUP_COPY ,   CSO_ADD_TO_GROUP = ml::CSOEvent::CSO_ADD_TO_GROUP , CSO_REMOVE_FROM_GROUP = ml::CSOEvent::CSO_REMOVE_FROM_GROUP , GROUP_SELECTION_CHANGE = ml::CSOEvent::GROUP_SELECTION_CHANGE , GROUP_USER_DATA_CHANGE = ml::CSOEvent::GROUP_USER_DATA_CHANGE ,   GROUP_VISUAL_ATTRIBUTE_CHANGE = ml::CSOEvent::GROUP_VISUAL_ATTRIBUTE_CHANGE , GROUP_LABEL = ml::CSOEvent::GROUP_LABEL , GROUP_DESCRIPTION = ml::CSOEvent::GROUP_DESCRIPTION , GROUP_TIMEPOINT_INDEX = ml::CSOEvent::GROUP_TIMEPOINT_INDEX ,   GROUP_SHOW_STATE = ml::CSOEvent::GROUP_SHOW_STATE , GROUP_EDITABLE_STATE = ml::CSOEvent::GROUP_EDITABLE_STATE , GROUP_VOXELIZE_STATE = ml::CSOEvent::GROUP_VOXELIZE_STATE , GROUP_VOXEL_WRITE_MODE = ml::CSOEvent::GROUP_VOXEL_WRITE_MODE ,   GROUP_VOXEL_WRITE_VALUE = ml::CSOEvent::GROUP_VOXEL_WRITE_VALUE , CSO_INTERACTION = ml::CSOEvent::CSO_INTERACTION , CSO_CREATION = ml::CSOEvent::CSO_CREATION , NUM_CSO_EVENTS = ml::CSOEvent::NUM_CSO_EVENTS }

Public Slots
CSOEventType	eventType () const
QString	eventTypeName () const
bool	isPostCommand () const
bool	isPreCommand () const
QList< unsigned int >	csoIds () const
QList< unsigned int >	groupIds () const
QString	senderType () const
QString	senderName () const
QString	customMessage () const

Detailed Description

A class that wraps CSOEvents objects for use in Scripting.

Member Enumeration Documentation

CSOEventType

enum MLCSOEventWrapper::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 don't expect that these strings will stay the same (they are only for debugging), rather use eventType with the CSOEventType constants.

groupIds

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

slot

Returns the vector with CSOGroup ids.

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.