src/ModelAPI/ModelAPI_Events.h

   1 // File:        ModelAPI_Events.h
   2 // Created:     10 Apr 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef ModelAPI_Events_H_
   6 #define ModelAPI_Events_H_
   7
   8 #include <ModelAPI.h>
   9 #include <Events_MessageGroup.h>
  10 #include <boost/shared_ptr.hpp>
  11 #include <string>
  12 #include <set>
  13
  14 #include "ModelAPI_Object.h"
  15
  16 class ModelAPI_Document;
  17
  18 /// Event ID that feature is created (comes with ModelAPI_ObjectUpdatedMessage)
  19 static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
  20 /// Event ID that data of feature is updated (comes with Model_ObjectUpdatedMessage)
  21 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
  22 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
  23 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
  24 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
  25 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
  26 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  27 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
  28 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
  29 static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched";
  30 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
  31 static const char * EVENT_PLUGIN_LOADED = "PliginLoaded";
  32
  33 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
  34 class ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
  35 {
  36  protected:
  37   ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0)
  38       : Events_MessageGroup(theID, theSender)
  39   {
  40   }
  41
  42  public:
  43   /// Returns the feature that has been updated
  44   virtual std::set<ObjectPtr> objects() const = 0;
  45
  46   //! Creates a new empty group (to store it in the loop before flush)
  47   virtual Events_MessageGroup* newEmpty() = 0;
  48
  49   //! Allows to join the given message with the current one
  50   virtual void Join(Events_MessageGroup& theJoined) = 0;
  51 };
  52
  53 /// Message that feature was deleted (used for Object Browser update)
  54 class ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
  55 {
  56  protected:
  57   ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0)
  58       : Events_MessageGroup(theID, theSender)
  59   {
  60   }
  61
  62  public:
  63   /// Returns the feature that has been updated
  64   virtual boost::shared_ptr<ModelAPI_Document> document() const = 0;
  65
  66   /// Returns the group where the feature was deleted
  67   virtual const std::set<std::string>& groups() const = 0;
  68
  69   virtual Events_MessageGroup* newEmpty() = 0;
  70
  71   virtual const Events_ID messageId() = 0;
  72
  73   virtual void Join(Events_MessageGroup& theJoined) = 0;
  74 };
  75
  76 /// Allows to create ModelAPI messages
  77 class MODELAPI_EXPORT ModelAPI_EventCreator
  78 {
  79  public:
  80   /// creates created, updated or moved messages and sends to the loop
  81   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
  82                            const bool isGroupped = true) const = 0;
  83   /// creates deleted message and sends to the loop
  84   virtual void sendDeleted(const boost::shared_ptr<ModelAPI_Document>& theDoc,
  85                            const std::string& theGroup) const = 0;
  86
  87   /// returns the creator instance
  88   static const ModelAPI_EventCreator* get();
  89
  90   /// sets the creator instance
  91   static void set(const ModelAPI_EventCreator* theCreator);
  92 };
  93
  94 #endif