src/ModelAPI/ModelAPI_Events.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_Events.h
   4 // Created:     10 Apr 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef MODELAPI_EVENTS_H_
   8 #define MODELAPI_EVENTS_H_
   9
  10 #include <ModelAPI.h>
  11 #include <ModelAPI_Object.h>
  12 #include <ModelAPI_Feature.h>
  13 #include <Events_MessageGroup.h>
  14
  15 #include <memory>
  16 #include <string>
  17 #include <set>
  18 #include <map>
  19
  20
  21 class ModelAPI_Document;
  22
  23 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
  24 static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
  25 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
  26 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
  27 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
  28 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
  29 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
  30 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
  31 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  32 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
  33 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  34 static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched";
  35 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
  36 static const char * EVENT_PLUGIN_LOADED = "PliginLoaded";
  37 /// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage)
  38 static const char * EVENT_OBJECT_TOSHOW = "ObjectShow";
  39 /// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage)
  40 static const char * EVENT_OBJECT_TOHIDE = "ObjectHide";
  41 //
  42 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
  43
  44 static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
  45 static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
  46
  47 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
  48 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
  49 {
  50  protected:
  51   /// Creates an empty message
  52   ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
  53   /// The virtual destructor
  54   virtual ~ModelAPI_ObjectUpdatedMessage();
  55
  56  public:
  57   /// Returns the feature that has been updated
  58   virtual const std::set<ObjectPtr>& objects() const = 0;
  59
  60   //! Creates a new empty group (to store it in the loop before flush)
  61   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  62
  63   //! Allows to join the given message with the current one
  64   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
  65 };
  66
  67 /// Message that feature was deleted (used for Object Browser update)
  68 class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
  69 {
  70 protected:
  71   /// Creates an empty message
  72   ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
  73   /// The virtual destructor
  74   virtual ~ModelAPI_ObjectDeletedMessage();
  75
  76 public:
  77   /// Returns the feature that has been updated
  78   virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
  79
  80   /// Returns the group where the feature was deleted
  81   virtual const std::set<std::string>& groups() const = 0;
  82
  83   /// Creates the new empty message of this kind
  84   virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
  85
  86   /// Returns the identifier of the kind of a message
  87   virtual const Events_ID messageId() = 0;
  88
  89   /// Appenad to this message the given one.
  90   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
  91 };
  92
  93 /// Allows to create ModelAPI messages
  94 class MODELAPI_EXPORT ModelAPI_EventCreator
  95 {
  96 public:
  97   /// creates created, updated or moved messages and sends to the loop
  98   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
  99                            const bool isGroupped = true) const = 0;
 100   /// creates deleted message and sends to the loop
 101   virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
 102                            const std::string& theGroup) const = 0;
 103
 104   /// returns the creator instance
 105   static const ModelAPI_EventCreator* get();
 106
 107   /// sets the creator instance
 108   static void set(const ModelAPI_EventCreator* theCreator);
 109 };
 110
 111 // TODO(sbh): Move this message into a separate package, like "GuiAPI"
 112 /// Contains the state information about the feature: is it enabled or disabled.
 113 class ModelAPI_FeatureStateMessage : public Events_Message
 114 {
 115 public:
 116   /// Creates an empty message
 117   MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
 118   /// The virtual destructor
 119   MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
 120
 121   /// Returns the feature this message is related to
 122   MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
 123   /// Stores the feature this message is related to
 124   MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
 125   // For response
 126   /// Returns true if feature has specific state
 127   MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
 128   /// Returns true if feature is enabled
 129   MODELAPI_EXPORT bool state(const  std::string& theFeatureId, bool theDefault = false) const;
 130   /// Stores the feature state
 131   MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
 132   /// Returns all feature IDs with states
 133   MODELAPI_EXPORT std::list<std::string> features() const;
 134
 135  private:
 136   /// For Request
 137   std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
 138   /// For response
 139   std::map<std::string, bool> myFeatureState;
 140 };
 141
 142 #endif