Merge branch 'BR_internationalization'

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

diff --git a/src/ModelAPI/ModelAPI_Events.h b/src/ModelAPI/ModelAPI_Events.h
index eb64dc19efbf29a8d77c763c3f9021b12ee17209..93a8870b0b717b2c4eaa7bf5f66450d18a6796f0 100644 (file)
--- a/src/ModelAPI/ModelAPI_Events.h
+++ b/src/ModelAPI/ModelAPI_Events.h
@@ -37,7 +37,7 @@ static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
 static const char * EVENT_OPERATION_LAUNCHED = "OperationLaunched";
 /// Event ID that plugin is loaded (comes with ModelAPI_ObjectUpdatedMessage)
-static const char * EVENT_PLUGIN_LOADED = "PliginLoaded";
+static const char * EVENT_PLUGIN_LOADED = "PluginLoaded";
 //
 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
 
@@ -48,6 +48,23 @@ static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
 static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
 static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
 
+static const char * EVENT_EMPTY_AIS_PRESENTATION = "EmptyAISPresentation";
+static const char * EVENT_EMPTY_OPERATION_PRESENTATION = "EmptyOperationPresentation";
+
+static const char * EVENT_PREVIEW_BLOCKED = "PreviewBlocked";
+static const char * EVENT_PREVIEW_REQUESTED = "PreviewRequested";
+
+/// Event ID that solver has conflicting constraints (comes with ModelAPI_SolverFailedMessage)
+static const char * EVENT_SOLVER_FAILED = "SolverFailed";
+/// Event ID that the problem in solver disappeared
+static const char * EVENT_SOLVER_REPAIRED = "SolverRepaired";
+
+/// Event ID that order of objects in group is changed, so, tree must be fully rectreated (movement of feature)
+static const char * EVENT_ORDER_UPDATED = "OrderUpdated";
+
+/// Event ID that informs that some object has changed the stability
+static const char * EVENT_STABILITY_CHANGED = "StabilityChanged";
+
 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
 {
@@ -78,10 +95,10 @@ protected:
   virtual ~ModelAPI_ObjectDeletedMessage();
 
 public:
-  /// Returns the feature that has been updated
+  /// Returns the document that has been updated
   virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
 
-  /// Returns the group where the feature was deleted
+  /// Returns the groups where the objects were deleted
   virtual const std::set<std::string>& groups() const = 0;
 
   /// Creates the new empty message of this kind
@@ -94,6 +111,26 @@ public:
   virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
 };
 
+/// Message that order changed (used for Object Browser update)
+class MODELAPI_EXPORT ModelAPI_OrderUpdatedMessage : public Events_Message
+{
+protected:
+  /// Creates an empty message
+  ModelAPI_OrderUpdatedMessage(const Events_ID theID, const void* theSender = 0);
+  /// The virtual destructor
+  virtual ~ModelAPI_OrderUpdatedMessage();
+
+public:
+  /// Returns the document that has been updated
+  virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
+
+  /// Returns the groups where the objects were reordered
+  virtual const std::string& group() const = 0;
+
+  /// Returns the identifier of the kind of a message
+  virtual const Events_ID messageId() = 0;
+};
+
 /// Allows to create ModelAPI messages
 class MODELAPI_EXPORT ModelAPI_EventCreator
 {
@@ -104,6 +141,9 @@ public:
   /// creates deleted message and sends to the loop
   virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
                            const std::string& theGroup) const = 0;
+  /// creates reordered message and sends to the loop
+  virtual void sendReordered(const std::shared_ptr<ModelAPI_Document>& theDoc,
+                             const std::string& theGroup) const = 0;
 
   /// returns the creator instance
   static const ModelAPI_EventCreator* get();
@@ -242,4 +282,57 @@ class ModelAPI_ObjectRenamedMessage : public Events_Message
   MODELAPI_EXPORT void setNewName(const std::string& theNewName);
 };
 
+/// Message that the parameter should be replaced with its value
+class ModelAPI_ReplaceParameterMessage : public Events_Message
+{
+  ObjectPtr myObject;
+
+ public:
+  /// Static. Returns EventID of the message.
+  MODELAPI_EXPORT static Events_ID& eventId()
+  {
+    static const char * MY_EVENT_ID("ReplaceParameter");
+    static Events_ID anId = Events_Loop::eventByName(MY_EVENT_ID);
+    return anId;
+  }
+
+  /// Useful method that creates and sends the AttributeEvalMessage event
+  MODELAPI_EXPORT static void send(ObjectPtr theObject,
+                                   const void* theSender);
+
+  /// Creates an empty message
+  MODELAPI_EXPORT ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
+  /// The virtual destructor
+  MODELAPI_EXPORT virtual ~ModelAPI_ReplaceParameterMessage();
+
+  /// Returns an object
+  MODELAPI_EXPORT ObjectPtr object() const;
+  /// Sets an object
+  MODELAPI_EXPORT void setObject(ObjectPtr theObject);
+};
+
+/// Message that sends the sketch solver and sketcher GUI processes to show in the property panel
+class ModelAPI_SolverFailedMessage : public Events_Message
+{
+public:
+  /// Creates an message
+  MODELAPI_EXPORT ModelAPI_SolverFailedMessage(const Events_ID theID, const void* theSender = 0);
+  /// Default destructor
+  MODELAPI_EXPORT virtual ~ModelAPI_SolverFailedMessage();
+
+  /// Sets list of conflicting constraints
+  MODELAPI_EXPORT void setObjects(const std::set<ObjectPtr>& theObjects);
+  /// Returns list of conflicting constraints
+  MODELAPI_EXPORT const std::set<ObjectPtr>& objects() const;
+
+  /// Sets degrees of freedom
+  void dof(const int theDOF) { myDOF = theDOF; }
+  /// Returns degrees of freedom
+  const int& dof() const { return myDOF; }
+
+private:
+  std::set<ObjectPtr> myObjects;
+  int myDOF;
+};
+
 #endif