Performance optimization: allow to put temporary objects into selection attributes...

[modules/shaper.git] / src / ModelAPI / ModelAPI_Events.h

diff --git a/src/ModelAPI/ModelAPI_Events.h b/src/ModelAPI/ModelAPI_Events.h
index 20d2530bb1c9ddf12d3bf35642b0acbf9cc18998..eb64dc19efbf29a8d77c763c3f9021b12ee17209 100644 (file)
--- a/src/ModelAPI/ModelAPI_Events.h
+++ b/src/ModelAPI/ModelAPI_Events.h
@@ -10,6 +10,7 @@
 #include <ModelAPI.h>
 #include <ModelAPI_Object.h>
 #include <ModelAPI_Feature.h>
+#include <ModelAPI_Attribute.h>
 #include <Events_MessageGroup.h>
 #include <Events_Loop.h>
 
@@ -27,6 +28,8 @@ static const char * EVENT_OBJECT_CREATED = "ObjectCreated";
 static const char * EVENT_OBJECT_UPDATED = "ObjectUpdated";
 /// Event ID that data of feature is deleted (comes with Model_ObjectDeletedMessage)
 static const char * EVENT_OBJECT_DELETED = "ObjectDeleted";
+/// Event ID that name of feature is changed (comes with Model_ObjectRenamedMessage)
+static const char * EVENT_OBJECT_RENAMED = "ObjectRenamed";
 /// Event ID that data of feature is updated (comes with ModelAPI_ObjectUpdatedMessage)
 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
@@ -35,16 +38,16 @@ static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
 static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched";
 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
 static const char * EVENT_PLUGIN_LOADED = "PliginLoaded";
-/// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage)
-static const char * EVENT_OBJECT_TOSHOW = "ObjectShow";
-/// Event ID that data of feature has to be shown (comes with ModelAPI_ObjectUpdatedMessage)
-static const char * EVENT_OBJECT_TOHIDE = "ObjectHide";
 //
 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
 
 static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
 static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
 
+
+static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
+static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
+
 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
 {
@@ -163,4 +166,80 @@ class ModelAPI_DocumentCreatedMessage : public Events_Message
   MODELAPI_EXPORT void setDocument(DocumentPtr theDocument);
 };
 
+/// Message that attribute text should be evaluated in the attribute value
+class ModelAPI_AttributeEvalMessage : public Events_Message
+{
+  AttributePtr myAttribute;
+
+ public:
+  /// Static. Returns EventID of the message.
+  MODELAPI_EXPORT static Events_ID& eventId()
+  {
+    static const char * MY_ATTRIBUTE_EVALUATION_EVENT_ID("AttributeEvaluationRequest");
+    static Events_ID anId = Events_Loop::eventByName(MY_ATTRIBUTE_EVALUATION_EVENT_ID);
+    return anId;
+  }
+
+  /// Useful method that creates and sends the AttributeEvalMessage event
+  MODELAPI_EXPORT static void send(AttributePtr theAttribute, const void* theSender)
+  {
+    std::shared_ptr<ModelAPI_AttributeEvalMessage> aMessage =
+      std::shared_ptr<ModelAPI_AttributeEvalMessage>(
+      new ModelAPI_AttributeEvalMessage(eventId(), theSender));
+    aMessage->setAttribute(theAttribute);
+    Events_Loop::loop()->send(aMessage);
+  }
+
+  /// Creates an empty message
+  MODELAPI_EXPORT ModelAPI_AttributeEvalMessage(const Events_ID theID, const void* theSender = 0);
+  /// The virtual destructor
+  MODELAPI_EXPORT virtual ~ModelAPI_AttributeEvalMessage();
+
+  /// Returns a document stored in the message
+  MODELAPI_EXPORT AttributePtr attribute() const;
+  /// Sets an attribute to the message
+  MODELAPI_EXPORT void setAttribute(AttributePtr theAttribute);
+};
+
+/// Message that the object is renamed
+class ModelAPI_ObjectRenamedMessage : public Events_Message
+{
+  ObjectPtr myObject;
+  std::string myOldName;
+  std::string myNewName;
+
+ public:
+  /// Static. Returns EventID of the message.
+  MODELAPI_EXPORT static Events_ID& eventId()
+  {
+    static const char * MY_OBJECT_RENAMED_EVENT_ID("ObjectRenamed");
+    static Events_ID anId = Events_Loop::eventByName(MY_OBJECT_RENAMED_EVENT_ID);
+    return anId;
+  }
+
+  /// Useful method that creates and sends the AttributeEvalMessage event
+  MODELAPI_EXPORT static void send(ObjectPtr theObject,
+                                   const std::string& theOldName,
+                                   const std::string& theNewName,
+                                   const void* theSender);
+
+  /// Creates an empty message
+  MODELAPI_EXPORT ModelAPI_ObjectRenamedMessage(const Events_ID theID, const void* theSender = 0);
+  /// The virtual destructor
+  MODELAPI_EXPORT virtual ~ModelAPI_ObjectRenamedMessage();
+
+  /// Returns an object
+  MODELAPI_EXPORT ObjectPtr object() const;
+  /// Sets an object
+  MODELAPI_EXPORT void setObject(ObjectPtr theObject);
+  /// Returns an old name
+  MODELAPI_EXPORT std::string oldName() const;
+  /// Sets an old name
+  MODELAPI_EXPORT void setOldName(const std::string& theOldName);
+  /// Returns a new name
+  MODELAPI_EXPORT std::string newName() const;
+  /// Sets a new name
+  MODELAPI_EXPORT void setNewName(const std::string& theNewName);
+};
+
 #endif