Salome HOME
Implementation of "isDisplayed" persistent flag
[modules/shaper.git] / src / ModelAPI / ModelAPI_Object.h
index 7c539d7d52e84608445a9033a9d5e8afaa4ca491..e755f532d23c28adfb9d7b6d168c669ead443b5f 100644 (file)
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_Object.hxx
 // Created:     19 May 2014
 // Author:      Mikhail PONIKAROV
@@ -8,7 +10,7 @@
 #include "ModelAPI.h"
 #include "ModelAPI_Data.h"
 
-#include <boost/shared_ptr.hpp>
+#include <memory>
 
 class ModelAPI_Data;
 class ModelAPI_Document;
@@ -24,61 +26,69 @@ class ModelAPI_Document;
  */
 class ModelAPI_Object
 {
-  boost::shared_ptr<ModelAPI_Data> myData;  ///< manager of the data model of a feature
-  boost::shared_ptr<ModelAPI_Document> myDoc;  ///< document this object belongs to
+  std::shared_ptr<ModelAPI_Data> myData;  ///< manager of the data model of a feature
+  std::shared_ptr<ModelAPI_Document> myDoc;  ///< document this object belongs to
  public:
   /// By default object is displayed in the object browser.
-  virtual bool isInHistory()
-  {
-    return true;
-  }
+  MODELAPI_EXPORT virtual bool isInHistory();
+
+  /// Makes object presented or not in the history of the created objects
+  /// \param theObject is shared pointer to "this"
+  /// \param theFlag is boolean value: to add or remove from the history
+  MODELAPI_EXPORT virtual void setInHistory(
+    const std::shared_ptr<ModelAPI_Object> theObject, const bool theFlag);
 
   /// Returns the data manager of this object: attributes
-  virtual boost::shared_ptr<ModelAPI_Data> data() const
-  {
-    return myData;
-  }
+  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
 
   /// Returns true if object refers to the same data model instance
-  virtual bool isSame(const boost::shared_ptr<ModelAPI_Object>& theObject)
-  {
-    return theObject.get() == this;
-  }
+  MODELAPI_EXPORT virtual bool isSame(const std::shared_ptr<ModelAPI_Object>& theObject);
 
   /// Returns document this feature belongs to
-  virtual boost::shared_ptr<ModelAPI_Document> document()
-  {
-    return myDoc;
-  }
+  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
 
   /// Returns the group identifier of this object
   virtual std::string groupName() = 0;
 
+  /// Request for initialization of data model of the object: adding all attributes
+  virtual void initAttributes() = 0;
+
+  /// Returns the feature is disabled or not.
+  virtual bool isDisabled() const = 0;
+
+  /// Called on change of any argument-attribute of this object
+  /// \param theID identifier of changed attribute
+  MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
+
+  /// Initializes the default states of the object
+  MODELAPI_EXPORT ModelAPI_Object();
+
   /// To use virtuality for destructors
-  virtual ~ModelAPI_Object() {}
+  MODELAPI_EXPORT virtual ~ModelAPI_Object();
+
  protected:
   /// Sets the data manager of an object (document does)
-  virtual void setData(boost::shared_ptr<ModelAPI_Data> theData)
-  {
-    myData = theData;
-  }
+  MODELAPI_EXPORT virtual void setData(std::shared_ptr<ModelAPI_Data> theData);
 
   /// Sets the data manager of an object (document does)
-  virtual void setDoc(boost::shared_ptr<ModelAPI_Document> theDoc)
-  {
-    myDoc = theDoc;
-  }
+  MODELAPI_EXPORT virtual void setDoc(std::shared_ptr<ModelAPI_Document> theDoc);
 
   /// removes all fields from this feature
-  MODELAPI_EXPORT virtual void erase() {
-    if (myData) myData->erase();
-    setData(DataPtr());
-  }
+  MODELAPI_EXPORT virtual void erase();
+
+  /// Returns true if object must be displayed in the viewer: flag is stored in the
+  /// data model, so on undo/redo, open/save or recreation of object by history-playing it keeps
+  /// the original state i nthe current transaction.
+  MODELAPI_EXPORT virtual bool isDisplayed();
+
+  /// Sets the displayed/hidden state of the object. If it is changed, sends the "redisplay"
+  /// signal.
+  MODELAPI_EXPORT virtual void setDisplayed(const bool theDisplay);
 
-  friend class Model_Document;
+  friend class Model_Objects;
 
 };
 
-typedef boost::shared_ptr<ModelAPI_Object> ObjectPtr;
+typedef std::shared_ptr<ModelAPI_Object> ObjectPtr;
 
 #endif