src/Model/Model_BodyBuilder.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef Model_BodyBuilder_H_
  22 #define Model_BodyBuilder_H_
  23
  24 #include "Model.h"
  25 #include <ModelAPI_BodyBuilder.h>
  26
  27 #include <GeomAlgoAPI_MakeShape.h>
  28 #include <GeomAPI_DataMapOfShapeShape.h>
  29 #include <vector>
  30
  31 class TNaming_Builder;
  32
  33 /**\class Model_BodyBuilder
  34  * \ingroup DataModel
  35  * \brief Extra API for the ResultBody that allows to work with naming.
  36  */
  37 class Model_BodyBuilder : public ModelAPI_BodyBuilder
  38 {
  39   /// builders that store the naming history: one per label to allow store several shapes to one
  40   /// label; index in vector corresponds to the label tag
  41   std::map<int, TNaming_Builder*> myBuilders;
  42 public:
  43   /// Stores the shape (called by the execution method).
  44   MODEL_EXPORT virtual void store(const GeomShapePtr& theShape,
  45                                   const bool theIsStoreSameShapes = true);
  46
  47   /// Stores the generated shape (called by the execution method).
  48   MODEL_EXPORT virtual void storeGenerated(const GeomShapePtr& theFromShape,
  49                                            const GeomShapePtr& theToShape);
  50
  51   /// Stores the modified shape (called by the execution method).
  52   /// \param theOldShape shape that produces result
  53   /// \param theNewShape resulting shape
  54   /// \param theDecomposeSolidsTag tag for starting of solids sub-elements placement in case
  55   ///          theNewShape is compound of solids, if zero it is not used
  56   MODEL_EXPORT virtual void storeModified(const GeomShapePtr& theOldShape,
  57                                           const GeomShapePtr& theNewShape,
  58                                           const bool theIsCleanStored = true) override;
  59
  60   /// Stores the shape without naming support
  61   /// \param theShape shape to store
  62   MODEL_EXPORT virtual void storeWithoutNaming(const GeomShapePtr& theShape);
  63
  64   /// Returns the shape-result produced by this feature
  65   MODEL_EXPORT virtual GeomShapePtr shape();
  66
  67   /// Records the subshape newShape which was generated during a topological construction.
  68   /// As an example, consider the case of a face generated in construction of a box.
  69   MODEL_EXPORT virtual void generated(const GeomShapePtr& theNewShape,
  70                                       const std::string& theName) override;
  71
  72   /// Records the shape newShape which was generated from the shape oldShape during a topological
  73   /// construction. As an example, consider the case of a face generated from an edge in
  74   /// construction of a prism.
  75   MODEL_EXPORT virtual void generated(const GeomShapePtr& theOldShape,
  76                                       const GeomShapePtr& theNewShape,
  77                                       const std::string& theName = "") override;
  78
  79
  80   /// Records the shape newShape which is a modification of the shape oldShape.
  81   /// As an example, consider the case of a face split or merged in a Boolean operation.
  82   MODEL_EXPORT virtual void modified(const GeomShapePtr& theOldShape,
  83                                      const GeomShapePtr& theNewShape,
  84                                      const std::string& theName = "") override;
  85
  86   /// Records the shape oldShape which was deleted from the current label.
  87   /// As an example, consider the case of a face removed by a Boolean operation.
  88   MODEL_EXPORT virtual void deleted(const GeomShapePtr& theOldShape) override;
  89
  90   /// load deleted shapes
  91   MODEL_EXPORT
  92   virtual void loadDeletedShapes(const GeomMakeShapePtr& theAlgo,
  93                                  const GeomShapePtr& theOldShape,
  94                                  const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
  95                                  const GeomShapePtr& theShapesToExclude = GeomShapePtr()) override;
  96
  97   /// load and orient modified shapes
  98   MODEL_EXPORT
  99   virtual void loadModifiedShapes(const GeomMakeShapePtr& theAlgo,
 100                                   const GeomShapePtr& theOldShape,
 101                                   const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
 102                                   const std::string& theName = "") override;
 103
 104   /// load and orient generated shapes
 105   MODEL_EXPORT
 106   virtual void loadAndOrientGeneratedShapes(GeomAlgoAPI_MakeShape* theMS,
 107                                             GeomShapePtr  theShapeIn,
 108                                             const int theKindOfShape,
 109                                             const int theTag,
 110                                             const std::string& theName,
 111                                             GeomAPI_DataMapOfShapeShape& theSubShapes);
 112
 113   /// Loads shapes of the first level (to be used during shape import)
 114   MODEL_EXPORT virtual void loadFirstLevel(GeomShapePtr theShape,
 115                                            const std::string& theName,
 116                                            int& theTag);
 117
 118   /// Loads disconnected edges
 119   MODEL_EXPORT virtual void loadDisconnectedEdges(GeomShapePtr theShape,
 120                                                   const std::string& theName,
 121                                                   int& theTag);
 122
 123   /// Loads disconnected vetexes
 124   MODEL_EXPORT virtual void loadDisconnectedVertexes(GeomShapePtr theShape,
 125                                                      const std::string& theName,
 126                                                      int& theTag);
 127
 128   /// Removes the stored builders
 129   MODEL_EXPORT virtual ~Model_BodyBuilder();
 130
 131   /// Returns true if the latest modification of this body in the naming history
 132   // is equal to the given shape
 133   MODEL_EXPORT virtual bool isLatestEqual(const GeomShapePtr& theShape);
 134
 135 protected:
 136   /// Default constructor accessible only by Model_Objects
 137   Model_BodyBuilder(ModelAPI_Object* theOwner);
 138
 139   /// Removes the stored builders
 140   void clean();
 141
 142   /// Returns (creates if necessary) the builder created on the needed tag of sub-label
 143   TNaming_Builder* builder(const int theTag);
 144
 145 private:
 146   /// Loads shapes of the next level (to be used during shape import)
 147   void loadNextLevels(GeomShapePtr theShape,
 148                       const std::string& theName, int&  theTag);
 149
 150   /// builds name for the shape kept at the specified tag
 151   void buildName(const int theTag, const std::string& theName);
 152
 153 private:
 154   int myPrimitiveTag;
 155   int myDividedIndex;
 156   int myVIndex;
 157   int myEIndex;
 158   int myFIndex;
 159
 160 private:
 161   friend class Model_ResultBody;
 162   friend class Model_ResultCompSolid;
 163 };
 164
 165 #endif