ml::CSOList Class Reference

A CSOList comprises a number of CSOs and CSOGroups and is the central object for contour segmentation objects. More...

#include <CSOList.h>

Inheritance diagram for ml::CSOList:

ml::Base

List of all members.

Classes

struct  CSONotificationCBData
 This struct combines a function pointer, a user data pointer and a flag for the notification observer mechanism. More...
struct  IndexPair
 Struct holding a pair of indices.

Public Types

typedef std::map< unsigned int,
unsigned int > 
IdToIdMap

Public Member Functions

 CSOList ()
 Standard constructor.
 CSOList (const CSOList &csoList)
 Copy constructor.
virtual ~CSOList ()
 Standard destructor.
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, IdToIdMap &origToThisGroupIdMap, IdToIdMap &origToThisCSOIdMap, bool useUndoRedo=false)
 Merges the internal CSOs and CSOGroups of the given CSOList to this one.
bool saveTo (std::string &filename, bool binary) const
 Pipes the internal structure of a this list (CSOs and Groups) into the given file.
bool saveTo (std::ostream &outStream, bool binary) const
 Pipes the internal structure of a this list (CSOs and Groups) into the given stream.
bool loadFrom (std::string &filename, std::string &message)
 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)
 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 updateDisplays ()
 Updates all connected information/managing modules (not the renderers!).
CSOUndoRedoManagergetUndoRedoManager ()
 Returns a pointer to the undo/redo manager of this CSOList.
CSOManagergetManager ()
 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.
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.
bool isSelected (CSO *cso) const
 Returns if the given CSO is currently selected.
bool isSelected (CSOGroup *group) const
 Returns if 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 (CSOGroup *group)
 Removes the given CSOGroup 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.
CSOgetSelectedCSOAt (unsigned int index) const
 Returns a pointer to the selected CSO at the given index; no checking!
CSOGroupgetSelectedGroupAt (unsigned int index) const
 Returns a pointer to the selected CSOGroup at the given index; no checking!
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.
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.
CSOaddCSO (bool useUndoRedo=true)
 Adds a new CSO to the list and returns its pointer.
CSOaddCSO (const std::vector< Vector3 > &seedPositions, bool closed, bool useUndoRedo)
 Adds a new CSO to the list and returns its pointer.
CSOaddCSO (unsigned int numSeedPoints, bool closed, bool useUndoRedo)
 Adds a new CSO to the list and returns its pointer.
CSOaddCSOCopy (CSO *cso, bool useUndoRedo=true)
 Adds a copy of the given CSO to the list and returns a pointer to it.
CSOGroupaddGroup (bool useUndoRedo=true)
 Adds a new Group to the list and returns a pointer to it.
CSOGroupaddGroupCopy (CSOGroup *group, bool useUndoRedo=true)
 Adds a copy of the given Group to this list and returns a pointer to it.
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 removeAll (bool useUndoRedo=true)
 Removes all CSOs and Groups and resets all else.
CSOgetCSOAt (unsigned int index) const
 Returns a pointer to the CSO at the given position in the internal list.
CSOgetCSOById (unsigned int id) const
 Returns a pointer to the CSO with the given unique id.
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.
CSOGroupgetGroupById (unsigned int id) const
 Returns a pointer to a Group with the given id.
CSOGroupgetGroupByLabel (const std::string &label) const
 Returns a pointer to a Group with the given label.
