Salome HOME
addUniqueNamedCopiedFeature to use unique names for copies features.
[modules/shaper.git] / src / ModelAPI / ModelAPI_Document.h
index dc43fac414cfa9ec0bfedbaee65c5f225c317394..5f344ea085160b4f18000328183db249ea526a73 100644 (file)
@@ -44,7 +44,9 @@ public:
 
   //! Adds to the document the new feature of the given feature id
   //! \param theID creates feature and puts it in the document (if it is not action)
-  virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 0;
+  //! \param theMakeCurrent to make current this new feature in this document
+  virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID, 
+    const bool theMakeCurrent = true) = 0;
 
   //! Return a list of features, which refers to the feature
   //! \param theFeature a feature
@@ -67,10 +69,8 @@ public:
   //! Returns the object in the group by the index (started from zero)
   //! \param theGroupID group that contains an object
   //! \param theIndex zero-based index of feature in the group
-  //! \param theHidden if it is true, it counts also the features that are not in tree
   virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
-                                                    const int theIndex,
-                                                    const bool theHidden = false) = 0;
+                                                    const int theIndex) = 0;
 
   //! Returns the first found object in the group by the object name
   //! \param theGroupID group that contains an object
@@ -85,17 +85,22 @@ public:
   virtual const int index(std::shared_ptr<ModelAPI_Object> theObject) = 0;
 
   //! Returns the number of objects in the group of objects
-  //! If theHidden is true, it counts also the features that are not in tree
-  virtual int size(const std::string& theGroupID, const bool theHidden = false) = 0;
+  virtual int size(const std::string& theGroupID) = 0;
 
   //! Returns the feature that is currently edited in this document, normally
   //! this is the latest created feature
+  //! \param theVisible use visible features only: flag is true for Object Browser functionality
   //! \returns null if next created feature must be the first
-  virtual std::shared_ptr<ModelAPI_Feature> currentFeature() = 0;
+  virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
 
   //! Sets the current feature: all features below will be disabled, new features
   //! will be appended after this one.
-  virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent) = 0;
+  //! \param theCurrent the selected feature as current: blow it everythin become disabled
+  //! \param theVisible use visible features only: flag is true for Object Browser functionality
+  virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
+    const bool theVisible) = 0;
+  //! Makes the current feature one feature upper
+  virtual void setCurrentFeatureUp() = 0;
 
   /// To virtually destroy the fields of successors
   MODELAPI_EXPORT virtual ~ModelAPI_Document();
@@ -125,9 +130,12 @@ protected:
   MODELAPI_EXPORT ModelAPI_Document();
 
   /// Internally makes document know that feature was removed or added in history after creation
-  MODELAPI_EXPORT virtual void addToHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
+  MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
+  /// Internally makes document know that feature was removed or added in history after creation
+  MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
 
   friend class ModelAPI_Object; // to add or remove from the history
+  friend class ModelAPI_Result; // to add or remove from the history
 };
 
 //! Pointer on document object