1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef ModelAPI_BodyBuilder_H_
21 #define ModelAPI_BodyBuilder_H_
24 #include <GeomAPI_Shape.h>
25 #include <GeomAlgoAPI_MakeShape.h>
26 #include <GeomAPI_DataMapOfShapeShape.h>
31 class ModelAPI_Document;
32 class ModelAPI_Object;
34 /**\class ModelAPI_BodyBuilder
36 * \brief Extra API for the ResultBody that allows to work with naming.
38 class ModelAPI_BodyBuilder
41 MODELAPI_EXPORT virtual ~ModelAPI_BodyBuilder() {};
43 /// Stores the shape (called by the execution method).
44 virtual void store(const GeomShapePtr& theShape,
45 const bool theIsStoreSameShapes = true) = 0;
47 /// Stores the generated shape (called by the execution method).
48 virtual void storeGenerated(const GeomShapePtr& theFromShape,
49 const GeomShapePtr& theToShape,
50 const bool theIsCleanStored = true) = 0;
52 /// Stores the root generated shapes (called by the execution method).
53 virtual void storeGenerated(const std::list<GeomShapePtr>& theFromShapes,
54 const GeomShapePtr& theToShape, const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape) = 0;
56 /// Stores the modified shape (called by the execution method).
57 virtual void storeModified(const GeomShapePtr& theOldShape,
58 const GeomShapePtr& theNewShape,
59 const bool theIsCleanStored = true) = 0;
61 /// Stores the root modified shapes (called by the execution method).
62 virtual void storeModified(const std::list<GeomShapePtr>& theOldShapes,
63 const GeomShapePtr& theNewShape, const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape)=0;
65 /// Returns the shape-result produced by this feature
66 virtual GeomShapePtr shape() = 0;
68 /// Records the subshape newShape which was generated during a topological construction.
69 /// As an example, consider the case of a face generated in construction of a box.
70 /// Returns true if it is stored correctly (the final shape contains this new sub-shape)
71 virtual bool generated(const GeomShapePtr& theNewShape,
72 const std::string& theName, const bool theCheckIsInResult = true) = 0;
74 /// Records the shape newShape which was generated from the shape oldShape during a topological
75 /// construction. As an example, consider the case of a face generated from an edge in
76 /// construction of a prism.
77 virtual void generated(const GeomShapePtr& theOldShape,
78 const GeomShapePtr& theNewShape,
79 const std::string& theName = "") = 0;
81 /// Records the shape newShape which is a modification of the shape oldShape.
82 /// As an example, consider the case of a face split or merged in a Boolean operation.
83 virtual void modified(const GeomShapePtr& theOldShape,
84 const GeomShapePtr& theNewShape,
85 const std::string& theName = "") = 0;
87 /// load deleted shapes
88 virtual void loadDeletedShapes(const GeomMakeShapePtr& theAlgo,
89 const GeomShapePtr& theOldShape,
90 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
91 const GeomShapePtr& theShapesToAvoid = GeomShapePtr()) = 0;
93 /// load and orient modified shapes
94 virtual void loadModifiedShapes(const GeomMakeShapePtr& theAlgo,
95 const GeomShapePtr& theOldShape,
96 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
97 const std::string& theName = "") = 0;
99 /// load and orient generated shapes
100 virtual void loadGeneratedShapes(const GeomMakeShapePtr& theAlgo,
101 const GeomShapePtr& theOldShape,
102 const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
103 const std::string& theName = "",
104 const bool theSaveOldIfNotInTree = false) = 0;
106 /// load shapes of the first level (to be used during shape import)
107 virtual void loadFirstLevel(GeomShapePtr theShape,
108 const std::string& theName) = 0;
110 /// Cleans cash related to the already stored elements
111 MODELAPI_EXPORT virtual void cleanCash() = 0;
114 /// Returns the data manager of this object: attributes
115 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
117 /// Returns document this feature belongs to
118 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
121 /// Default constructor accessible only from Model_Object
122 MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object* theOwner);
124 ModelAPI_Object* myOwner; ///< the owner object this builder belongs to
127 //! Pointer on feature object
128 typedef std::shared_ptr<ModelAPI_BodyBuilder> BodyBuilderPtr;