CSOManager.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
 
 
#pragma once
 
#include "../CSOList.h"
 
#include "../CSORules/CSOGroupRules.h"
#include "../CSORules/CSOListRules.h"
 
 
ML_START_NAMESPACE
 
 
class MLCSO_EXPORT CSOManager : public Module
{
 
public:
 
  CSOManager(int numInImages=0,int numOutImages=0);
 
  void updateManager();
 
  void updateCSOManager();
  void updateGroupManager();
 
 
  inline int getSelectionPathPointColoringMode() { return _selectionPathPointColoringModeFld->getEnumValue(); }
  inline int getSelectionPathPointWidthMode() { return _selectionPathPointWidthModeFld->getEnumValue(); }
  void getSelectionPathPointColor(Vector3& origColor);
  void getSelectionPathPointWidth(float& origLineWidth);
 
  Vector3 getSelectedPathPointsFixedColor() const { return _selectionFixedPathPointColorFld->getVector3Value(); }
  float getSelectedPathPointsBrightenValue() const { return _selectionBrightenPathPointColorFld->getFloatValue(); }
  float getSelectedPathPointsFixedLineWidth() const { return _selectionFixedPathPointWidthFld->getFloatValue(); }
  float getSelectedPathPointsWidenValue() const { return _selectionWidenPathPointWidthFld->getFloatValue(); }
 
  Vector3 getSelectedSeedPointFixedColor() const { return _selectedSeedPointFixedColorFld->getVector3Value(); }
  float getSelectedSeedPointBrightenValue() const { return _selectedSeedPointBrightenColorFld->getFloatValue(); }
  float getSelectedSeedPointFixedSize() const { return  _selectedSeedPointSizeFld->getFloatValue(); }
  float getSelectedSeedPointEnlargeValue() const { return _selectedSeedPointEnlargeSizeFld->getFloatValue(); }
 
  inline int getSelectedSeedPointColoringMode() { return _selectedSeedPointColoringModeFld->getEnumValue(); }
  inline int getSelectedSeedPointSizeMode() { return _selectedSeedPointSizeModeFld->getEnumValue(); }
  void getSelectedSeedPointColor(Vector3& origColor);
  void getSelectedSeedPointSize(float& origSize);
 
 
  std::string getCSODefaultLabel();
 
  inline std::string getCSODefaultDescription() const { return _csoDefaultDescriptionFld->getStringValue(); }
  inline bool getCSODefaultShowState() const { return _csoDefaultShowStateFld->getBoolValue(); }
  inline bool getCSODefaultVoxelizeState() const { return _csoDefaultVoxelizeStateFld->getBoolValue(); }
  inline bool getCSODefaultEditableState() const { return _csoDefaultEditableStateFld->getBoolValue(); }
 
 
  std::string getGroupDefaultLabel();
 
  inline std::string getGroupDefaultDescription() const { return _groupDefaultDescriptionFld->getStringValue(); }
  inline bool getGroupDefaultUseTimePointIndex() const { return _groupDefaultUseTimePointIndexFld->getBoolValue(); }
  inline int  getGroupDefaultTimePointIndex() const { return static_cast<int>(_groupDefaultTimePointIndexFld->getIntValue()); }
  inline bool getGroupDefaultUseShowState() const { return _groupDefaultUseShowStateFld->getBoolValue(); }
  inline bool getGroupDefaultShowState() const { return _groupDefaultShowStateFld->getBoolValue(); }
  inline bool getGroupDefaultUseVoxelizeState() const { return _groupDefaultUseVoxelizeStateFld->getBoolValue(); }
  inline bool getGroupDefaultVoxelizeState() const { return _groupDefaultVoxelizeStateFld->getBoolValue(); }
  inline bool getGroupDefaultUseEditableState() const { return _groupDefaultUseEditableStateFld->getBoolValue(); }
  inline bool getGroupDefaultEditableState() const { return _groupDefaultEditableStateFld->getBoolValue(); }
 
