1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: Model_ResultBody.h
4 // Created: 08 Jul 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef Model_ResultBody_H_
8 #define Model_ResultBody_H_
11 #include <ModelAPI_ResultBody.h>
12 #include <GeomAlgoAPI_MakeShape.h>
13 #include <GeomAPI_DataMapOfShapeShape.h>
16 class TNaming_Builder;
18 /**\class Model_ResultBody
20 * \brief The body (shape) result of a feature.
22 * Provides a shape that may be displayed in the viewer.
23 * May provide really huge results, so, working with this kind
24 * of result must be optimized.
26 class Model_ResultBody : public ModelAPI_ResultBody
28 /// builders that tores the naming history: one per label to allow store several shapes to one
29 /// label; index in vector corresponds to the label tag
30 std::vector<TNaming_Builder*> myBuilders;
32 /// Request for initialization of data model of the result: adding all attributes
33 virtual void initAttributes();
35 /// Returns the parameters of color definition in the resources config manager
36 MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
37 std::string& theDefault);
39 /// Disables the result body: keeps the resulting shape as selection, but erases the underlaying
40 /// naming data structure if theFlag if false. Or restores everything on theFlag is true.
41 MODEL_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
44 /// Stores the shape (called by the execution method).
45 MODEL_EXPORT virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape);
47 /// Stores the generated shape (called by the execution method).
48 MODEL_EXPORT virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
49 const std::shared_ptr<GeomAPI_Shape>& theToShape);
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 std::shared_ptr<GeomAPI_Shape>& theOldShape,
57 const std::shared_ptr<GeomAPI_Shape>& theNewShape,
58 const int theDecomposeSolidsTag = 0);
60 /// Returns the shape-result produced by this feature
61 MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
63 /// Records the subshape newShape which was generated during a topological construction.
64 /// As an example, consider the case of a face generated in construction of a box.
65 MODEL_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theNewShape,
66 const std::string& theName, const int theTag = 1);
68 /// Records the shape newShape which was generated from the shape oldShape during a topological
69 /// construction. As an example, consider the case of a face generated from an edge in
70 /// construction of a prism.
71 MODEL_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
72 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1);
75 /// Records the shape newShape which is a modification of the shape oldShape.
76 /// As an example, consider the case of a face split or merged in a Boolean operation.
77 MODEL_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
78 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName, const int theTag = 1);
80 /// Records the shape oldShape which was deleted from the current label.
81 /// As an example, consider the case of a face removed by a Boolean operation.
82 MODEL_EXPORT virtual void deleted(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
83 const int theTag = 1);
85 /// load deleted shapes
86 MODEL_EXPORT virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
87 std::shared_ptr<GeomAPI_Shape> theShapeIn,
88 const int theKindOfShape,
90 /// load and orient modified shapes
91 MODEL_EXPORT virtual void loadAndOrientModifiedShapes (
92 GeomAlgoAPI_MakeShape* theMS,
93 std::shared_ptr<GeomAPI_Shape> theShapeIn,
94 const int theKindOfShape,
96 const std::string& theName,
97 GeomAPI_DataMapOfShapeShape& theSubShapes);
98 /// load and orient generated shapes
99 MODEL_EXPORT virtual void loadAndOrientGeneratedShapes (
100 GeomAlgoAPI_MakeShape* theMS,
101 std::shared_ptr<GeomAPI_Shape> theShapeIn,
102 const int theKindOfShape,
104 const std::string& theName,
105 GeomAPI_DataMapOfShapeShape& theSubShapes);
107 /// Loads shapes of the first level (to be used during shape import)
108 MODEL_EXPORT virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag);
110 /// Loads disconnected edges
111 MODEL_EXPORT virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag);
113 /// Loads disconnected vetexes
114 MODEL_EXPORT virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag);
116 /// Removes the stored builders
117 MODEL_EXPORT virtual ~Model_ResultBody();
120 /// Makes a body on the given feature
123 /// Removes the stored builders
126 /// Returns (creates if necessary) the builder created on the needed tag of sub-label
127 TNaming_Builder* builder(const int theTag);
130 /// Loads shapes of the next level (to be used during shape import)
131 void loadNextLevels(std::shared_ptr<GeomAPI_Shape> theShape, const std::string& theName, int& theTag);
133 /// builds name for the shape kept at the specified tag
134 void buildName(const int theTag, const std::string& theName);
136 friend class Model_Objects;