CSOEvent.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2012, 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 "../MLCSOIncludes.h"
 
 
ML_START_NAMESPACE
 
//---------------------------------------------------------------------------

class MLCSO_EXPORT CSOEvent : public BaseEvent
{
public:
 
  // NOTE: if you change the enum CSOEventType, you need to accommodate the list of event names
  //       in CSOManager.cpp :: baseEventCB
 
  // NOTE: also accommodate the CSOEventWrapper

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

  CSOEvent()
  {
    _isPostCommand = true;
    _eventType = NONE;
    _moduleEventGroupId = 0;
  }

  CSOEvent(CSOEventType eventTypeArg, bool isPostCommandArg=true)
  {
    _eventType = eventTypeArg;
    _isPostCommand = isPostCommandArg;
    _moduleEventGroupId = 0;
  }

  CSOEvent& operator = (const CSOEvent& event);

  bool hasCSOIds() const { return _csoIds.size() > 0; }
  bool hasGroupIds() const { return _groupIds.size() > 0; }

  void addCSOId(unsigned int id);
  void addGroupId(unsigned int id);

  void addCSOIds(const CSOIdVector& csoIds);
  void addGroupIds(const CSOIdVector& groupIds);

  const CSOIdVector& csoIds() const { return _csoIds; }
  const CSOIdVector& groupIds() const { return _groupIds; }

  CSOEventType eventType() const { return _eventType; }

  static std::string getEventTypeName(CSOEventType eventType);

  void setEventType(CSOEventType eventTypeArg) { _eventType = eventTypeArg; }

  bool isPostCommand() const { return _isPostCommand; }
  bool isPreCommand() const { return !_isPostCommand; }
  void setIsPostCommand(bool flag) { _isPostCommand = flag; }

  void setSenderType(const std::string& senderTypeArg) { _senderType = senderTypeArg; }
  std::string senderType() const { return _senderType; }

  void setSenderName(const std::string& senderNameArg) { _senderName = senderNameArg; }
  std::string senderName() const { return _senderName; }

  void setCustomMessage(const std::string& customMessageArg) { _customMessage = customMessageArg; }
  std::string customMessage() const { return _customMessage; }

  void setModuleEventGroupId(MLuint64 id) { _moduleEventGroupId = id; }
  MLuint64 moduleEventGroupId() const { return _moduleEventGroupId; }
 
  ML_CLASS_HEADER(CSOEvent);
 
protected:

  CSOIdVector _csoIds;
  CSOIdVector _groupIds;
  CSOEventType _eventType;
  bool _isPostCommand;
 
  // Type of event sender.
  std::string _senderType;
  // Instance name of event sender.
  std::string _senderName;
  // Some custom message if events are generated by scripting.
  std::string _customMessage;
  // A unique ID to check whether opening/closing module events match.
  MLuint64 _moduleEventGroupId;
};
 
//---------------------------------------------------------------------------
 
ML_END_NAMESPACE