  inline bool getGroupDefaultUsePathPointStyle() const { return _groupDefaultUsePathPointStyleFld->getBoolValue(); }
  inline CSOPathPointsStyle getGroupDefaultPathPointStyle() const { return static_cast<CSOPathPointsStyle>(_groupDefaultPathPointStyleFld->getEnumValue()); }
  inline bool getGroupDefaultUsePathPointWidth() const { return _groupDefaultUsePathPointWidthFld->getBoolValue(); }
  inline float getGroupDefaultPathPointWidth() const { return _groupDefaultPathPointWidthFld->getFloatValue(); }
  inline bool getGroupDefaultUsePathPointColor() const { return _groupDefaultUsePathPointColorFld->getBoolValue(); }
  inline Vector3 getGroupDefaultPathPointColor() const { return _groupDefaultPathPointColorFld->getVector3Value();  }
  inline bool getGroupDefaultUsePathPointAlpha() const { return _groupDefaultUsePathPointAlphaFld->getBoolValue(); }
  inline float getGroupDefaultPathPointAlpha() const { return _groupDefaultPathPointAlphaFld->getFloatValue(); }
 
  inline bool getGroupDefaultUseSeedPointStyle() const { return _groupDefaultUseSeedPointStyleFld->getBoolValue(); }
  inline int  getGroupDefaultSeedPointStyle() const { return _groupDefaultSeedPointStyleFld->getEnumValue(); }
  inline bool getGroupDefaultUseSeedPointSize() const { return _groupDefaultUseSeedPointSizeFld->getBoolValue(); }
  inline float getGroupDefaultSeedPointSize() const { return _groupDefaultSeedPointSizeFld->getFloatValue(); }
  inline bool getGroupDefaultUseSeedPointColor() const { return _groupDefaultUseSeedPointColorFld->getBoolValue(); }
  inline Vector3 getGroupDefaultSeedPointColor() const { return _groupDefaultSeedPointColorFld->getVector3Value(); }
  inline bool getGroupDefaultUseSeedPointAlpha() const { return _groupDefaultUseSeedPointAlphaFld->getBoolValue(); }
  inline float getGroupDefaultSeedPointAlpha() const { return _groupDefaultSeedPointAlphaFld->getFloatValue(); }
 
  inline bool getGroupDefaultUseVoxelWriteMode() const { return _groupDefaultUseVoxelWriteModeFld->getBoolValue(); }
  inline int getGroupDefaultVoxelWriteMode() const { return _groupDefaultVoxelWriteModeFld->getEnumValue(); }
  inline bool getGroupDefaultUseVoxelWriteValue() const { return _groupDefaultUseVoxelWriteValueFld->getBoolValue(); }
  inline float getGroupDefaultVoxelWriteValue() const { return _groupDefaultVoxelWriteValueFld->getFloatValue(); }
 
 
  inline int getGroupDefaultNumMaximumCSOs() const { return static_cast<int>(_groupDefaultNumMaximumCSOsFld->getIntValue()); }
  inline CSOGroupOverflowHandling getGroupDefaultOverflowHandling() const { return static_cast<CSOGroupOverflowHandling>(_groupDefaultOverflowHandlingFld->getEnumValue()); }
  inline CSORemoveHandling getGroupDefaultRemoveFromGroupHandling() const { return static_cast<CSORemoveHandling>(_groupDefaultRemoveFromGroupHandlingFld->getEnumValue()); }
  inline CSORemoveHandling getGroupDefaultDeleteGroupCSOHandling()  const { return static_cast<CSORemoveHandling>(_groupDefaultDeleteGroupCSOHandlingFld->getEnumValue()); }
  inline CSORemoveEmptyGroupHandling getDefaultRemoveEmptyGroupHandling() const { return static_cast<CSORemoveEmptyGroupHandling>(_listDefaultRemoveEmptyGroupHandlingFld->getEnumValue()); }
 
protected:
 
  ~CSOManager() override;
 
  void activateAttachments() override;
 
  void handleNotification(Field* field) override;
 
  void setInternalVariables();
 
private:
 
  /* FIELDS */
 
  BaseField* _outCSOListFld;
  BaseField* _inCSOListFld;
 
  BaseField* _inUndoContextFld;
 
  BoolField* _workDirectlyOnInputCSOListFld;
  NotifyField* _copyInputCSOListFld;
 
  StringField* _csoDisplayTreeFld;
  StringField* _groupDisplayTreeFld;
  BoolField* _shouldUpdateCsoDisplayTreeFld;
  BoolField* _shouldUpdateGroupDisplayTreeFld;
 
  StringField* _csoSelectedItemsFld;
  StringField* _groupSelectedItemsFld;
  StringField* _groupSelectedCSOItemsFld;
  StringField* _csoSelectedGroupItemsFld;
 
