Salome HOME
Initial implementation of support of any level of hierarchy in Result Bodies.
[modules/shaper.git] / src / Model / Model_ResultBody.h
index f6174cdee1cb82798e836f80e67b954754e331e3..ad5f1c53136a25ca5a985f834ea5e400823a229f 100644 (file)
@@ -1,6 +1,22 @@
-// File:        Model_ResultBody.h
-// Created:     08 Jul 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef Model_ResultBody_H_
 #define Model_ResultBody_H_
 #include "Model.h"
 #include <ModelAPI_ResultBody.h>
 #include <vector>
-
-class TNaming_Builder;
-
-/**\class ModelAPI_ResultBody
- * \ingroup DataModel
- * \brief The body (shape) result of a feature.
- *
- * Provides a shape that may be displayed in the viewer.
- * May provide really huge results, so, working with this kind
- * of result must be optimized.
- */
+#include <map>
+
+/**\class Model_ResultBody
+* \ingroup DataModel
+* \brief The body (shape) result of a feature.
+*
+* Provides a shape that may be displayed in the viewer.
+* May provide really huge results, so, working with this kind
+* of result must be optimized.
+* Also provides a conainer of sub-body result in case it is compound or compsolid.
+*/
 class Model_ResultBody : public ModelAPI_ResultBody
 {
-  boost::shared_ptr<ModelAPI_Feature> myOwner;  ///< owner of this result
-  /// builders that tores the naming history: one per label to allow store several shapes to one 
-  /// label; index in vector corresponds to the label tag
-  std::vector<TNaming_Builder*> myBuilders;
+  /// Sub-bodies if this is compsolid or compound: zero-based index to subs
+  std::vector<ResultBodyPtr> mySubs;
+  /// Also keep map of result to index in mySubs to facilitate speed of access from OB
+  std::map<ObjectPtr, int> mySubsMap;
+  /// Keeps the last state of the concealment flag in order to update it when needed.
+  bool myLastConcealed;
+
 public:
-  /// Stores the shape (called by the execution method).
-  MODEL_EXPORT virtual void store(const boost::shared_ptr<GeomAPI_Shape>& theShape);
 
-  /// Stores the generated shape (called by the execution method).
-  MODEL_EXPORT virtual void storeGenerated(const boost::shared_ptr<GeomAPI_Shape>& theFromShape,
-                                              const boost::shared_ptr<GeomAPI_Shape>& theToShape);
+  /// Removes the stored builders
+  MODEL_EXPORT virtual ~Model_ResultBody();
+
+  /// load and orient modified shapes for sub-objects
+  MODEL_EXPORT virtual void loadAndOrientModifiedShapes (GeomAlgoAPI_MakeShape* theMS,
+    std::shared_ptr<GeomAPI_Shape>  theShapeIn, const int  theKindOfShape, const int  theTag,
+    const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes,
+    const bool theIsStoreSeparate = false, const bool theIsStoreAsGenerated = false,
+    const bool theSplitInSubs = false);
 
-  /// Stores the modified shape (called by the execution method).
-  MODEL_EXPORT virtual void storeModified(const boost::shared_ptr<GeomAPI_Shape>& theOldShape,
-                                              const boost::shared_ptr<GeomAPI_Shape>& theNewShape);
 
-  /// Returns the shape-result produced by this feature
-  MODEL_EXPORT virtual boost::shared_ptr<GeomAPI_Shape> shape();
-  /// Returns the source feature of this result
-  MODEL_EXPORT virtual boost::shared_ptr<ModelAPI_Feature> owner();
+  /// Returns the number of sub-elements
+  MODEL_EXPORT virtual int numberOfSubs(bool forTree = false) const;
 
-  /// Records the subshape newShape which was generated during a topological construction.
-  /// As an example, consider the case of a face generated in construction of a box.
-  MODEL_EXPORT virtual void generated(const boost::shared_ptr<GeomAPI_Shape>& theNewShape, 
-    const int theTag = 1);
+  /// Returns the sub-result by zero-base index
+  MODEL_EXPORT virtual ResultBodyPtr subResult(const int theIndex,
+    bool forTree = false) const;
 
-  /// Records the shape newShape which was generated from the shape oldShape during a topological 
-  /// construction. As an example, consider the case of a face generated from an edge in 
-  /// construction of a prism.
-  MODEL_EXPORT virtual void generated(const boost::shared_ptr<GeomAPI_Shape>& theOldShape,
-    const boost::shared_ptr<GeomAPI_Shape>& theNewShape, const int theTag = 1);
+  /// Returns true if feature or reuslt belong to this composite feature as subs
+  /// Returns theIndex - zero based index of sub if found
+  MODEL_EXPORT virtual bool isSub(ObjectPtr theObject, int& theIndex) const;
 
+  /// Returns the parameters of color definition in the resources config manager
+  MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
+                                            std::string& theDefault);
 
-  /// Records the shape newShape which is a modification of the shape oldShape.
-  /// As an example, consider the case of a face split or merged in a Boolean operation.
-  MODEL_EXPORT virtual void modified(const boost::shared_ptr<GeomAPI_Shape>& theOldShape,
-    const boost::shared_ptr<GeomAPI_Shape>& theNewShape, const int theTag = 1);
+  /// Disables the result body: keeps the resulting shape as selection, but erases the underlaying
+  /// naming data structure if theFlag if false. Or restores every  thing on theFlag is true.
+  MODEL_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
+    const bool theFlag);
 
-  /// Records the shape oldShape which was deleted from the current label.
-  /// As an example, consider the case of a face removed by a Boolean operation.
-  MODEL_EXPORT virtual void deleted(const boost::shared_ptr<GeomAPI_Shape>& theOldShape,
-    const int theTag = 1);
+  /// The compsolid is concealed if at least one of the sub is concealed
+  MODEL_EXPORT virtual bool isConcealed();
 
-  /// Removes the stored builders
-  MODEL_EXPORT virtual ~Model_ResultBody();
+  /// Sets all subs as concealed in the data tree (referenced by other objects)
+  MODEL_EXPORT virtual void setIsConcealed(const bool theValue);
+
+  /// Returns true if the latest modification of this body in the naming history
+  // is equal to the given shape
+  MODEL_EXPORT virtual bool isLatestEqual(const std::shared_ptr<GeomAPI_Shape>& theShape);
 
 protected:
   /// Makes a body on the given feature
   Model_ResultBody();
 
-  /// Removes the stored builders
-  void clean();
+  /// Updates the sub-bodies if shape of this object is composite-solid
+  void updateSubs(const std::shared_ptr<GeomAPI_Shape>& theThisShape);
 
-  /// Returns (creates if necessary) the builder created on the needed tag of sub-label
-  TNaming_Builder* builder(const int theTag);
+  // Checks the state of children and partents to send events of creation/erase when needed
+  void updateConcealment();
 
-  friend class Model_Document;
+  friend class Model_Objects;
 };
 
 #endif