1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_ResultBody.hxx
4 // Created: 07 Jul 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_ResultBody_H_
8 #define ModelAPI_ResultBody_H_
10 #include "ModelAPI_Result.h"
11 #include <GeomAPI_Shape.h>
12 #include <GeomAPI_DataMapOfShapeShape.h>
15 class ModelAPI_BodyBuilder;
16 class GeomAlgoAPI_MakeShape;
18 /**\class ModelAPI_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 ModelAPI_ResultBody : public ModelAPI_Result
29 MODELAPI_EXPORT virtual ~ModelAPI_ResultBody();
30 /// Returns the group identifier of this result
31 MODELAPI_EXPORT virtual std::string groupName();
33 /// Returns the group identifier of this result
34 inline static std::string group()
36 static std::string MY_GROUP = "Bodies";
40 /// default color for a result body
41 inline static const std::string& DEFAULT_COLOR()
43 static const std::string RESULT_BODY_COLOR("200,200,230");
44 return RESULT_BODY_COLOR;
47 /// default deflection for a result body
48 inline static const std::string DEFAULT_DEFLECTION()
53 /// Iternal enumeration for storage the information of connected topology flag
54 enum ConnectedTopologyFlag {
55 ConnectionNotComputed, ///< not yet computed
56 IsConnected, ///< the topology is connected
57 IsNotConnected ///< the topology is connected
59 /// Keeps (not persistently) the connected topology flag
60 ConnectedTopologyFlag myConnect;
62 /// \brief Stores the shape (called by the execution method).
63 /// param[in] theShape shape to store.
64 /// param[in] theIsStoreSameShapes if false stores reference to the same shape if it is already in document.
65 MODELAPI_EXPORT virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape,
66 const bool theIsStoreSameShapes = true);
68 /// Stores the generated shape (called by the execution method).
69 MODELAPI_EXPORT virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
70 const std::shared_ptr<GeomAPI_Shape>& theToShape);
72 /// Stores the modified shape (called by the execution method).
73 MODELAPI_EXPORT virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
74 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const int theDecomposeSolidsTag = 0);
76 /// Stores the shape without naming support
77 MODELAPI_EXPORT virtual void storeWithoutNaming(
78 const std::shared_ptr<GeomAPI_Shape>& theShape);
80 /// Returns the shape-result produced by this feature
81 MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
83 /// Records the subshape newShape which was generated during a topological construction.
84 /// As an example, consider the case of a face generated in construction of a box.
85 MODELAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theNewShape,
86 const std::string& theName, const int theTag = 1);
88 /// Records the shape newShape which was generated from the shape oldShape during a topological
89 /// construction. As an example, consider the case of a face generated from an edge in
90 /// construction of a prism.
91 MODELAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
92 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
93 const int theTag = 1);
95 /// Records the shape newShape which is a modification of the shape oldShape.
96 /// As an example, consider the case of a face split or merged in a Boolean operation.
97 MODELAPI_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
98 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
99 const int theTag = 1);
101 /// Records the shape oldShape which was deleted from the current label.
102 /// As an example, consider the case of a face removed by a Boolean operation.
103 MODELAPI_EXPORT virtual void deleted(
104 const std::shared_ptr<GeomAPI_Shape>& theOldShape, const int theTag = 1);
106 /// load deleted shapes
107 MODELAPI_EXPORT virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
108 std::shared_ptr<GeomAPI_Shape> theShapeIn,
109 const int theKindOfShape,
111 /// load and orient modified shapes
112 MODELAPI_EXPORT virtual void loadAndOrientModifiedShapes (GeomAlgoAPI_MakeShape* theMS,
113 std::shared_ptr<GeomAPI_Shape> theShapeIn, const int theKindOfShape, const int theTag,
114 const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes, const bool theIsStoreSeparate = false);
115 /// load and orient generated shapes
116 MODELAPI_EXPORT virtual void loadAndOrientGeneratedShapes (GeomAlgoAPI_MakeShape* theMS,
117 std::shared_ptr<GeomAPI_Shape> theShapeIn, const int theKindOfShape,
118 const int theTag, const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes);
120 /// load shapes of the first level (to be used during shape import)
121 MODELAPI_EXPORT virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape,
122 const std::string& theName, int& theTag);
124 /// load disconnected edges
125 MODELAPI_EXPORT virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape,
126 const std::string& theName, int& theTag);
128 /// load disconnected vetexes
129 MODELAPI_EXPORT virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape,
130 const std::string& theName,int& theTag);
132 /// Returns true if the latest modification of this body in the naming history
133 // is equal to the given shape
134 MODELAPI_EXPORT virtual bool isLatestEqual(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
136 /// Returns true is the topology is connected. Cashes this information for the current shape,
137 /// so it is more effective to use this method than directly GeomAPI_Shape.
138 MODELAPI_EXPORT virtual bool isConnectedTopology();
141 /// Default constructor accessible only from Model_Objects
142 MODELAPI_EXPORT ModelAPI_ResultBody();
144 ModelAPI_BodyBuilder* myBuilder; ///< provides the body processing in naming shape
147 //! Pointer on feature object
148 typedef std::shared_ptr<ModelAPI_ResultBody> ResultBodyPtr;