  BoolField* _enableUndoRedoFld;
  NotifyField* _triggerUndoFld;
  NotifyField* _triggerRedoFld;
  IntField* _numUndosFld;
  IntField* _numRedosFld;
  IntField* _undoStackLimitFld;
 
  NotifyField* _addCSOtoGroupFld;
  NotifyField* _breakCSOFromGroupFld;
 
  NotifyField* _removeAllCSOsAndGroupsFld;
 
  NotifyField* _csoRemoveSelectedFld;
  NotifyField* _csoCopySelectedFld;
  NotifyField* _csoPasteFld;
 
  NotifyField* _groupCreateNewFld;
  BoolField* _selectLastCreatedGroupFld;
  NotifyField* _groupRemoveSelectedFld;
  NotifyField* _groupCopySelectedFld;
  NotifyField* _groupPasteFld;
 
  TypedEnumField<CSOSelectionColoring>* _selectionPathPointColoringModeFld;
  TypedEnumField<CSOSelectionLineWidth>* _selectionPathPointWidthModeFld;
  FloatField* _selectionBrightenPathPointColorFld;
  ColorField* _selectionFixedPathPointColorFld;
  FloatField* _selectionWidenPathPointWidthFld;
  FloatField* _selectionFixedPathPointWidthFld;
 
  TypedEnumField<CSOSelectedSeedPointColoring>* _selectedSeedPointColoringModeFld;
  TypedEnumField<CSOSelectedSeedPointSize>* _selectedSeedPointSizeModeFld;
  FloatField* _selectedSeedPointBrightenColorFld;
  ColorField* _selectedSeedPointFixedColorFld;
  FloatField* _selectedSeedPointEnlargeSizeFld;
  FloatField* _selectedSeedPointSizeFld;
 
  IntField* _csoSingleIdFld;
  StringField* _csoSingleLabelFld;
  StringField* _csoSingleDescriptionFld;
 
  IntField* _csoSingleTimePointIndexFld;
  BoolField* _csoSingleShowStateFld;
  BoolField* _csoSingleVoxelizeStateFld;
  BoolField* _csoSingleEditableStateFld;
 
  TypedEnumField<CSOPathPointsStyle>* _csoSinglePathPointStyleFld;
  FloatField* _csoSinglePathPointWidthFld;
  ColorField* _csoSinglePathPointColorFld;
  FloatField* _csoSinglePathPointAlphaFld;
 
  TypedEnumField<CSOSeedPointStyle>* _csoSingleSeedPointStyleFld;
  FloatField* _csoSingleSeedPointSizeFld;
  ColorField* _csoSingleSeedPointColorFld;
  FloatField* _csoSingleSeedPointAlphaFld;
 
  TypedEnumField<CSOVoxelWriteModes>* _csoSingleVoxelWriteModeFld;
  FloatField* _csoSingleVoxelWriteValueFld;
 
  StringField* _csoDefaultLabelFld;
  BoolField* _csoDefaultLabelAddUniqueIdFld;
  StringField* _csoDefaultLabelUniqueIdFormatFld;
  BoolField* _csoDefaultLabelAddUniqueIdAlwaysFld;
 
  StringField* _csoDefaultDescriptionFld;
  BoolField* _csoDefaultShowStateFld;
  BoolField* _csoDefaultVoxelizeStateFld;
  BoolField* _csoDefaultEditableStateFld;
 
  NotifyField* _csoSingleApplyFld;
 
 
  IntField* _groupSingleIdFld;
  StringField* _groupSingleLabelFld;
  StringField* _groupSingleDescriptionFld;
 
  BoolField* _groupSingleUseTimePointIndexFld;
  IntField* _groupSingleTimePointIndexFld;
  BoolField* _groupSingleUseShowStateFld;
  BoolField* _groupSingleShowStateFld;
  BoolField* _groupSingleUseVoxelizeStateFld;
  BoolField* _groupSingleVoxelizeStateFld;
  BoolField* _groupSingleUseEditableStateFld;
  BoolField* _groupSingleEditableStateFld;
 
 
  BoolField* _groupSingleUsePathPointStyleFld;
  TypedEnumField<CSOPathPointsStyle>* _groupSinglePathPointStyleFld;
  BoolField* _groupSingleUsePathPointWidthFld;
  FloatField* _groupSinglePathPointWidthFld;
  BoolField* _groupSingleUsePathPointColorFld;
  ColorField* _groupSinglePathPointColorFld;
  BoolField* _groupSingleUsePathPointAlphaFld;
  FloatField* _groupSinglePathPointAlphaFld;
 
