1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_BodyBuilder.hxx
4 // Created: 07 Jul 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_BodyBuilder_H_
8 #define ModelAPI_BodyBuilder_H_
11 #include <GeomAPI_Shape.h>
12 #include <GeomAlgoAPI_MakeShape.h>
13 #include <GeomAPI_DataMapOfShapeShape.h>
18 class ModelAPI_Document;
19 class ModelAPI_Object;
21 /**\class ModelAPI_BodyBuilder
23 * \brief Extra API for the ResultBody that allows to work with naming.
25 class ModelAPI_BodyBuilder
28 MODELAPI_EXPORT virtual ~ModelAPI_BodyBuilder() {};
30 /// Stores the shape (called by the execution method).
31 virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
33 /// Stores the generated shape (called by the execution method).
34 virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
35 const std::shared_ptr<GeomAPI_Shape>& theToShape) = 0;
37 /// Stores the modified shape (called by the execution method).
38 virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
39 const std::shared_ptr<GeomAPI_Shape>& theNewShape,
40 const int theDecomposeSolidsTag = 0) = 0;
42 /// Stores the shape without naming support
43 virtual void storeWithoutNaming(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
45 /// Returns the shape-result produced by this feature
46 virtual std::shared_ptr<GeomAPI_Shape> shape() = 0;
48 /// Records the subshape newShape which was generated during a topological construction.
49 /// As an example, consider the case of a face generated in construction of a box.
50 virtual void generated(
51 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1) = 0;
53 /// Records the shape newShape which was generated from the shape oldShape during a topological
54 /// construction. As an example, consider the case of a face generated from an edge in
55 /// construction of a prism.
56 virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
57 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1) = 0;
59 /// Records the shape newShape which is a modification of the shape oldShape.
60 /// As an example, consider the case of a face split or merged in a Boolean operation.
61 virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
62 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1) = 0;
64 /// Records the shape oldShape which was deleted from the current label.
65 /// As an example, consider the case of a face removed by a Boolean operation.
67 const std::shared_ptr<GeomAPI_Shape>& theOldShape, const int theTag = 1) = 0;
69 /// load deleted shapes
70 virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
71 std::shared_ptr<GeomAPI_Shape> theShapeIn,
72 const int theKindOfShape,
73 const int theTag) = 0;
74 /// load and orient modified shapes
75 virtual void loadAndOrientModifiedShapes (
76 GeomAlgoAPI_MakeShape* theMS,
77 std::shared_ptr<GeomAPI_Shape> theShapeIn,
78 const int theKindOfShape,
80 const std::string& theName,
81 GeomAPI_DataMapOfShapeShape& theSubShapes) = 0;
82 /// load and orient generated shapes
83 virtual void loadAndOrientGeneratedShapes (
84 GeomAlgoAPI_MakeShape* theMS,
85 std::shared_ptr<GeomAPI_Shape> theShapeIn,
86 const int theKindOfShape,
88 const std::string& theName,
89 GeomAPI_DataMapOfShapeShape& theSubShapes) = 0;
91 /// load shapes of the first level (to be used during shape import)
92 virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag) = 0;
94 /// load disconnected edges
95 virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag) = 0;
97 /// load disconnected vetexes
98 virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName,int& theTag) = 0;
100 /// Converts evolution of sub-shapes stored in naming structure to selection
101 /// (theFlag = true) and back (theFlag = false)
102 virtual void evolutionToSelection(const bool theFlag) = 0;
104 /// Returns true if the latest modification of this body in the naming history
105 // is equal to the given shape
106 virtual bool isLatestEqual(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
109 /// Returns the data manager of this object: attributes
110 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
112 /// Returns document this feature belongs to
113 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
116 /// Deafult constructor accessible only from Model_Object
117 MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object* theOwner);
119 ModelAPI_Object* myOwner; ///< the owner object this builder belongs to
122 //! Pointer on feature object
123 typedef std::shared_ptr<ModelAPI_BodyBuilder> BodyBuilderPtr;