Salome HOME
Issue #1834: Fix length of lines
[modules/shaper.git] / src / ModelAPI / ModelAPI_Events.h
index 6a5d674e60391c89fa2b7a9c47d7161a3fff3685..9c1718acb612b19b498409832171e734d27b2c76 100644 (file)
@@ -34,23 +34,34 @@ static const char * EVENT_OBJECT_RENAMED = "ObjectRenamed";
 static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
 /// Event ID that visualization must be redisplayed (comes with ModelAPI_ObjectUpdatedMessage)
 static const char * EVENT_OBJECT_TO_REDISPLAY = "ObjectsToRedisplay";
-/// Event ID that error state or error message was updated for the object
-static const char * EVENT_OBJECT_ERROR_CHANGED = "ObjectsErrorChanged";
-/// 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";
+/// The active document becomes another one
 static const char * EVENT_DOCUMENT_CHANGED = "CurrentDocumentChanged";
 
+/// 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 the sketch is prepared and all grouped messages for the solver may be flushed
+static const char * EVENT_UPDATE_SELECTION = "UpdateSelection";
+
+/// Request for the enabled/disabled actions behavior for some specific features
 static const char * EVENT_FEATURE_STATE_REQUEST = "FeatureStateRequest";
+/// Reply for the enabled/disabled actions behavior for some specific features
 static const char * EVENT_FEATURE_STATE_RESPONSE = "FeatureStateResponse";
 
-
+/// To block the viewer updates
 static const char * EVENT_UPDATE_VIEWER_BLOCKED = "UpdateViewerBlocked";
+/// To unblock the viewer updates
 static const char * EVENT_UPDATE_VIEWER_UNBLOCKED = "UpdateViewerUnblocked";
 
+/// To inform that there is an empty presentation in the viewer
+static const char * EVENT_EMPTY_AIS_PRESENTATION = "EmptyAISPresentation";
+/// To inform that there is an empty operation for presentation in the viewer
+static const char * EVENT_EMPTY_OPERATION_PRESENTATION = "EmptyOperationPresentation";
+/// To block preview
 static const char * EVENT_PREVIEW_BLOCKED = "PreviewBlocked";
+/// To preview the current feature in the viewer (to compute the result)
 static const char * EVENT_PREVIEW_REQUESTED = "PreviewRequested";
 
 /// Event ID that solver has conflicting constraints (comes with ModelAPI_SolverFailedMessage)
@@ -58,12 +69,12 @@ 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";
 
+/// Event ID that the sketch is prepared and all grouped messages for the solver may be flushed
+static const char * EVENT_SKETCH_PREPARED = "SketchPrepared";
+
 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
 class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
 {
@@ -114,17 +125,14 @@ public:
 class MODELAPI_EXPORT ModelAPI_OrderUpdatedMessage : public Events_Message
 {
 protected:
-  /// Creates an empty message
+  /// Creates a 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;
+  virtual std::shared_ptr<ModelAPI_Feature> reordered() = 0;
 
   /// Returns the identifier of the kind of a message
   virtual const Events_ID messageId() = 0;
@@ -141,8 +149,7 @@ public:
   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;
+  virtual void sendReordered(const std::shared_ptr<ModelAPI_Feature>& theReordered) const = 0;
 
   /// returns the creator instance
   static const ModelAPI_EventCreator* get();
@@ -300,7 +307,8 @@ class ModelAPI_ReplaceParameterMessage : public Events_Message
                                    const void* theSender);
 
   /// Creates an empty message
-  MODELAPI_EXPORT ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
+  MODELAPI_EXPORT
+    ModelAPI_ReplaceParameterMessage(const Events_ID theID, const void* theSender = 0);
   /// The virtual destructor
   MODELAPI_EXPORT virtual ~ModelAPI_ReplaceParameterMessage();
 
@@ -310,11 +318,13 @@ class ModelAPI_ReplaceParameterMessage : public Events_Message
   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
@@ -322,8 +332,14 @@ public:
   /// 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