CSOGroupgetGroupAt (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.
void 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.
unsigned int numCSO () const
 Returns the number of CSOs in the list.
unsigned int numGroups () const
 Returns the number of CSOGroups.
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 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.
bool isUndoRedoManagerEnabled () const
 Returns 'true' if the undo/redo mechanism is enabled, 'false' otherwise.
bool isRepaintNotificationEnabled () const
 Returns 'true' if the repaint notification is enabled, 'false' otherwise.
bool isFinishedNotificationEnabled () const
 Returns 'true' if the finished notification is enabled, 'false' otherwise.
bool isInteractionInitNotificationEnabled () const
 Returns 'true' if the interaction init notification is enabled, 'false' otherwise.
bool isSelectionNotificationEnabled () const
 Returns 'true' if the selection notification is enabled, 'false' otherwise.
bool isStartNewCSONotificationEnabled () const
 Returns 'true' if the 'start new CSO' notification is enabled, 'false' otherwise.
bool isCSOMovedNotificationEnabled () const
 Returns 'true' if the 'CSO moved' notification is enabled, 'false' otherwise.
CSOListRulesgetRules ()
 Return the rules for this CSOList.
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node.
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node.
 ML_SET_ADDSTATE_VERSION (1)
virtual CSOListdeepCopy () const
 Create a deep copy of the CSOList.

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 Public Attributes

static const char * sVoxelWriteModeStrings [4]
 Strings for voxel write mode enumerations.
static const char * sLineStyleModeStrings [5]
 Strings for line style enumerations.
static const char * sSeedPointStyleStrings [3]
 Strings for marker mode enumerations.
static const int NOTIFICATION_NONE
 Flag for the observer mechanism, signalizing no notification at all.
static const int NOTIFICATION_CSO_SELECTION
 Flag for the observer mechanism, should be set if a CSO selection changes.
static const int NOTIFICATION_GROUP_SELECTION
 Flag for the observer mechanism, should be set if a CSOGroup selection changes.
static const int NOTIFICATION_CSO_FINISHED
 Flag for the observer mechanism, should be set if a CSO action is finished.
static const int NOTIFICATION_GROUP_FINISHED
 Flag for the observer mechanism, should be set if a CSOGroup action is finished.
static const int NOTIFICATION_REPAINT
 Flag for the observer mechanism, should be set if a repaint should occur.
static const int NOTIFICATION_INTERACTION_INIT
 Flag for the observer mechanism, should be set if the interaction must be initialized.
static const int NOTIFICATION_START_NEW_CSO
 Flag for the observer mechanism, signalizing that the generation of a new CSO has been started.
static const int NOTIFICATION_CSO_MOVED
 Flag for the observer mechanism, should be set if a CSO was moved.


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.

Definition at line 42 of file CSOList.h.


Member Typedef Documentation

typedef std::map<unsigned int, unsigned int> ml::CSOList::IdToIdMap

Definition at line 66 of file CSOList.h.


Constructor & Destructor Documentation

ml::CSOList::CSOList (  ) 

Standard constructor.

ml::CSOList::CSOList ( const CSOList csoList  ) 

Copy constructor.

virtual ml::CSOList::~CSOList (  )  [virtual]

Standard destructor.


Member Function Documentation

CSO* ml::CSOList::addCSO ( unsigned int  numSeedPoints,
bool  closed,
bool  useUndoRedo 
)

Adds a new CSO to the list and returns its pointer.

The resulting CSO has as many seed points as stated.

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.

CSO* ml::CSOList::addCSO ( bool  useUndoRedo = true  ) 

Adds a new CSO to the list and returns its pointer.

CSO* ml::CSOList::addCSOCopy ( CSO cso,
bool  useUndoRedo = true 
)

Adds a copy of the given CSO to the list and returns a pointer to it.

Note that this method does not set the 'this' pointer as a new CSOList, and does not alter the new CSO's unique id. Do so manually.

CSOGroup* ml::CSOList::addGroup ( bool  useUndoRedo = true  ) 

Adds a new Group to the list and returns a pointer to it.

CSOGroup* ml::CSOList::addGroupCopy ( CSOGroup group,
bool  useUndoRedo = true 
)

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, and does not alter the new CSOGroup's unique id. Do so manually.

void ml::CSOList::addNotificationObserver ( csoNotificationCB callback,
void *  userData 
)

Adds a notification observer to this CSOList.

void ml::CSOList::addSelected ( CSOGroup group  ) 

Adds the given CSOGroup to the list of selected CSOGroups (no double entry).

void ml::CSOList::addSelected ( CSO cso  ) 

Adds the given CSO to the list of selected CSOs (no double entry).

virtual void ml::CSOList::addStateToTree ( TreeNode  )  const [virtual]

Attaches the object state as children of the given parent node.

Reimplemented from ml::Base.

static void ml::CSOList::alignSeedPathLinks ( CSO cso  )  [static]

Aligns seed point positions with path point lists of a given CSO by a squared distance sum criterion.

void ml::CSOList::breakCSOandGroup ( CSO cso,
CSOGroup group,
bool  useUndoRedo = true 
)

Breaks the combination of the given CSO and the given Group.

void ml::CSOList::clearSelectedCSOs (  )  [inline]

Clears all selected CSOs.

Definition at line 153 of file CSOList.h.

void ml::CSOList::clearSelectedGroups (  )  [inline]

Clears all selected CSOGroups.

Definition at line 157 of file CSOList.h.

void ml::CSOList::clearSelectedSeedPoints (  ) 

Clears all selected seed points in all CSOs.

void ml::CSOList::clone ( const CSOList csoList,
bool  useUndoRedo = false 
)

Clones the internal CSOs and CSOGroups of the given CSOList to this one.

void ml::CSOList::combineCSOandGroup ( CSO cso,
CSOGroup group,
bool  useUndoRedo = true 
)

Combines the given CSO with the given Group.

virtual CSOList* ml::CSOList::deepCopy (  )  const [inline, virtual]

Create a deep copy of the CSOList.

Reimplemented from ml::Base.

Definition at line 417 of file CSOList.h.

void ml::CSOList::disableCSOMovedObserver (  )  [inline]

Disables the 'CSO moved' observer mechanism.

Definition at line 343 of file CSOList.h.

void ml::CSOList::disableFinishedObserver (  )  [inline]

Disables the finished observer mechanism.

Definition at line 323 of file CSOList.h.

void ml::CSOList::disableInteractionObserver (  )  [inline]

Disables the interaction observer mechanism.

Definition at line 328 of file CSOList.h.

void ml::CSOList::disableRepaintObserver (  )  [inline]

Disables the repaint observer mechanism.

Definition at line 318 of file CSOList.h.

void ml::CSOList::disableSelectionObserver (  )  [inline]

Disables the selection observer mechanism.

Definition at line 333 of file CSOList.h.

void ml::CSOList::disableStartNewCSOObserver (  )  [inline]

Disables the 'start new CSO' observer mechanism.

Definition at line 338 of file CSOList.h.

void ml::CSOList::disableUndoRedoManager (  ) 

Enables the undo/redo mechanism.

void ml::CSOList::enableCSOMovedObserver (  )  [inline]

Enables the 'CSO moved' observer mechanism.

Definition at line 341 of file CSOList.h.

void ml::CSOList::enableFinishedObserver (  )  [inline]

Enables the finished observer mechanism.

Definition at line 321 of file CSOList.h.

void ml::CSOList::enableInteractionObserver (  )  [inline]

Enables the interaction observer mechanism.

Definition at line 326 of file CSOList.h.

void ml::CSOList::enableRepaintObserver (  )  [inline]

Enables the repaint observer mechanism.

Definition at line 316 of file CSOList.h.

void ml::CSOList::enableSelectionObserver (  )  [inline]

Enables the selection observer mechanism.

Definition at line 331 of file CSOList.h.

void ml::CSOList::enableStartNewCSOObserver (  )  [inline]

Enables the 'start new CSO' observer mechanism.

Definition at line 336 of file CSOList.h.

void ml::CSOList::enableUndoRedoManager (  )  [inline]

Enables the undo/redo mechanism.

Definition at line 309 of file CSOList.h.

Vector3 ml::CSOList::getCenterOfSelectedCSOs (  )  const [inline]

/deprecated Returns the center position of all bounding boxes of all selected CSOs.

Definition at line 199 of file CSOList.h.

References CSO_DEBUG.

Vector3 ml::CSOList::getCenterOfSelectedCSOs ( bool &  resultIsValid  )  const

Returns the center position of all bounding boxes of all selected CSOs.

'resultIsValid' is false if there are no selected CSOs available.

Vector3 ml::CSOList::getCenterOfSelectedGroups (  )  const [inline]

/deprecated Returns the center position of all bounding boxes of all CSOs of all selected CSOGroups.

Definition at line 206 of file CSOList.h.

References CSO_DEBUG.

Vector3 ml::CSOList::getCenterOfSelectedGroups ( bool &  resultIsValid  )  const

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.

CSO* ml::CSOList::getCSOAt ( unsigned int  index  )  const

Returns a pointer to the CSO at the given position in the internal list.

CSO* ml::CSOList::getCSOById ( unsigned int  id  )  const

Returns a pointer to the CSO with the given unique id.

Returns NULL if no such CSO is stored in the list.

unsigned int ml::CSOList::getCSOIndex ( unsigned int  id  )  const

Returns the index of the CSO with the given id in its list.

unsigned int ml::CSOList::getCSOIndex ( CSO cso  )  const

Returns the index of the given CSO in its list.

unsigned int ml::CSOList::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.

unsigned int ml::CSOList::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.

CSOGroup* ml::CSOList::getGroupAt ( unsigned int  index  )  const

Returns Group at the given index position.

CSOGroup* ml::CSOList::getGroupById ( unsigned int  id  )  const

Returns a pointer to a Group with the given id.

CSOGroup* ml::CSOList::getGroupByLabel ( const std::string &  label  )  const

Returns a pointer to a Group with the given label.

unsigned int ml::CSOList::getGroupIndex ( unsigned int  id  )  const

Returns the index of the Group with the given id in its list.

unsigned int ml::CSOList::getGroupIndex ( CSOGroup group  )  const

Returns the index of the given Group in its list.

CSOManager* ml::CSOList::getManager (  )  [inline]

Returns a pointer to the manager of this CSOList.

Definition at line 113 of file CSOList.h.

CSOListRules& ml::CSOList::getRules (  )  [inline]

Return the rules for this CSOList.

Definition at line 405 of file CSOList.h.

CSO* ml::CSOList::getSelectedCSOAt ( unsigned int  index  )  const [inline]

Returns a pointer to the selected CSO at the given index; no checking!

Definition at line 174 of file CSOList.h.

CSOGroup* ml::CSOList::getSelectedGroupAt ( unsigned int  index  )  const [inline]

Returns a pointer to the selected CSOGroup at the given index; no checking!

Definition at line 182 of file CSOList.h.

CSOUndoRedoManager* ml::CSOList::getUndoRedoManager (  )  [inline]

Returns a pointer to the undo/redo manager of this CSOList.

Definition at line 111 of file CSOList.h.

bool ml::CSOList::hasCSO ( CSO cso  )  const

Returns whether there is the given CSO in the list.

bool ml::CSOList::hasGroup ( CSOGroup group  )  const

Returns whether there is the given CSOGroup in the list.

bool ml::CSOList::isCSOMovedNotificationEnabled (  )  const [inline]

Returns 'true' if the 'CSO moved' notification is enabled, 'false' otherwise.

Definition at line 363 of file CSOList.h.

bool ml::CSOList::isFinishedNotificationEnabled (  )  const [inline]

Returns 'true' if the finished notification is enabled, 'false' otherwise.

Definition at line 355 of file CSOList.h.

bool ml::CSOList::isInteractionInitNotificationEnabled (  )  const [inline]

Returns 'true' if the interaction init notification is enabled, 'false' otherwise.

Definition at line 357 of file CSOList.h.

bool ml::CSOList::isRepaintNotificationEnabled (  )  const [inline]

Returns 'true' if the repaint notification is enabled, 'false' otherwise.

Definition at line 353 of file CSOList.h.

bool ml::CSOList::isSelected ( CSOGroup group  )  const

Returns if the given CSOGroup is currently selected.

bool ml::CSOList::isSelected ( CSO cso  )  const

Returns if the given CSO is currently selected.

bool ml::CSOList::isSelectionNotificationEnabled (  )  const [inline]

Returns 'true' if the selection notification is enabled, 'false' otherwise.

Definition at line 359 of file CSOList.h.

bool ml::CSOList::isStartNewCSONotificationEnabled (  )  const [inline]

Returns 'true' if the 'start new CSO' notification is enabled, 'false' otherwise.

Definition at line 361 of file CSOList.h.

bool ml::CSOList::isUndoRedoManagerEnabled (  )  const [inline]

Returns 'true' if the undo/redo mechanism is enabled, 'false' otherwise.

Definition at line 348 of file CSOList.h.

bool ml::CSOList::loadFrom ( std::istream &  inStream,
bool  binary,
std::string &  message 
)

Reads out the internal structure for this list (CSOs and Groups) from the given stream.

Returns if the operation was successful. A given message string is filled.

bool ml::CSOList::loadFrom ( std::string &  filename,
std::string &  message 
)

Reads out the internal structure for this list (CSOs and Groups) from the given file.

Returns if the operation was successful. A given message string is filled.

void ml::CSOList::merge ( const CSOList csoList,
bool  mergeGroupWithSameLabel,
IdToIdMap origToThisGroupIdMap,
IdToIdMap origToThisCSOIdMap,
bool  useUndoRedo = false 
)

Merges the internal CSOs and CSOGroups of the given CSOList to this one.

ml::CSOList::ML_SET_ADDSTATE_VERSION (  ) 

void ml::CSOList::notifyObservers ( int  notificationFlag  ) 

Notifies all observers.

unsigned int ml::CSOList::numCSO (  )  const

Returns the number of CSOs in the list.

unsigned int ml::CSOList::numGroups (  )  const

Returns the number of CSOGroups.

unsigned int ml::CSOList::numSelectedCSOs (  )  const [inline]

Returns the number of selected CSOs.

Definition at line 169 of file CSOList.h.

unsigned int ml::CSOList::numSelectedGroups (  )  const [inline]

Returns the number of selected CSOGroups.

Definition at line 171 of file CSOList.h.

virtual void ml::CSOList::readStateFromTree ( TreeNode  )  [virtual]

Reads the object state from the children of the given parent node.

Reimplemented from ml::Base.

void ml::CSOList::redo (  ) 

Performs a redo of the last undone modification.

bool ml::CSOList::removeAll ( bool  useUndoRedo = true  ) 

Removes all CSOs and Groups and resets all else.

Returns 'true' if there was something to remove, 'false' otherwise.

bool ml::CSOList::removeAllCSO ( bool  useUndoRedo = true  ) 

Removes all CSOs from the list and from all Groups they are in.

Returns 'true' if there was something to remove, 'false' otherwise.

bool ml::CSOList::removeAllGroups ( bool  useUndoRedo  ) 

Removes all Groups and all groups from all CSOs.

Returns 'true' if there was something to remove, 'false' otherwise.

bool ml::CSOList::removeCSO ( unsigned int  id,
bool  useUndoRedo = true 
)

Removes a CSO by its id and removes it from all Groups.

Returns 'true' if there was something to remove, 'false' otherwise.

bool ml::CSOList::removeCSO ( CSO cso,
bool  useUndoRedo = true 
)

Removes a given CSO from the list and from Groups it is in.

Returns 'true' if there was something to remove, 'false' otherwise.

void ml::CSOList::removeFromSelection ( CSOGroup group  ) 

Removes the given CSOGroup from the list of selected CSOGroups.

void ml::CSOList::removeFromSelection ( CSO cso  ) 

Removes the given CSO from the list of selected CSOs.

bool ml::CSOList::removeGroup ( unsigned int  id,
bool  useUndoRedo = true 
)

Removes a Group by its id and removes it from all CSOs.

Returns 'true' if there was something to remove, 'false' otherwise.

bool ml::CSOList::removeGroup ( CSOGroup group,
bool  useUndoRedo = true 
)

Removes the given Group and removes the group from all CSOs.

Returns 'true' if there was something to remove, 'false' otherwise.

void ml::CSOList::removeNotificationObserver ( csoNotificationCB callback,
void *  userData 
)

Removes a notification observer from this CSOList.

static void ml::CSOList::removeNotificationObserverFromAllCSOLists ( csoNotificationCB callback,
void *  userData 
) [static]

Removes a certain notification observer from all CSOLists.

bool ml::CSOList::saveTo ( std::ostream &  outStream,
bool  binary 
) const

Pipes the internal structure of a this list (CSOs and Groups) into the given stream.

Returns if the operation was successful.

bool ml::CSOList::saveTo ( std::string &  filename,
bool  binary 
) const

Pipes the internal structure of a this list (CSOs and Groups) into the given file.

Returns if the operation was successful.

void ml::CSOList::setCurrentCSOId ( unsigned int  id  )  [inline]

Sets the current last id for CSOs. Do not mess with it.

Definition at line 129 of file CSOList.h.

void ml::CSOList::setCurrentGroupId ( unsigned int  id  )  [inline]

Sets the current last id for Groups. Do not mess with it.

Definition at line 131 of file CSOList.h.

void ml::CSOList::setManager ( CSOManager manager  ) 

Sets the pointer to the internal manager and sets the group default rules.

bool ml::CSOList::setSelected ( CSOGroup group  ) 

Set the given CSOGroup as being selected and deselects all other Groups.

Returns 'true' if the selection has actually been changed, 'false' otherwise.

bool ml::CSOList::setSelected ( CSO cso  ) 

Sets the given CSO as being selected and deselects all other CSOs.

Returns 'true' if the selection has actually been changed, 'false' otherwise.

void ml::CSOList::setUndoRedoManager ( CSOUndoRedoManager undoRedoManager  )  [inline]

Sets the internal undo/redo manager.

Definition at line 116 of file CSOList.h.

void ml::CSOList::undo (  ) 

Performs an undo of the last modification.

void ml::CSOList::updateDisplays (  ) 

Updates all connected information/managing modules (not the renderers!).


Member Data Documentation

Flag for the observer mechanism, should be set if a CSO action is finished.

Definition at line 388 of file CSOList.h.

Flag for the observer mechanism, should be set if a CSO was moved.

Definition at line 400 of file CSOList.h.

Flag for the observer mechanism, should be set if a CSO selection changes.

Definition at line 383 of file CSOList.h.

Flag for the observer mechanism, should be set if a CSOGroup action is finished.

Definition at line 390 of file CSOList.h.

Flag for the observer mechanism, should be set if a CSOGroup selection changes.

Definition at line 385 of file CSOList.h.

Flag for the observer mechanism, should be set if the interaction must be initialized.

Definition at line 396 of file CSOList.h.

const int ml::CSOList::NOTIFICATION_NONE [static]

Flag for the observer mechanism, signalizing no notification at all.

Definition at line 380 of file CSOList.h.

Flag for the observer mechanism, should be set if a repaint should occur.

Definition at line 393 of file CSOList.h.

Flag for the observer mechanism, signalizing that the generation of a new CSO has been started.

Definition at line 398 of file CSOList.h.

const char* ml::CSOList::sLineStyleModeStrings[5] [static]

Strings for line style enumerations.

Definition at line 375 of file CSOList.h.

const char* ml::CSOList::sSeedPointStyleStrings[3] [static]

Strings for marker mode enumerations.

Definition at line 377 of file CSOList.h.

const char* ml::CSOList::sVoxelWriteModeStrings[4] [static]

Strings for voxel write mode enumerations.

Definition at line 373 of file CSOList.h.


The documentation for this class was generated from the following file:

Generated on Sat Sep 3 18:39:41 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8