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 /// Iternal enumeration for storage the information of connected topology flag
48 enum ConnectedTopologyFlag {
49 ConnectionNotComputed, ///< not yet computed
50 IsConnected, ///< the topology is connected
51 IsNotConnected ///< the topology is connected
53 /// Keeps (not persistently) the connected topology flag
54 ConnectedTopologyFlag myConnect;
56 /// \brief Stores the shape (called by the execution method).
57 /// param[in] theShape shape to store.
58 /// param[in] theIsStoreSameShapes if false stores reference to the same shape if it is already in document.
59 MODELAPI_EXPORT virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape,
60 const bool theIsStoreSameShapes = true);
62 /// Stores the generated shape (called by the execution method).
63 MODELAPI_EXPORT virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
64 const std::shared_ptr<GeomAPI_Shape>& theToShape);
66 /// Stores the modified shape (called by the execution method).
67 MODELAPI_EXPORT virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
68 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const int theDecomposeSolidsTag = 0);
70 /// Stores the shape without naming support
71 MODELAPI_EXPORT virtual void storeWithoutNaming(
72 const std::shared_ptr<GeomAPI_Shape>& theShape);
74 /// Returns the shape-result produced by this feature
75 MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
77 /// Records the subshape newShape which was generated during a topological construction.
78 /// As an example, consider the case of a face generated in construction of a box.
79 MODELAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theNewShape,
80 const std::string& theName, const int theTag = 1);
82 /// Records the shape newShape which was generated from the shape oldShape during a topological
83 /// construction. As an example, consider the case of a face generated from an edge in
84 /// construction of a prism.
85 MODELAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
86 const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
87 const int theTag = 1);
89 /// Records the shape newShape which is a modification of the shape oldShape.
90 /// As an example, consider the case of a face split or merged in a Boolean operation.
91 MODELAPI_EXPORT virtual void modified(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 oldShape which was deleted from the current label.
96 /// As an example, consider the case of a face removed by a Boolean operation.
97 MODELAPI_EXPORT virtual void deleted(
98 const std::shared_ptr<GeomAPI_Shape>& theOldShape, const int theTag = 1);
100 /// load deleted shapes
101 MODELAPI_EXPORT virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
102 std::shared_ptr<GeomAPI_Shape> theShapeIn,
103 const int theKindOfShape,
105 /// load and orient modified shapes
106 MODELAPI_EXPORT virtual void loadAndOrientModifiedShapes (GeomAlgoAPI_MakeShape* theMS,
107 std::shared_ptr<GeomAPI_Shape> theShapeIn, const int theKindOfShape, const int theTag,
108 const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes, const bool theIsStoreSeparate = false);
109 /// load and orient generated shapes
110 MODELAPI_EXPORT virtual void loadAndOrientGeneratedShapes (GeomAlgoAPI_MakeShape* theMS,
111 std::shared_ptr<GeomAPI_Shape> theShapeIn, const int theKindOfShape,
112 const int theTag, const std::string& theName, GeomAPI_DataMapOfShapeShape& theSubShapes);
114 /// load shapes of the first level (to be used during shape import)
115 MODELAPI_EXPORT virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape,
116 const std::string& theName, int& theTag);
118 /// load disconnected edges
119 MODELAPI_EXPORT virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape,
120 const std::string& theName, int& theTag);
122 /// load disconnected vetexes
123 MODELAPI_EXPORT virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape,
124 const std::string& theName,int& theTag);
126 /// Returns true if the latest modification of this body in the naming history
127 // is equal to the given shape
128 MODELAPI_EXPORT virtual bool isLatestEqual(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
130 /// Returns true is the topology is connected. Cashes this information for the current shape,
131 /// so it is more effective to use this method than directly GeomAPI_Shape.
132 MODELAPI_EXPORT virtual bool isConnectedTopology();
135 /// Default constructor accessible only from Model_Objects
136 MODELAPI_EXPORT ModelAPI_ResultBody();
138 ModelAPI_BodyBuilder* myBuilder; ///< provides the body processing in naming shape
141 //! Pointer on feature object
142 typedef std::shared_ptr<ModelAPI_ResultBody> ResultBodyPtr;