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";
31 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
32 class ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
35 ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0)
36 : Events_MessageGroup(theID, theSender)
41 /// Returns the feature that has been updated
42 virtual std::set<ObjectPtr> objects() const = 0;
44 //! Creates a new empty group (to store it in the loop before flush)
45 virtual Events_MessageGroup* newEmpty() = 0;
47 //! Allows to join the given message with the current one
48 virtual void Join(Events_MessageGroup& theJoined) = 0;
51 /// Message that feature was deleted (used for Object Browser update)
52 class ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
55 ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0)
56 : Events_MessageGroup(theID, theSender)
61 /// Returns the feature that has been updated
62 virtual boost::shared_ptr<ModelAPI_Document> document() const = 0;
64 /// Returns the group where the feature was deleted
65 virtual const std::set<std::string>& groups() const = 0;
67 virtual Events_MessageGroup* newEmpty() = 0;
69 virtual const Events_ID messageId() = 0;
71 virtual void Join(Events_MessageGroup& theJoined) = 0;
74 /// Allows to create ModelAPI messages
75 class MODELAPI_EXPORT ModelAPI_EventCreator
78 /// creates created, updated or moved messages and sends to the loop
79 virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
80 const bool isGroupped = true) const = 0;
81 /// creates deleted message and sends to the loop
82 virtual void sendDeleted(const boost::shared_ptr<ModelAPI_Document>& theDoc,
83 const std::string& theGroup) const = 0;
85 /// returns the creator instance
86 static const ModelAPI_EventCreator* get();
88 /// sets the creator instance
89 static void set(const ModelAPI_EventCreator* theCreator);