1 // File: ModelAPI_Events.h
2 // Created: 10 Apr 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef ModelAPI_Events_H_
6 #define ModelAPI_Events_H_
9 #include <Events_MessageGroup.h>
10 #include <boost/shared_ptr.hpp>
14 #include "ModelAPI_Object.h"
16 class ModelAPI_Document;
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";
33 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
34 class ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
37 ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0)
38 : Events_MessageGroup(theID, theSender)
43 /// Returns the feature that has been updated
44 virtual std::set<ObjectPtr> objects() const = 0;
46 //! Creates a new empty group (to store it in the loop before flush)
47 virtual boost::shared_ptr<Events_MessageGroup> newEmpty() = 0;
49 //! Allows to join the given message with the current one
50 virtual void Join(const boost::shared_ptr<Events_MessageGroup>& theJoined) = 0;
53 /// Message that feature was deleted (used for Object Browser update)
54 class ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
57 ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0)
58 : Events_MessageGroup(theID, theSender)
63 /// Returns the feature that has been updated
64 virtual boost::shared_ptr<ModelAPI_Document> document() const = 0;
66 /// Returns the group where the feature was deleted
67 virtual const std::set<std::string>& groups() const = 0;
69 virtual boost::shared_ptr<Events_MessageGroup> newEmpty() = 0;
71 virtual const Events_ID messageId() = 0;
73 virtual void Join(const boost::shared_ptr<Events_MessageGroup>& theJoined) = 0;
76 /// Allows to create ModelAPI messages
77 class MODELAPI_EXPORT ModelAPI_EventCreator
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;
87 /// returns the creator instance
88 static const ModelAPI_EventCreator* get();
90 /// sets the creator instance
91 static void set(const ModelAPI_EventCreator* theCreator);