  BoolField* _groupSingleUseSeedPointStyleFld;
  TypedEnumField<CSOSeedPointStyle>* _groupSingleSeedPointStyleFld;
  BoolField* _groupSingleUseSeedPointSizeFld;
  FloatField* _groupSingleSeedPointSizeFld;
  BoolField* _groupSingleUseSeedPointColorFld;
  ColorField* _groupSingleSeedPointColorFld;
  BoolField* _groupSingleUseSeedPointAlphaFld;
  FloatField* _groupSingleSeedPointAlphaFld;
 
  BoolField* _groupSingleUseVoxelWriteModeFld;
  TypedEnumField<CSOVoxelWriteModes>* _groupSingleVoxelWriteModeFld;
  BoolField* _groupSingleUseVoxelWriteValueFld;
  FloatField* _groupSingleVoxelWriteValueFld;
 
  IntField* _groupSingleNumMaximumCSOsFld;
  TypedEnumField<CSOGroupOverflowHandling>* _groupSingleOverflowHandlingFld;
  TypedEnumField<CSORemoveHandling>* _groupSingleRemoveFromGroupHandlingFld;
  TypedEnumField<CSORemoveHandling>* _groupSingleDeleteGroupCSOHandlingFld;
 
  StringField* _groupDefaultLabelFld;
  BoolField* _groupDefaultLabelAddUniqueIdFld;
  StringField* _groupDefaultLabelUniqueIdFormatFld;
  BoolField* _groupDefaultLabelAddUniqueIdAlwaysFld;
 
  StringField* _groupDefaultDescriptionFld;
 
  BoolField* _groupDefaultUseTimePointIndexFld;
  IntField* _groupDefaultTimePointIndexFld;
  BoolField* _groupDefaultUseShowStateFld;
  BoolField* _groupDefaultShowStateFld;
  BoolField* _groupDefaultUseVoxelizeStateFld;
  BoolField* _groupDefaultVoxelizeStateFld;
  BoolField* _groupDefaultUseEditableStateFld;
  BoolField* _groupDefaultEditableStateFld;
 
 
  BoolField* _groupDefaultUsePathPointStyleFld;
  TypedEnumField<CSOPathPointsStyle>* _groupDefaultPathPointStyleFld;
  BoolField* _groupDefaultUsePathPointWidthFld;
  FloatField* _groupDefaultPathPointWidthFld;
  BoolField* _groupDefaultUsePathPointColorFld;
  ColorField* _groupDefaultPathPointColorFld;
  BoolField* _groupDefaultUsePathPointAlphaFld;
  FloatField* _groupDefaultPathPointAlphaFld;
 
  BoolField* _groupDefaultUseSeedPointSizeFld;
  FloatField* _groupDefaultSeedPointSizeFld;
  BoolField* _groupDefaultUseSeedPointStyleFld;
  TypedEnumField<CSOSeedPointStyle>* _groupDefaultSeedPointStyleFld;
  BoolField* _groupDefaultUseSeedPointColorFld;
  ColorField* _groupDefaultSeedPointColorFld;
  BoolField* _groupDefaultUseSeedPointAlphaFld;
  FloatField* _groupDefaultSeedPointAlphaFld;
 
  BoolField* _groupDefaultUseVoxelWriteModeFld;
  TypedEnumField<CSOVoxelWriteModes>* _groupDefaultVoxelWriteModeFld;
  BoolField* _groupDefaultUseVoxelWriteValueFld;
  FloatField* _groupDefaultVoxelWriteValueFld;
 
