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
24 class ModelAPI_BodyBuilder
27 MODELAPI_EXPORT virtual ~ModelAPI_BodyBuilder() {};
29 /// Stores the shape (called by the execution method).
30 virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
32 /// Stores the generated shape (called by the execution method).
33 virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
34 const std::shared_ptr<GeomAPI_Shape>& theToShape) = 0;
36 /// Stores the modified shape (called by the execution method).
37 virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
38 const std::shared_ptr<GeomAPI_Shape>& theNewShape,
39 const int theDecomposeSolidsTag = 0) = 0;
41 /// Returns the shape-result produced by this feature
42 virtual std::shared_ptr<GeomAPI_Shape> shape() = 0;
44 /// Records the subshape newShape which was generated during a topological construction.
45 /// As an example, consider the case of a face generated in construction of a box.
46 virtual void generated(
47 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1) = 0;
49 /// Records the shape newShape which was generated from the shape oldShape during a topological
50 /// construction. As an example, consider the case of a face generated from an edge in
51 /// construction of a prism.
52 virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
53 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1) = 0;
55 /// Records the shape newShape which is a modification of the shape oldShape.
56 /// As an example, consider the case of a face split or merged in a Boolean operation.
57 virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
58 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1) = 0;
60 /// Records the shape oldShape which was deleted from the current label.
61 /// As an example, consider the case of a face removed by a Boolean operation.
63 const std::shared_ptr<GeomAPI_Shape>& theOldShape, const int theTag = 1) = 0;
65 /// load deleted shapes
66 virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
67 std::shared_ptr<GeomAPI_Shape> theShapeIn,
68 const int theKindOfShape,
69 const int theTag) = 0;
70 /// load and orient modified shapes
71 virtual void loadAndOrientModifiedShapes (
72 GeomAlgoAPI_MakeShape* theMS,
73 std::shared_ptr<GeomAPI_Shape> theShapeIn,
74 const int theKindOfShape,
76 const std::string& theName,
77 GeomAPI_DataMapOfShapeShape& theSubShapes) = 0;
78 /// load and orient generated shapes
79 virtual void loadAndOrientGeneratedShapes (
80 GeomAlgoAPI_MakeShape* theMS,
81 std::shared_ptr<GeomAPI_Shape> theShapeIn,
82 const int theKindOfShape,
84 const std::string& theName,
85 GeomAPI_DataMapOfShapeShape& theSubShapes) = 0;
87 /// load shapes of the first level (to be used during shape import)
88 virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag) = 0;
90 /// load disconnected edges
91 virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag) = 0;
93 /// load disconnected vetexes
94 virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName,int& theTag) = 0;
96 /// Converts evolution of sub-shapes stored in naming structure to selection
97 /// (theFlag = true) and back (theFlag = false)
98 virtual void evolutionToSelection(const bool theFlag) = 0;
101 /// Returns the data manager of this object: attributes
102 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
104 /// Returns document this feature belongs to
105 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
108 MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object* theOwner);
110 ModelAPI_Object* myOwner;
113 //! Pointer on feature object
114 typedef std::shared_ptr<ModelAPI_BodyBuilder> BodyBuilderPtr;