]> SALOME platform Git repositories - modules/shaper.git/blob - src/Model/Model_BodyBuilder.h
Salome HOME
Improve code coverage for elliptic arcs.
[modules/shaper.git] / src / Model / Model_BodyBuilder.h
1 // Copyright (C) 2014-2019  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 email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef Model_BodyBuilder_H_
21 #define Model_BodyBuilder_H_
22
23 #include "Model.h"
24 #include <ModelAPI_BodyBuilder.h>
25
26 #include <GeomAlgoAPI_MakeShape.h>
27 #include <GeomAPI_DataMapOfShapeShape.h>
28 #include <vector>
29
30 class TNaming_Builder;
31
32 /**\class Model_BodyBuilder
33  * \ingroup DataModel
34  * \brief Extra API for the ResultBody that allows to work with naming.
35  */
36 class Model_BodyBuilder : public ModelAPI_BodyBuilder
37 {
38   /// builders that store the naming history: one per label to allow store several shapes to one
39   /// label; index in vector corresponds to the label tag
40   std::map<int, TNaming_Builder*> myBuilders;
41 public:
42   /// Stores the shape (called by the execution method).
43   MODEL_EXPORT virtual void store(const GeomShapePtr& theShape,
44                                   const bool theIsStoreSameShapes = true) override;
45
46   /// Stores the generated shape (called by the execution method).
47   MODEL_EXPORT virtual void storeGenerated(const GeomShapePtr& theFromShape,
48                                            const GeomShapePtr& theToShape,
49                                            const bool theIsCleanStored = true) override;
50
51   /// Stores the root generated shapes (called by the execution method).
52   MODEL_EXPORT virtual void storeGenerated(const std::list<GeomShapePtr>& theFromShapes,
53     const GeomShapePtr& theToShape,
54     const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape) override;
55
56   /// Stores the modified shape (called by the execution method).
57   /// \param theOldShape shape that produces result
58   /// \param theNewShape resulting shape
59   /// \param theIsCleanStored erases all previous data structure of this body if true
60   MODEL_EXPORT virtual void storeModified(const GeomShapePtr& theOldShape,
61                                           const GeomShapePtr& theNewShape,
62                                           const bool theIsCleanStored = true) override;
63
64   /// Stores the root modified shape (called by the execution method).
65   /// \param theOldShapes all shapes that produce result
66   /// \param theNewShape resulting shape
67   /// \param theIsCleanStored erases all previous data structure of this body if true
68   MODEL_EXPORT virtual void storeModified(const std::list<GeomShapePtr>& theOldShapes,
69     const GeomShapePtr& theNewShape,
70     const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape) override;
71
72   /// Returns the shape-result produced by this feature
73   MODEL_EXPORT virtual GeomShapePtr shape();
74
75   /// Records the subshape newShape which was generated during a topological construction.
76   /// As an example, consider the case of a face generated in construction of a box.
77   /// Returns true if it is stored correctly (the final shape contains this new sub-shape)
78   MODEL_EXPORT virtual bool generated(const GeomShapePtr& theNewShape,
79     const std::string& theName, const bool theCheckIsInResult = true) override;
80
81   /// Records the shape newShape which was generated from the shape oldShape during a topological
82   /// construction. As an example, consider the case of a face generated from an edge in
83   /// construction of a prism.
84   MODEL_EXPORT virtual void generated(const GeomShapePtr& theOldShape,
85                                       const GeomShapePtr& theNewShape,
86                                       const std::string& theName = "") override;
87
88
89   /// Records the shape newShape which is a modification of the shape oldShape.
90   /// As an example, consider the case of a face split or merged in a Boolean operation.
91   MODEL_EXPORT virtual void modified(const GeomShapePtr& theOldShape,
92                                      const GeomShapePtr& theNewShape,
93                                      const std::string& theName = "") override;
94
95   /// load deleted shapes
96   MODEL_EXPORT
97   virtual void loadDeletedShapes(const GeomMakeShapePtr& theAlgo,
98                                  const GeomShapePtr& theOldShape,
99                                  const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
100                                  const GeomShapePtr& theShapesToExclude = GeomShapePtr()) override;
101
102   /// load and orient modified shapes
103   MODEL_EXPORT
104   virtual void loadModifiedShapes(const GeomMakeShapePtr& theAlgo,
105                                   const GeomShapePtr& theOldShape,
106                                   const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
107                                   const std::string& theName = "") override;
108
109   /// load and orient generated shapes
110   MODEL_EXPORT
111   virtual void loadGeneratedShapes(const GeomMakeShapePtr& theAlgo,
112                                    const GeomShapePtr& theOldShape,
113                                    const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
114                                    const std::string& theName = "",
115                                    const bool theSaveOldIfNotInTree = false) override;
116
117   /// Loads shapes of the first level (to be used during shape import)
118   MODEL_EXPORT virtual void loadFirstLevel(GeomShapePtr theShape,
119                                            const std::string& theName) override;
120
121   /// Removes the stored builders
122   MODEL_EXPORT virtual ~Model_BodyBuilder();
123
124   /// Cleans cash related to the already stored elements
125   MODEL_EXPORT virtual void cleanCash() override;
126 protected:
127   /// Default constructor accessible only by Model_Objects
128   Model_BodyBuilder(ModelAPI_Object* theOwner);
129
130   /// Removes the stored builders
131   void clean();
132
133   /// Returns (creates if necessary) the builder created on the needed tag of sub-label
134   TNaming_Builder* builder(const int theTag);
135
136 private:
137   /// Loads shapes of the next level (to be used during shape import)
138   void loadNextLevels(GeomShapePtr theShape,
139                       const std::string& theName);
140
141   /// builds name for the shape kept at the specified tag
142   void buildName(const int theTag, const std::string& theName);
143
144 private:
145   struct IndexTags {
146     int index;
147     std::vector<int> tags;
148   };
149
150 private:
151   int myFreePrimitiveTag;
152   std::map<std::string, IndexTags> myPrimitivesNamesIndexMap;
153
154 private:
155   friend class Model_ResultBody;
156   friend class Model_ResultCompSolid;
157 };
158
159 #endif