  IntField* _groupDefaultNumMaximumCSOsFld;
  TypedEnumField<CSOGroupOverflowHandling>* _groupDefaultOverflowHandlingFld;
  TypedEnumField<CSORemoveHandling>* _groupDefaultRemoveFromGroupHandlingFld;
  TypedEnumField<CSORemoveHandling>* _groupDefaultDeleteGroupCSOHandlingFld;
  NotifyField* _groupSingleApplyFld;
 
 
  TypedEnumField<CSORemoveEmptyGroupHandling>* _listSingleRemoveEmptyGroupHandlingFld;
  TypedEnumField<CSORemoveEmptyGroupHandling>* _listDefaultRemoveEmptyGroupHandlingFld;
 
 
  BoolField* _useSelectionCSONotificationFld;
  BoolField* _useSelectionGroupNotificationFld;
  BoolField* _useFinishedCSONotificationFld;
  BoolField* _useFinishedGroupNotificationFld;
  BoolField* _useCSOMovedNotificationFld;
  BoolField* _useRepaintNotificationFld;
  BoolField* _useInteractionInitNotificationFld;
  BoolField* _useNewCSOStartedNotificationFld;
 
  NotifyField* _notifyOnSelectionCSOFld;
  NotifyField* _notifyOnSelectionGroupFld;
  NotifyField* _notifyOnFinishedCSOFld;
  NotifyField* _notifyOnFinishedGroupFld;
  NotifyField* _notifyOnCSOMovedFld;
  NotifyField* _notifyOnRepaintFld;
  NotifyField* _notifyOnInteractionInitFld;
  NotifyField* _notifyOnStartNewCSOFld;
 
 
  BoolField* _enableSelectionNotificationFld;
  BoolField* _enableFinishedNotificationFld;
  BoolField* _enableCSOMovedNotificationFld;
  BoolField* _enableRepaintNotificationFld;
 
  NotifyField* _triggerSelectionNotificationFld;
  NotifyField* _triggerFinishedNotificationFld;
  NotifyField* _triggerCSOMovedNotificationFld;
  NotifyField* _triggerRepaintNotificationFld;
  BoolField* _outputApplicationEventsDebugFld;
 
 
  /* MEMBER VARIABLES */
 
  struct GroupCSOPair {
    CSO*      cso;
    CSOGroup* group;
  };
 
  CSOListPtr _outCSOList;
  CSOListPtr _inCSOList;
 
  bool _isOutputCSOListOwner;
  bool _isWorkingDirectlyOnInputCSOList;
 
  std::vector<GroupCSOPair>_csoSelectedGroups;
  std::vector<GroupCSOPair>_groupSelectedCSOs;
 
  std::vector<CSO*>_copiedCSOs;
  std::vector<CSOGroup*>_copiedGroups;
 
  bool _isInNotificationCB;
 
  bool _useSelectionCSONotification;
  bool _useSelectionGroupNotification;
  bool _useFinishedCSONotification;
  bool _useFinishedGroupNotification;
  bool _useCSOMovedNotification;
  bool _useRepaintNotification;
  bool _useInteractionInitNotification;
  bool _useNewCSOStartedNotification;
 
  bool _selectedCSOItemsChangedFromField;
  bool _selectedCSOGroupItemsChangedFromField;
 
  bool _isNotifyingItself;
 
  /* METHODS */
 
  static void _csoListNotificationCB(void* userData, int notificationFlag);
 
  void _updateManagerFields();
 
  void _updateCSOManagerFields();
  void _updateGroupManagerFields();
 
  void _updateInformationFields();
 
  bool _parseCSOSelectedItemsString();
  bool _parseGroupSelectedItemsString();
 
  void _parseStringToVector(std::string toParse, std::vector<int>& parsedIds);
 
  void _parseCSOGroupToVector();
  void _parseGroupCSOToVector();
 
  void _parsePair(std::string toParse, int& firstId, int& secondId);
  void _addPairToVector(int csoId, int groupId, std::vector<GroupCSOPair>& gcPairVec);
 
 
  void _openUndoRedoGroup(const std::string& description);
  void _closeUndoRedoGroup();
 
  void _createCSOString();
  void _createGroupString();
 
  void _updateCSOInformationFields();
  void _updateGroupInformationFields();
 
  void _copySelectedCSOs();
  void _copySelectedGroups();
  void _pasteCopiedCSOs();
  void _pasteCopiedGroups();
 
  void _addSelectedCSOtoGroup();
  void _breakSelectedCSOFromGroup();
 
  void _removeCSOs();
  void _removeGroups();
 
  void _createGroup();
 
  static void baseEventCB(void* userData, BaseEvent* event);
 
  int _eventGroupCounter;
 
  ML_MODULE_CLASS_HEADER(CSOManager);
};
 
 
ML_END_NAMESPACE