Merge branch 'Dev_0.7.1' of newgeom:newgeom into Dev_0.7.1

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

diff --git a/src/ModelAPI/ModelAPI_Events.h b/src/ModelAPI/ModelAPI_Events.h
index 89b1fd5b941773551d7a8e2782771770dc12cf27..9876e616a863ee3819af26cab49aa866bfc28e7b 100644 (file)
--- a/src/ModelAPI/ModelAPI_Events.h
+++ b/src/ModelAPI/ModelAPI_Events.h
@@ -1,17 +1,22 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_Events.h
 // Created:     10 Apr 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef ModelAPI_Events_H_
-#define ModelAPI_Events_H_
+#ifndef MODELAPI_EVENTS_H_
+#define MODELAPI_EVENTS_H_
 
 #include <ModelAPI.h>
+#include <ModelAPI_Object.h>
+#include <ModelAPI_Feature.h>
 #include <Events_MessageGroup.h>
-#include <boost/shared_ptr.hpp>
+
+#include <memory>
 #include <string>
 #include <set>
+#include <map>
 
-#include "ModelAPI_Object.h"
 
 class ModelAPI_Document;
 
@@ -27,48 +32,55 @@ static const char * EVENT_OBJECT_MOVED = "ObjectsMoved";
 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";
+/// 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";
 
 /// Message that feature was changed (used for Object Browser update): moved, updated and deleted
-class ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
+class MODELAPI_EXPORT ModelAPI_ObjectUpdatedMessage : public Events_MessageGroup
 {
  protected:
-  ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0)
-      : Events_MessageGroup(theID, theSender)
-  {
-  }
+  ModelAPI_ObjectUpdatedMessage(const Events_ID theID, const void* theSender = 0);
+  virtual ~ModelAPI_ObjectUpdatedMessage();
 
  public:
   /// Returns the feature that has been updated
-  virtual std::set<ObjectPtr> objects() const = 0;
+  virtual const std::set<ObjectPtr>& objects() const = 0;
 
   //! Creates a new empty group (to store it in the loop before flush)
-  virtual Events_MessageGroup* newEmpty() = 0;
+  virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
 
   //! Allows to join the given message with the current one
-  virtual void Join(Events_MessageGroup& theJoined) = 0;
+  virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
 };
 
 /// Message that feature was deleted (used for Object Browser update)
-class ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
+class MODELAPI_EXPORT ModelAPI_ObjectDeletedMessage : public Events_MessageGroup
 {
  protected:
-  ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0)
-      : Events_MessageGroup(theID, theSender)
-  {
-  }
+  ModelAPI_ObjectDeletedMessage(const Events_ID theID, const void* theSender = 0);
+  virtual ~ModelAPI_ObjectDeletedMessage();
 
  public:
   /// Returns the feature that has been updated
-  virtual boost::shared_ptr<ModelAPI_Document> document() const = 0;
+  virtual std::shared_ptr<ModelAPI_Document> document() const = 0;
 
   /// Returns the group where the feature was deleted
   virtual const std::set<std::string>& groups() const = 0;
 
-  virtual Events_MessageGroup* newEmpty() = 0;
+  virtual std::shared_ptr<Events_MessageGroup> newEmpty() = 0;
 
   virtual const Events_ID messageId() = 0;
 
-  virtual void Join(Events_MessageGroup& theJoined) = 0;
+  virtual void Join(const std::shared_ptr<Events_MessageGroup>& theJoined) = 0;
 };
 
 /// Allows to create ModelAPI messages
@@ -79,7 +91,7 @@ class MODELAPI_EXPORT ModelAPI_EventCreator
   virtual void sendUpdated(const ObjectPtr& theObject, const Events_ID& theEvent,
                            const bool isGroupped = true) const = 0;
   /// creates deleted message and sends to the loop
-  virtual void sendDeleted(const boost::shared_ptr<ModelAPI_Document>& theDoc,
+  virtual void sendDeleted(const std::shared_ptr<ModelAPI_Document>& theDoc,
                            const std::string& theGroup) const = 0;
 
   /// returns the creator instance
@@ -89,4 +101,27 @@ class MODELAPI_EXPORT ModelAPI_EventCreator
   static void set(const ModelAPI_EventCreator* theCreator);
 };
 
+// TODO(sbh): Move this message into a separate package, like "GuiAPI"
+class ModelAPI_FeatureStateMessage : public Events_Message
+{
+ public:
+  MODELAPI_EXPORT ModelAPI_FeatureStateMessage(const Events_ID theID, const void* theSender = 0);
+  MODELAPI_EXPORT virtual ~ModelAPI_FeatureStateMessage();
+
+  // For request
+  MODELAPI_EXPORT std::shared_ptr<ModelAPI_Feature> feature() const;
+  MODELAPI_EXPORT void setFeature(std::shared_ptr<ModelAPI_Feature>& theFeature);
+  // For response
+  MODELAPI_EXPORT bool hasState(const std::string& theFeatureId) const;
+  MODELAPI_EXPORT bool state(const  std::string& theFeatureId, bool theDefault = false) const;
+  MODELAPI_EXPORT void setState(const std::string& theFeatureId, bool theValue);
+  MODELAPI_EXPORT std::list<std::string> features() const;
+
+ private:
+  // For Request
+  std::shared_ptr<ModelAPI_Feature> myCurrentFeature;
+  // For response
+  std::map<std::string, bool> myFeatureState;
+};
+
 #endif