A CSOList comprises a number of CSOs and CSOGroups and is the central object for contour segmentation objects. More...
#include <CSOList.h>
Classes | |
| struct | CSONotificationCBData |
| This struct combines a function pointer, a user data pointer and a flag for the notification observer mechanism. More... | |
Public Types | |
| enum | NotificationType { NOTIFICATION_NONE = 0 , NOTIFICATION_CSO_SELECTION = 1 , NOTIFICATION_GROUP_SELECTION = 2 , NOTIFICATION_CSO_FINISHED = 4 , NOTIFICATION_GROUP_FINISHED = 8 , NOTIFICATION_REPAINT = 16 , NOTIFICATION_INTERACTION_INIT = 32 , NOTIFICATION_START_NEW_CSO = 64 , NOTIFICATION_CSO_MOVED = 128 , NOTIFICATION_CSO_UNDER_MOUSE_CHANGED = 256 , NOTIFICATION_UNDO_REDO_STATE_CHANGED = 512 } |
 Public Types inherited from ml::Base | |
| enum | PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream } |
| This enum describes the different persistence interfaces available. More... | |
Public Member Functions | |
| CSOList () | |
| Standard constructor. | |
| CSOList (bool shouldRegisterCSOList) | |
| CSOList (const CSOList &csoList) | |
| Copy constructor. | |
| void | clone (const CSOList &csoList, bool useUndoRedo=false) |
| Clones the internal CSOs and CSOGroups of the given CSOList to this one. | |
| void | merge (const CSOList &csoList, bool mergeGroupWithSameLabel, CSOIdToCSOIdMap &origToThisGroupIdMap, CSOIdToCSOIdMap &origToThisCSOIdMap, bool useUndoRedo=false) |
| Merges the internal CSOs and CSOGroups of the given CSOList to this one. | |
| void | merge (const CSOList &csoList, const CSOGroupMergeHandling mergeMode, CSOIdToCSOIdMap &origToThisGroupIdMap, CSOIdToCSOIdMap &origToThisCSOIdMap, bool useUndoRedo=false) |
| Merges the internal CSOs and CSOGroups of the given CSOList to this one with the given merge mode. | |
| bool | saveTo (std::string &filename, bool binary, std::string &message, ModuleBackgroundTask *task=nullptr) const |
| Pipes the internal structure of a this list (CSOs and Groups) into the given file. | |
| bool | saveTo (std::ostream &outStream, bool binary, ModuleBackgroundTask *task=nullptr) const |
| Pipes the internal structure of a this list (CSOs and Groups) into the given stream. | |
| bool | loadFrom (std::string &filename, std::string &message, ModuleBackgroundTask *task=nullptr) |
| Reads out the internal structure for this list (CSOs and Groups) from the given file. | |
| bool | loadFrom (std::istream &inStream, bool binary, std::string &message, ModuleBackgroundTask *task=nullptr) |
| Reads out the internal structure for this list (CSOs and Groups) from the given stream. | |
| void | addNotificationObserver (csoNotificationCB *callback, void *userData) |
| Adds a notification observer to this CSOList. | |
| void | removeNotificationObserver (csoNotificationCB *callback, void *userData) |
| Removes a notification observer from this CSOList. | |
| void | notifyObservers (int notificationFlag) |
| Notifies all observers. | |
| void | registerCSOListForNotificationObservers () |
| Registers this CSOList in the static list of CSOLists for handling observers. | |
| void | updateDisplays () |
| Updates all connected information/managing modules (not the renderers!). | |
| CSOUndoRedoManager * | getUndoRedoManager () |
| Returns a pointer to the undo/redo manager of this CSOList. | |
| CSOManager * | getManager () |
| Returns a pointer to the manager of this CSOList. | |
| void | setUndoRedoManager (CSOUndoRedoManager *undoRedoManager) |
| Sets the internal undo/redo manager. | |
| void | setManager (CSOManager *manager) |
| Sets the pointer to the internal manager and sets the group default rules. | |
| unsigned int | getCurrentCSOId () |
| Returns the current last id (incremented each call) for CSOs. | |
| void | updateCurrentCSOId (unsigned int newId) |
| Updates the current id if the new id is bigger than the current id. | |
| unsigned int | getCurrentGroupId () |
| Returns the current last id (incremented each call) for CSOGroups. | |
| void | setCurrentCSOId (unsigned int id) |
| Sets the current last id for CSOs. Do not mess with it. | |
| void | setCurrentGroupId (unsigned int id) |
| Sets the current last id for Groups. Do not mess with it. | |
| void | updateCurrentGroupId (const unsigned int newId) |
| Updates the current group id if the new id is bigger than the current id. | |
| bool | isSelected (const CSO *cso) const |
| Returns whether the given CSO is currently selected. | |
| bool | isSelected (const CSOGroup *group) const |
| Returns whether the given CSOGroup is currently selected. | |
| void | addSelected (CSO *cso) |
| Adds the given CSO to the list of selected CSOs (no double entry). | |
| void | addSelected (CSOGroup *group) |
| Adds the given CSOGroup to the list of selected CSOGroups (no double entry). | |
| bool | setSelected (CSO *cso) |
| Sets the given CSO as being selected and deselects all other CSOs. | |
| bool | setSelected (CSOGroup *group) |
| Set the given CSOGroup as being selected and deselects all other Groups. | |
| void | clearSelectedCSOs () |
| Clears all selected CSOs. | |
| void | clearSelectedGroups () |
| Clears all selected CSOGroups. | |
| void | clearSelectedSeedPoints () |
| Clears all selected seed points in all CSOs. | |
| void | removeFromSelection (CSO *cso) |
| Removes the given CSO from the list of selected CSOs. | |
| void | removeFromSelection (const std::vector< CSO * > &csos) |
| Removes the given CSOs from the list of selected CSOs. | |
| void | removeFromSelection (CSOGroup *group) |
| Removes the given CSOGroup from the list of selected CSOGroups. | |
| void | removeFromSelection (const std::vector< CSOGroup * > &groups) |
| Removes the given CSOGroups from the list of selected CSOGroups. | |
| unsigned int | numSelectedCSOs () const |
| Returns the number of selected CSOs. | |
| unsigned int | numSelectedGroups () const |
| Returns the number of selected CSOGroups. | |
| CSO * | getSelectedCSOAt (unsigned int index) const |
| Returns a pointer to the selected CSO at the given index; no checking! | |
| CSOGroup * | getSelectedGroupAt (unsigned int index) const |
| Returns a pointer to the selected CSOGroup at the given index; no checking! | |
| CSOIdVector | getSelectedCSOIds () |
| Returns a vector with ids of the selected CSOs. | |
| CSOIdVector | getSelectedGroupIds () |
| Returns a vector with ids of the selected groups. | |
| Vector3 | getCenterOfSelectedCSOs (bool &resultIsValid) const |
| Returns the center position of all bounding boxes of all selected CSOs. | |
| Vector3 | getCenterOfSelectedGroups (bool &resultIsValid) const |
| Returns the center position of all bounding boxes of all CSOs of all selected CSOGroups. | |
| CSO * | getCSOCurrentlyUnderMouse () const |
| Returns the pointer to the CSO currently under the mouse cursor. | |
| void | setCSOCurrentlyUnderMouse (CSO *csoUnderMouse) |
| Sets the pointer to the CSO currently under the mouse cursor. | |
| Vector3 | getCenterOfSelectedCSOs () const |
| /deprecated Returns the center position of all bounding boxes of all selected CSOs. | |
| Vector3 | getCenterOfSelectedGroups () const |
| /deprecated Returns the center position of all bounding boxes of all CSOs of all selected CSOGroups. | |
| CSO * | addCSO (bool useUndoRedo=true) |
| Adds a new CSO to the list and returns its pointer. | |
| CSO * | addCSONoEvent (bool useUndoRedo=true) |
| Adds a new CSO to the list and returns its pointer. (Without sending any events). | |
| CSO * | addCSO (const std::vector< Vector3 > &seedPositions, bool closed, bool useUndoRedo) |
| Adds a new CSO to the list and returns its pointer. | |
| CSO * | addCSO (unsigned int numSeedPoints, bool closed, bool useUndoRedo) |
| Adds a new CSO to the list and returns its pointer. | |
| CSO * | addCSOCopy (CSO *cso, bool useUndoRedo=true, unsigned int csoId=INVALID_CSO_ID) |
| Adds a copy of the given CSO to the list and returns a pointer to it. | |
| CSOGroup * | addGroup (bool useUndoRedo=true) |
| Adds a new Group to the list and returns a pointer to it. | |
| CSOGroup * | addGroup (const std::string &label, bool useUndoRedo=true) |
| Adds a new Group with given label to the list and returns a pointer to it. | |
| CSOGroup * | addGroupCopy (CSOGroup *group, bool useUndoRedo=true, unsigned int groupId=INVALID_CSO_ID) |
| Adds a copy of the given Group to this list and returns a pointer to it. | |
| CSO * | addPoint (const Vector3 &position, const std::string &subtype="point") |
| Adds a point CSO at the given position. | |
| CSO * | addCircle (const Vector3 &midPoint, const Vector3 &normal, double radius, double pointDistanceInMM=1., const std::string &subtype="circle") |
| Adds a circle CSO with its midPoint at the given position and a given radius. | |
| CSO * | addArrow (const Vector3 &pointAt, const Vector3 &direction, double length, double pointDistanceInMM=1., const std::string &subtype="arrow") |
| Adds an arrow pointing to pointAt from direction with a length. | |
| CSO * | addPolygon (const std::vector< Vector3 > &points, double pointDistanceInMM=1., const std::string &subtype="polygon") |
| Adds a linearly interpolated closed polygon with the given points as seed points. | |
| CSO * | addPolyline (const std::vector< Vector3 > &points, double pointDistanceInMM=1., const std::string &subtype="polyline") |
| Adds a linearly interpolated open polyline with the given points as seed points. | |
| CSO * | addClosedSpline (const std::vector< Vector3 > &points, bool useInterpolation=true, double pointDistanceInMM=1., const std::string &subtype="spline") |
| Adds a spline interpolated closed polygon with the given points as seed points. | |
| CSO * | addOpenSpline (const std::vector< Vector3 > &points, bool useInterpolation=true, double pointDistanceInMM=1., const std::string &subtype="spline") |
| Adds a spline interpolated open polygon with the given points as seed points. | |
| bool | removeCSO (CSO *cso, bool useUndoRedo=true) |
| Removes a given CSO from the list and from Groups it is in. | |
| bool | removeCSO (unsigned int id, bool useUndoRedo=true) |
| Removes a CSO by its id and removes it from all Groups. | |
| bool | removeAllCSO (bool useUndoRedo=true) |
| Removes all CSOs from the list and from all Groups they are in. | |
| bool | removeGroup (CSOGroup *group, bool useUndoRedo=true) |
| Removes the given Group and removes the group from all CSOs. | |
| bool | removeGroup (unsigned int id, bool useUndoRedo=true) |
| Removes a Group by its id and removes it from all CSOs. | |
| bool | removeAllGroups (bool useUndoRedo) |
| Removes all Groups and all groups from all CSOs. | |
| bool | removeGroups (const std::vector< CSOGroup * > &groupsToRemove, bool useUndoRedo=true) |
| Removes all Groups with given ids and removes them from CSOs Returns whether the operation was successful. | |
| bool | removeAll (bool useUndoRedo=true) |
| Removes all CSOs and Groups and resets all else. | |
| CSO * | getCSOAt (unsigned int index) const |
| Returns a pointer to the CSO at the given position in the internal list. | |
| CSO * | getCSOById (unsigned int id) const |
| Returns a pointer to the CSO with the given unique id. | |
| CSO * | getCSOByLabel (const std::string &label) const |
| Returns a pointer to the first CSO with the given label. | |
| unsigned int | getCSOIndex (CSO *cso) const |
| Returns the index of the given CSO in its list. | |
| unsigned int | getCSOIndex (unsigned int id) const |
| Returns the index of the CSO with the given id in its list. | |
| bool | hasCSO (CSO *cso) const |
| Returns whether there is the given CSO in the list. | |
| CSOGroup * | getGroupById (unsigned int id) const |
| Returns a pointer to a Group with the given id. | |
| CSOGroup * | getGroupByLabel (const std::string &label) const |
| Returns a pointer to a Group with the given label. | |
| CSOGroup * | getGroupAt (unsigned int index) const |
| Returns Group at the given index position. | |
| unsigned int | getGroupIndex (CSOGroup *group) const |
| Returns the index of the given Group in its list. | |
| unsigned int | getGroupIndex (unsigned int id) const |
| Returns the index of the Group with the given id in its list. | |
| bool | hasGroup (CSOGroup *group) const |
| Returns whether there is the given CSOGroup in the list. | |
| std::string | getUniqueCSOLabel (std::string label, std::string format, bool addIdAlways) |
| Returns a unique cso label that includes the given label and combines it with a unique id using the given format. | |
| std::string | getUniqueGroupLabel (std::string label, std::string format, bool addIdAlways) |
| Returns a unique group label that includes the given label and combines it with a unique id using the given format. | |
| void | resetUniqueCSOLabelIdMap () |
| Resets the data structure that is used to determine unique ids for getUniqueCSOLabel. | |
| void | resetUniqueGroupLabelIdMap () |
| Resets the data structure that is used to determine unique ids for getUniqueCSOLabel Afterwards, unique ids are still generated. | |
| bool | combineCSOandGroup (CSO *cso, CSOGroup *group, bool useUndoRedo=true) |
| Combines the given CSO with the given Group. | |
| void | breakCSOandGroup (CSO *cso, CSOGroup *group, bool useUndoRedo=true) |
| Breaks the combination of the given CSO and the given Group. | |
| void | breakCSOfromAllGroups (CSO *cso, bool useUndoRedo=true) |
| Breaks all combinations of the given CSO and any Group. | |
| void | breakAllCSOsFromGroup (CSOGroup *group, bool useUndoRedo=true) |
| Breaks all combinations of the given Group and any CSO. | |
| void | _addGroupRelationCommand (CSO *cso, CSOGroup *group) |
| helper method to be used only inside MLCSO | |
| unsigned int | numCSOs () const |
| Returns the number of CSOs in the list. | |
| unsigned int | numGroups () const |
| Returns the number of CSOGroups. | |
| CSOIdVector | getAllCSOIds () const |
| Returns a vector with the ids of the CSOs contained in the list. | |
| CSOIdVector | getAllGroupIds () const |
| Returns a vector with the ids of the groups contained in the list. | |
| void | undo () |
| Performs an undo of the last modification. | |
| void | redo () |
| Performs a redo of the last undone modification. | |
| void | enableUndoRedoManager () |
| Enables the undo/redo mechanism. | |
| void | disableUndoRedoManager () |
| Enables the undo/redo mechanism. | |
| void | sendOpenEventGroup () |
| Sends a CSOLIST_EVENT_GROUP_OPEN event to let listeners combine following events. | |
| void | sendCloseEventGroup () |
| Sends a CSOLIST_EVENT_GROUP_CLOSE event to let listeners combine preceding events.. | |
| void | sendModuleEventGroup (CSOEvent *event) |
| Sends a module group event. | |
| void | sendPreEvent (CSOEvent::CSOEventType eventType) |
| Sends a pre-event with the given event type. | |
| void | sendPreEvent (CSOEvent::CSOEventType eventType, unsigned int csoId) |
| Sends a pre-event with the given event type and the CSO id. | |
| void | sendPreEvent (CSOEvent::CSOEventType eventType, unsigned int csoId, const CSOIdVector &groupIds) |
| Sends a post-event with the given type, CSO id, and Group ids. | |
| void | sendPreEvent (CSOEvent::CSOEventType eventType, unsigned int csoId, unsigned int groupId) |
| Sends a pre-event with the given type, CSO id, and Group id. | |
| void | sendPreEvent (CSOEvent::CSOEventType eventType, const CSOIdVector &csoIds) |
| Sends a pre-event with the given event type and the CSO ids. | |
| void | sendPreEvent (CSOEvent::CSOEventType eventType, const CSOIdVector &csoIds, const CSOIdVector &groupIds) |
| Sends a pre-event with the given event type, CSO ids, and Group ids. | |
| void | sendPostEvent (CSOEvent::CSOEventType eventType) |
| Sends a post-event with the given event type. | |
| void | sendPostEvent (CSOEvent::CSOEventType eventType, unsigned int csoId) |
| Sends a post-event with the given type and CSO id. | |
| void | sendPostEvent (CSOEvent::CSOEventType eventType, unsigned int csoId, unsigned int groupId) |
| Sends a post-event with the given type, CSO id, and Group id. | |
| void | sendPostEvent (CSOEvent::CSOEventType eventType, const CSOIdVector &csoIds) |
| Sends a post-event with the given type and CSO ids. | |
| void | sendPostEvent (CSOEvent::CSOEventType eventType, unsigned int csoId, const CSOIdVector &groupIds) |
| Sends a post-event with the given type, CSO id, and Group ids. | |
| void | sendPostEvent (CSOEvent::CSOEventType eventType, const CSOIdVector &csoIds, const CSOIdVector &groupIds) |
| Sends a post-event with the given type, CSO ids, and Group ids. | |
| void | muteEvents () |
| Prevent the CSOList from sending any CSOEvents until unmuteEvents is called. | |
| void | unmuteEvents () |
| Revokes a mute request. | |
| bool | isNotMutingEvents () |
| whether CSOEvents are currently emitted | |
| MLuint64 | getListChangeId () const |
| Get the list change id, which changes whenever a CSO is added or removed (unique accross all CSOLists). | |
| MLuint64 | getGeometryChangeId () const |
| Get the geometry change id, which changes on any CSO geometry change or list change (unique accross all CSOLists). | |
| void | listChanged () |
| Called whenever the list has changed to generate a new id. This also changes the geometry id. | |
| void | geometryChanged () |
| Called whenever the geometry of a CSO has changed. | |
| void | enableRepaintObserver () |
| Enables the repaint observer mechanism. | |
| void | disableRepaintObserver () |
| Disables the repaint observer mechanism. | |
| void | enableFinishedObserver () |
| Enables the finished observer mechanism. | |
| void | disableFinishedObserver () |
| Disables the finished observer mechanism. | |
| void | enableInteractionObserver () |
| Enables the interaction observer mechanism. | |
| void | disableInteractionObserver () |
| Disables the interaction observer mechanism. | |
| void | enableSelectionObserver () |
| Enables the selection observer mechanism. | |
| void | disableSelectionObserver () |
| Disables the selection observer mechanism. | |
| void | enableStartNewCSOObserver () |
| Enables the 'start new CSO' observer mechanism. | |
| void | disableStartNewCSOObserver () |
| Disables the 'start new CSO' observer mechanism. | |
| void | enableCSOMovedObserver () |
| Enables the 'CSO moved' observer mechanism. | |
| void | disableCSOMovedObserver () |
| Disables the 'CSO moved' observer mechanism. | |
| void | enableCSOCurrentlyUnderMouseObserver () |
| Enables the 'CSO currently under mouse' observer mechanism. | |
| void | disableCSOCurrentlyUnderMouseObserver () |
| Disables the 'CSO currently under mouse' observer mechanism. | |
| bool | isUndoRedoManagerEnabled () const |
| Returns 'true' if the undo/redo mechanism is enabled, 'false' otherwise. | |
| void | openUndoRedoGroup (const std::string &description="Contour Operation") |
| Opens a undo/redo group. All undoable commands after this are grouped together. | |
| void | closeUndoRedoGroup () |
| Closes a undo/redo group. All undoable commands before this are grouped together. | |
| bool | isRepaintNotificationEnabled () const |
| Returns whether the repaint notification is enabled. | |
| bool | isFinishedNotificationEnabled () const |
| Returns whether the finished notification is enabled. | |
| bool | isInteractionInitNotificationEnabled () const |
| Returns whether the interaction init notification is enabled. | |
| bool | isSelectionNotificationEnabled () const |
| Returns whether the selection notification is enabled. | |
| bool | isStartNewCSONotificationEnabled () const |
| Returns whether the 'start new CSO' notification is enabled. | |
| bool | isCSOMovedNotificationEnabled () const |
| Returns whether the 'CSO moved' notification is enabled. | |
| bool | isCSOCurrentlyUnderMouseNotificationEnabled () const |
| Returns whether the 'CSO currently under mouse' notification is enabled. | |
| CSOListRules & | getRules () |
| Return the rules for this CSOList. | |
| void | addStateToTree (TreeNode *) const override |
| Attaches the object state as children of the given parent node. | |
| void | readStateFromTree (TreeNode *) override |
| Reads the object state from the children of the given parent node. | |
| ML_SET_ADDSTATE_VERSION (1) | |
| CSOList * | deepCopy () const override |
| Create a deep copy of the CSOList. | |
| Public Member Functions inherited from ml::RefCountedBase | |
| RefCountedBase () | |
| Constructor. | |
| RefCountedBase (const RefCountedBase &) | |
| Explicit copy constructor. | |
| virtual void | incRefCount () const |
| Increase reference count. | |
| virtual void | decRefCount () const |
| Decrease ref count (object will be deleted if ref count is decremented to 0) | |
| bool | isRefCountedBase () const override |
| Returns if the instance is derived from RefCountedBase. | |
| Public Member Functions inherited from ml::EventSource | |
| EventSource () | |
| EventSource (const EventSource &evSource) | |
| ~EventSource () override | |
| void | addEventListener (BaseEventCallback *cb, void *userData) |
| add event listener callback to this Base object - the userData will be the first argument when the callback is called | |
| void | removeEventListener (BaseEventCallback *cb, void *userData) |
| remove event listener callback from this Base object - arguments must be the same as for the addEventListener call | |
| bool | hasEventListeners () const |
| check if any event listeners have been added to this Base object; this can be used to skip the sendEvent call (and the potentially expensive building of the event object) altogether | |
| Public Member Functions inherited from ml::Base | |
| Base () | |
| Constructor. | |
| virtual | ~Base () |
| Destructor. | |
| bool | isOfAllowedType (const std::vector< const RuntimeType * > &types) const |
| Check if this object's type is equal to or derived from one of the types given in the argument. | |
| virtual std::string | detailString () const |
| Return a string describing this object. | |
| virtual bool | implementsPersistence (PersistenceInterface) const |
| Override this method to declare which persistence interfaces are implemented by your derived class. | |
| virtual std::string | persistentState () const |
| Returns a string describing the object's internal state. | |
| virtual void | setPersistentState (const std::string &state) |
Restores the object's internal state from a string that had been previously generated using persistentState(). | |
| virtual void | writeTo (AbstractPersistenceOutputStream *) const |
| Write the objects state to the data stream object. | |
| virtual void | readFrom (AbstractPersistenceInputStream *, int) |
| Read the objects state from the data stream object. | |
Static Public Member Functions | |
| static void | removeNotificationObserverFromAllCSOLists (csoNotificationCB *callback, void *userData) |
| Removes a certain notification observer from all CSOLists. | |
| static void | alignSeedPathLinks (CSO *cso) |
| Aligns seed point positions with path point lists of a given CSO by a squared distance sum criterion. | |
| static EnumValues< CSOPathPointsStyle > | getLineStyleModes () |
| static EnumValues< CSOSeedPointStyle > | getSeedPointStyles () |
| static EnumValues< CSOVoxelWriteModes > | getVoxelWriteModes () |
| Static Public Member Functions inherited from ml::RefCountedBase | |
| static void | updateReferenceCountingIfSupported (Base *oldValue, Base *newValue, bool &isRefCountedBase) |
| Helper method that handles inc/dec of ref count if base instances support it. | |
Protected Member Functions | |
| ~CSOList () override | |
| The CSOList destructor is protected since the CSOList ownership is managed by the CSOListPtr intrusive smart pointer. | |
| void | setupCSOList () |
| Protected Member Functions inherited from ml::RefCountedBase | |
| ~RefCountedBase () override | |
| Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h. | |
| Protected Member Functions inherited from ml::EventSource | |
| void | sendEvent (BaseEvent *event, void *skipListener=nullptr) |
| Macro for the declaration of the runtime type system methods, defined in mlRuntimeSubClass.h. | |
Friends | |
| class | CSOLoad |
Additional Inherited Members | |
| Protected Attributes inherited from ml::RefCountedBase | |
| MLint32 | _refCount |
| Reference count. | |
Detailed Description
A CSOList comprises a number of CSOs and CSOGroups and is the central object for contour segmentation objects.
The CSOList is derived from Base and can be used as a data structure in a MeVisLab network. The CSOList has also a CSOUndoRedoManager as a member. The CSOList ownership is managed via smart pointers, make sure to use a CSOListPtr so manage newly created CSOList objects.
Member Enumeration Documentation
◆ NotificationType
| Enumerator | |
|---|---|
| NOTIFICATION_NONE | Flag for the observer mechanism, signalizing no notification at all. |
| NOTIFICATION_CSO_SELECTION | Flag for the observer mechanism, should be set if a CSO selection changes. |
| NOTIFICATION_GROUP_SELECTION | Flag for the observer mechanism, should be set if a CSOGroup selection changes. |
| NOTIFICATION_CSO_FINISHED | Flag for the observer mechanism, should be set if a CSO action is finished. |
| NOTIFICATION_GROUP_FINISHED | Flag for the observer mechanism, should be set if a CSOGroup action is finished. |
| NOTIFICATION_REPAINT | Flag for the observer mechanism, should be set if a repaint should occur. |
| NOTIFICATION_INTERACTION_INIT | Flag for the observer mechanism, should be set if the interaction must be initialized. |
| NOTIFICATION_START_NEW_CSO | Flag for the observer mechanism, signalizing that the generation of a new CSO has been started. |
| NOTIFICATION_CSO_MOVED | Flag for the observer mechanism, should be set if a CSO was moved. |
| NOTIFICATION_CSO_UNDER_MOUSE_CHANGED | Flag for the observer mechanism, should be set if the CSO under the mouse cursor changes. |
| NOTIFICATION_UNDO_REDO_STATE_CHANGED | Flag for the observer mechanism, should be set if the availability of undo/redo steps changes. |
Constructor & Destructor Documentation
◆ CSOList() [1/3]
| ml::CSOList::CSOList | ( | ) |
Standard constructor.
◆ CSOList() [2/3]
| ml::CSOList::CSOList | ( | bool | shouldRegisterCSOList | ) |
◆ CSOList() [3/3]
◆ ~CSOList()
|
overrideprotected |
The CSOList destructor is protected since the CSOList ownership is managed by the CSOListPtr intrusive smart pointer.
If you encounter code that tries to delete a CSOList object, you will very likely need to change the usage of a CSOList* to a CSOListPtr and replace the delete call with a NULL assignment.
Member Function Documentation
◆ _addGroupRelationCommand()
helper method to be used only inside MLCSO
◆ addArrow()
| CSO * ml::CSOList::addArrow | ( | const Vector3 & | pointAt, |
| const Vector3 & | direction, | ||
| double | length, | ||
| double | pointDistanceInMM = 1., | ||
| const std::string & | subtype = "arrow" ) |
Adds an arrow pointing to pointAt from direction with a length.
◆ addCircle()
◆ addClosedSpline()
| CSO * ml::CSOList::addClosedSpline | ( | const std::vector< Vector3 > & | points, |
| bool | useInterpolation = true, | ||
| double | pointDistanceInMM = 1., | ||
| const std::string & | subtype = "spline" ) |
Adds a spline interpolated closed polygon with the given points as seed points.
If useInterpolation is set to 'false', spline approximation is used.
◆ addCSO() [1/3]
Adds a new CSO to the list and returns its pointer.
◆ addCSO() [2/3]
| CSO * ml::CSOList::addCSO | ( | const std::vector< Vector3 > & | seedPositions, |
| bool | closed, | ||
| bool | useUndoRedo ) |
Adds a new CSO to the list and returns its pointer.
The given positions are used as seed point positions.
◆ addCSO() [3/3]
◆ addCSOCopy()
| CSO * ml::CSOList::addCSOCopy | ( | CSO * | cso, |
| bool | useUndoRedo = true, | ||
| unsigned int | csoId = INVALID_CSO_ID ) |
Adds a copy of the given CSO to the list and returns a pointer to it.
◆ addCSONoEvent()
Adds a new CSO to the list and returns its pointer. (Without sending any events).
◆ addGroup() [1/2]
Adds a new Group to the list and returns a pointer to it.
◆ addGroup() [2/2]
Adds a new Group with given label to the list and returns a pointer to it.
◆ addGroupCopy()
| CSOGroup * ml::CSOList::addGroupCopy | ( | CSOGroup * | group, |
| bool | useUndoRedo = true, | ||
| unsigned int | groupId = INVALID_CSO_ID ) |
Adds a copy of the given Group to this list and returns a pointer to it.
Note that this method does not set the 'this' pointer as a new CSOList.
◆ addNotificationObserver()
| void ml::CSOList::addNotificationObserver | ( | csoNotificationCB * | callback, |
| void * | userData ) |
Adds a notification observer to this CSOList.
◆ addOpenSpline()
| CSO * ml::CSOList::addOpenSpline | ( | const std::vector< Vector3 > & | points, |
| bool | useInterpolation = true, | ||
| double | pointDistanceInMM = 1., | ||
| const std::string & | subtype = "spline" ) |
Adds a spline interpolated open polygon with the given points as seed points.
If useInterpolation is set to 'false', spline approximation is used.
◆ addPoint()
Adds a point CSO at the given position.
◆ addPolygon()
| CSO * ml::CSOList::addPolygon | ( | const std::vector< Vector3 > & | points, |
| double | pointDistanceInMM = 1., | ||
| const std::string & | subtype = "polygon" ) |
Adds a linearly interpolated closed polygon with the given points as seed points.
◆ addPolyline()
| CSO * ml::CSOList::addPolyline | ( | const std::vector< Vector3 > & | points, |
| double | pointDistanceInMM = 1., | ||
| const std::string & | subtype = "polyline" ) |
Adds a linearly interpolated open polyline with the given points as seed points.
◆ addSelected() [1/2]
Adds the given CSO to the list of selected CSOs (no double entry).
◆ addSelected() [2/2]
Adds the given CSOGroup to the list of selected CSOGroups (no double entry).
◆ addStateToTree()
Attaches the object state as children of the given parent node.
Reimplemented from ml::Base.
◆ alignSeedPathLinks()
Aligns seed point positions with path point lists of a given CSO by a squared distance sum criterion.
◆ breakAllCSOsFromGroup()
Breaks all combinations of the given Group and any CSO.
◆ breakCSOandGroup()
Breaks the combination of the given CSO and the given Group.
◆ breakCSOfromAllGroups()
Breaks all combinations of the given CSO and any Group.
◆ clearSelectedCSOs()
| void ml::CSOList::clearSelectedCSOs | ( | ) |
Clears all selected CSOs.
◆ clearSelectedGroups()
| void ml::CSOList::clearSelectedGroups | ( | ) |
Clears all selected CSOGroups.
◆ clearSelectedSeedPoints()
| void ml::CSOList::clearSelectedSeedPoints | ( | ) |
Clears all selected seed points in all CSOs.
◆ clone()
Clones the internal CSOs and CSOGroups of the given CSOList to this one.
◆ closeUndoRedoGroup()
| void ml::CSOList::closeUndoRedoGroup | ( | ) |
Closes a undo/redo group. All undoable commands before this are grouped together.
◆ combineCSOandGroup()
Combines the given CSO with the given Group.
◆ deepCopy()
|
inlineoverridevirtual |
◆ disableCSOCurrentlyUnderMouseObserver()
|
inline |
◆ disableCSOMovedObserver()
|
inline |
◆ disableFinishedObserver()
|
inline |
◆ disableInteractionObserver()
|
inline |
◆ disableRepaintObserver()
|
inline |
◆ disableSelectionObserver()
|
inline |
◆ disableStartNewCSOObserver()
|
inline |
◆ disableUndoRedoManager()
| void ml::CSOList::disableUndoRedoManager | ( | ) |
Enables the undo/redo mechanism.
◆ enableCSOCurrentlyUnderMouseObserver()
|
inline |
◆ enableCSOMovedObserver()
|
inline |
◆ enableFinishedObserver()
|
inline |
◆ enableInteractionObserver()
|
inline |
◆ enableRepaintObserver()
|
inline |
◆ enableSelectionObserver()
|
inline |
◆ enableStartNewCSOObserver()
|
inline |
◆ enableUndoRedoManager()
|
inline |
◆ geometryChanged()
◆ getAllCSOIds()
| CSOIdVector ml::CSOList::getAllCSOIds | ( | ) | const |
Returns a vector with the ids of the CSOs contained in the list.
◆ getAllGroupIds()
| CSOIdVector ml::CSOList::getAllGroupIds | ( | ) | const |
Returns a vector with the ids of the groups contained in the list.
◆ getCenterOfSelectedCSOs() [1/2]
|
inline |
/deprecated Returns the center position of all bounding boxes of all selected CSOs.
Definition at line 260 of file CSOList.h.
References CSO_DEBUG, and mlrange_cast().
◆ getCenterOfSelectedCSOs() [2/2]
Returns the center position of all bounding boxes of all selected CSOs.
'resultIsValid' is false if there are no selected CSOs available.
◆ getCenterOfSelectedGroups() [1/2]
|
inline |
/deprecated Returns the center position of all bounding boxes of all CSOs of all selected CSOGroups.
Definition at line 268 of file CSOList.h.
References CSO_DEBUG, and mlrange_cast().
◆ getCenterOfSelectedGroups() [2/2]
Returns the center position of all bounding boxes of all CSOs of all selected CSOGroups.
'resultIsValid' is false if there are no selected groups available.
◆ getCSOAt()
Returns a pointer to the CSO at the given position in the internal list.
◆ getCSOById()
◆ getCSOByLabel()
◆ getCSOCurrentlyUnderMouse()
|
inline |
◆ getCSOIndex() [1/2]
Returns the index of the given CSO in its list.
◆ getCSOIndex() [2/2]
Returns the index of the CSO with the given id in its list.
◆ getCurrentCSOId()
Returns the current last id (incremented each call) for CSOs.
If there are no CSOs in the list, this id is set back to 0.
◆ getCurrentGroupId()
Returns the current last id (incremented each call) for CSOGroups.
If there are no CSOGroups in the list, this id is set back to 0.
◆ getGeometryChangeId()
|
inline |
◆ getGroupAt()
Returns Group at the given index position.
◆ getGroupById()
Returns a pointer to a Group with the given id.
◆ getGroupByLabel()
Returns a pointer to a Group with the given label.
◆ getGroupIndex() [1/2]
Returns the index of the given Group in its list.
◆ getGroupIndex() [2/2]
Returns the index of the Group with the given id in its list.
◆ getLineStyleModes()
|
static |
◆ getListChangeId()
|
inline |
◆ getManager()
|
inline |
◆ getRules()
|
inline |
◆ getSeedPointStyles()
|
static |
◆ getSelectedCSOAt()
◆ getSelectedCSOIds()
| CSOIdVector ml::CSOList::getSelectedCSOIds | ( | ) |
Returns a vector with ids of the selected CSOs.
◆ getSelectedGroupAt()
◆ getSelectedGroupIds()
| CSOIdVector ml::CSOList::getSelectedGroupIds | ( | ) |
Returns a vector with ids of the selected groups.
◆ getUndoRedoManager()
|
inline |
◆ getUniqueCSOLabel()
| std::string ml::CSOList::getUniqueCSOLabel | ( | std::string | label, |
| std::string | format, | ||
| bool | addIdAlways ) |
Returns a unique cso label that includes the given label and combines it with a unique id using the given format.
If the given label itself is unique, an id is only added if addIdAlways is true.
◆ getUniqueGroupLabel()
| std::string ml::CSOList::getUniqueGroupLabel | ( | std::string | label, |
| std::string | format, | ||
| bool | addIdAlways ) |
Returns a unique group label that includes the given label and combines it with a unique id using the given format.
If the given label itself is unique, an id is only added if addIdAlways is true.
◆ getVoxelWriteModes()
|
static |
◆ hasCSO()
◆ hasGroup()
Returns whether there is the given CSOGroup in the list.
◆ isCSOCurrentlyUnderMouseNotificationEnabled()
|
inline |
◆ isCSOMovedNotificationEnabled()
|
inline |
◆ isFinishedNotificationEnabled()
|
inline |
◆ isInteractionInitNotificationEnabled()
|
inline |
◆ isNotMutingEvents()
| bool ml::CSOList::isNotMutingEvents | ( | ) |
whether CSOEvents are currently emitted
◆ isRepaintNotificationEnabled()
|
inline |
◆ isSelected() [1/2]
Returns whether the given CSO is currently selected.
If a group is selected, its member CSOs are also marked as being selected.
◆ isSelected() [2/2]
Returns whether the given CSOGroup is currently selected.
◆ isSelectionNotificationEnabled()
|
inline |
◆ isStartNewCSONotificationEnabled()
|
inline |
◆ isUndoRedoManagerEnabled()
|
inline |
◆ listChanged()
| void ml::CSOList::listChanged | ( | ) |
Called whenever the list has changed to generate a new id. This also changes the geometry id.
◆ loadFrom() [1/2]
| bool ml::CSOList::loadFrom | ( | std::istream & | inStream, |
| bool | binary, | ||
| std::string & | message, | ||
| ModuleBackgroundTask * | task = nullptr ) |
Reads out the internal structure for this list (CSOs and Groups) from the given stream.
Returns whether the operation was successful. A given message string is filled.
◆ loadFrom() [2/2]
| bool ml::CSOList::loadFrom | ( | std::string & | filename, |
| std::string & | message, | ||
| ModuleBackgroundTask * | task = nullptr ) |
Reads out the internal structure for this list (CSOs and Groups) from the given file.
Returns whether the operation was successful. A given message string is filled.
◆ merge() [1/2]
| void ml::CSOList::merge | ( | const CSOList & | csoList, |
| bool | mergeGroupWithSameLabel, | ||
| CSOIdToCSOIdMap & | origToThisGroupIdMap, | ||
| CSOIdToCSOIdMap & | origToThisCSOIdMap, | ||
| bool | useUndoRedo = false ) |
Merges the internal CSOs and CSOGroups of the given CSOList to this one.
◆ merge() [2/2]
| void ml::CSOList::merge | ( | const CSOList & | csoList, |
| const CSOGroupMergeHandling | mergeMode, | ||
| CSOIdToCSOIdMap & | origToThisGroupIdMap, | ||
| CSOIdToCSOIdMap & | origToThisCSOIdMap, | ||
| bool | useUndoRedo = false ) |
Merges the internal CSOs and CSOGroups of the given CSOList to this one with the given merge mode.
◆ ML_SET_ADDSTATE_VERSION()
| ml::CSOList::ML_SET_ADDSTATE_VERSION | ( | 1 | ) |
◆ muteEvents()
| void ml::CSOList::muteEvents | ( | ) |
Prevent the CSOList from sending any CSOEvents until unmuteEvents is called.
◆ notifyObservers()
◆ numCSOs()
◆ numGroups()
◆ numSelectedCSOs()
◆ numSelectedGroups()
◆ openUndoRedoGroup()
| void ml::CSOList::openUndoRedoGroup | ( | const std::string & | description = "Contour Operation" | ) |
Opens a undo/redo group. All undoable commands after this are grouped together.
◆ readStateFromTree()
Reads the object state from the children of the given parent node.
Reimplemented from ml::Base.
◆ redo()
| void ml::CSOList::redo | ( | ) |
Performs a redo of the last undone modification.
◆ registerCSOListForNotificationObservers()
| void ml::CSOList::registerCSOListForNotificationObservers | ( | ) |
Registers this CSOList in the static list of CSOLists for handling observers.
◆ removeAll()
Removes all CSOs and Groups and resets all else.
Returns whether the operation was successful.
◆ removeAllCSO()
Removes all CSOs from the list and from all Groups they are in.
Returns whether the operation was successful.
◆ removeAllGroups()
Removes all Groups and all groups from all CSOs.
Returns whether the operation was successful.
◆ removeCSO() [1/2]
◆ removeCSO() [2/2]
◆ removeFromSelection() [1/4]
Removes the given CSOs from the list of selected CSOs.
◆ removeFromSelection() [2/4]
Removes the given CSOGroups from the list of selected CSOGroups.
◆ removeFromSelection() [3/4]
Removes the given CSO from the list of selected CSOs.
◆ removeFromSelection() [4/4]
Removes the given CSOGroup from the list of selected CSOGroups.
◆ removeGroup() [1/2]
Removes the given Group and removes the group from all CSOs.
Returns whether the CSOGroup has been removed.
◆ removeGroup() [2/2]
Removes a Group by its id and removes it from all CSOs.
Returns whether the group has been removed.
◆ removeGroups()
| bool ml::CSOList::removeGroups | ( | const std::vector< CSOGroup * > & | groupsToRemove, |
| bool | useUndoRedo = true ) |
Removes all Groups with given ids and removes them from CSOs Returns whether the operation was successful.
◆ removeNotificationObserver()
| void ml::CSOList::removeNotificationObserver | ( | csoNotificationCB * | callback, |
| void * | userData ) |
Removes a notification observer from this CSOList.
◆ removeNotificationObserverFromAllCSOLists()
|
static |
Removes a certain notification observer from all CSOLists.
◆ resetUniqueCSOLabelIdMap()
|
inline |
Resets the data structure that is used to determine unique ids for getUniqueCSOLabel.
Afterwards, unique ids are still generated. However these ids do not start with the highest previously assigned id. Instead, the first unused id is used. This behavior is identical to id assignment after loading of a stored CSOList.
◆ resetUniqueGroupLabelIdMap()
|
inline |
Resets the data structure that is used to determine unique ids for getUniqueCSOLabel Afterwards, unique ids are still generated.
However these ids do not start with the highest previously assigned id. Instead, the first unused id is used. This behavior is identical to id assignment after loading of a stored CSOList.
◆ saveTo() [1/2]
| bool ml::CSOList::saveTo | ( | std::ostream & | outStream, |
| bool | binary, | ||
| ModuleBackgroundTask * | task = nullptr ) const |
Pipes the internal structure of a this list (CSOs and Groups) into the given stream.
Returns whether the operation was successful.
◆ saveTo() [2/2]
| bool ml::CSOList::saveTo | ( | std::string & | filename, |
| bool | binary, | ||
| std::string & | message, | ||
| ModuleBackgroundTask * | task = nullptr ) const |
Pipes the internal structure of a this list (CSOs and Groups) into the given file.
Returns whether the operation was successful.
◆ sendCloseEventGroup()
| void ml::CSOList::sendCloseEventGroup | ( | ) |
Sends a CSOLIST_EVENT_GROUP_CLOSE event to let listeners combine preceding events..
◆ sendModuleEventGroup()
◆ sendOpenEventGroup()
| void ml::CSOList::sendOpenEventGroup | ( | ) |
Sends a CSOLIST_EVENT_GROUP_OPEN event to let listeners combine following events.
◆ sendPostEvent() [1/6]
| void ml::CSOList::sendPostEvent | ( | CSOEvent::CSOEventType | eventType | ) |
Sends a post-event with the given event type.
◆ sendPostEvent() [2/6]
| void ml::CSOList::sendPostEvent | ( | CSOEvent::CSOEventType | eventType, |
| const CSOIdVector & | csoIds ) |
Sends a post-event with the given type and CSO ids.
◆ sendPostEvent() [3/6]
| void ml::CSOList::sendPostEvent | ( | CSOEvent::CSOEventType | eventType, |
| const CSOIdVector & | csoIds, | ||
| const CSOIdVector & | groupIds ) |
Sends a post-event with the given type, CSO ids, and Group ids.
◆ sendPostEvent() [4/6]
| void ml::CSOList::sendPostEvent | ( | CSOEvent::CSOEventType | eventType, |
| unsigned int | csoId ) |
Sends a post-event with the given type and CSO id.
◆ sendPostEvent() [5/6]
| void ml::CSOList::sendPostEvent | ( | CSOEvent::CSOEventType | eventType, |
| unsigned int | csoId, | ||
| const CSOIdVector & | groupIds ) |
◆ sendPostEvent() [6/6]
◆ sendPreEvent() [1/6]
| void ml::CSOList::sendPreEvent | ( | CSOEvent::CSOEventType | eventType | ) |
Sends a pre-event with the given event type.
◆ sendPreEvent() [2/6]
| void ml::CSOList::sendPreEvent | ( | CSOEvent::CSOEventType | eventType, |
| const CSOIdVector & | csoIds ) |
Sends a pre-event with the given event type and the CSO ids.
◆ sendPreEvent() [3/6]
| void ml::CSOList::sendPreEvent | ( | CSOEvent::CSOEventType | eventType, |
| const CSOIdVector & | csoIds, | ||
| const CSOIdVector & | groupIds ) |
Sends a pre-event with the given event type, CSO ids, and Group ids.
◆ sendPreEvent() [4/6]
| void ml::CSOList::sendPreEvent | ( | CSOEvent::CSOEventType | eventType, |
| unsigned int | csoId ) |
Sends a pre-event with the given event type and the CSO id.
◆ sendPreEvent() [5/6]
| void ml::CSOList::sendPreEvent | ( | CSOEvent::CSOEventType | eventType, |
| unsigned int | csoId, | ||
| const CSOIdVector & | groupIds ) |
◆ sendPreEvent() [6/6]
◆ setCSOCurrentlyUnderMouse()
Sets the pointer to the CSO currently under the mouse cursor.
At the moment, only the SoView2DCSOExtensibleEditor sets this pointer. You might break networks if you fool around with this.
◆ setCurrentCSOId()
◆ setCurrentGroupId()
◆ setManager()
| void ml::CSOList::setManager | ( | CSOManager * | manager | ) |
Sets the pointer to the internal manager and sets the group default rules.
◆ setSelected() [1/2]
◆ setSelected() [2/2]
◆ setUndoRedoManager()
|
inline |
Sets the internal undo/redo manager.
Definition at line 152 of file CSOList.h.
References mlrange_cast().
◆ setupCSOList()
|
protected |
◆ undo()
| void ml::CSOList::undo | ( | ) |
Performs an undo of the last modification.
◆ unmuteEvents()
| void ml::CSOList::unmuteEvents | ( | ) |
Revokes a mute request.
If muteEvents was called multiple times, unmuteEvents has to be called the same number of times before events are sent again.
◆ updateCurrentCSOId()
Updates the current id if the new id is bigger than the current id.
◆ updateCurrentGroupId()
Updates the current group id if the new id is bigger than the current id.
◆ updateDisplays()
| void ml::CSOList::updateDisplays | ( | ) |
Updates all connected information/managing modules (not the renderers!).
Friends And Related Symbol Documentation
◆ CSOLoad
The documentation for this class was generated from the following file:
- MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSOList.h
