1 // File: ModelAPI_ResultBody.hxx
2 // Created: 07 Jul 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef ModelAPI_ResultBody_H_
6 #define ModelAPI_ResultBody_H_
8 #include "ModelAPI_Result.h"
9 #include <GeomAPI_Shape.h>
10 #include <GeomAlgoAPI_MakeShape.h>
11 #include <GeomAPI_DataMapOfShapeShape.h>
12 #include <boost/shared_ptr.hpp>
15 /**\class ModelAPI_ResultBody
17 * \brief The body (shape) result of a feature.
19 * Provides a shape that may be displayed in the viewer.
20 * May provide really huge results, so, working with this kind
21 * of result must be optimized.
23 class ModelAPI_ResultBody : public ModelAPI_Result
26 /// Returns the group identifier of this result
27 virtual std::string groupName()
32 /// Returns the group identifier of this result
33 static std::string group()
35 static std::string MY_GROUP = "Bodies";
39 /// Stores the shape (called by the execution method).
40 virtual void store(const boost::shared_ptr<GeomAPI_Shape>& theShape) = 0;
42 /// Stores the generated shape (called by the execution method).
43 virtual void storeGenerated(const boost::shared_ptr<GeomAPI_Shape>& theFromShape,
44 const boost::shared_ptr<GeomAPI_Shape>& theToShape) = 0;
46 /// Stores the modified shape (called by the execution method).
47 virtual void storeModified(const boost::shared_ptr<GeomAPI_Shape>& theOldShape,
48 const boost::shared_ptr<GeomAPI_Shape>& theNewShape) = 0;
50 /// Returns the shape-result produced by this feature
51 virtual boost::shared_ptr<GeomAPI_Shape> shape() = 0;
53 /// Records the subshape newShape which was generated during a topological construction.
54 /// As an example, consider the case of a face generated in construction of a box.
55 virtual void generated(
56 const boost::shared_ptr<GeomAPI_Shape>& theNewShape, const int theTag = 1) = 0;
58 /// Records the shape newShape which was generated from the shape oldShape during a topological
59 /// construction. As an example, consider the case of a face generated from an edge in
60 /// construction of a prism.
61 virtual void generated(const boost::shared_ptr<GeomAPI_Shape>& theOldShape,
62 const boost::shared_ptr<GeomAPI_Shape>& theNewShape, const int theTag = 1) = 0;
64 /// Records the shape newShape which is a modification of the shape oldShape.
65 /// As an example, consider the case of a face split or merged in a Boolean operation.
66 virtual void modified(const boost::shared_ptr<GeomAPI_Shape>& theOldShape,
67 const boost::shared_ptr<GeomAPI_Shape>& theNewShape, const int theTag = 1) = 0;
69 /// Records the shape oldShape which was deleted from the current label.
70 /// As an example, consider the case of a face removed by a Boolean operation.
72 const boost::shared_ptr<GeomAPI_Shape>& theOldShape, const int theTag = 1) = 0;
74 /// load deleted shapes
75 virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
76 boost::shared_ptr<GeomAPI_Shape> theShapeIn,
77 const int theKindOfShape,
78 const int theTag) = 0;
79 /// load and orient modified shapes
80 virtual void loadAndOrientModifiedShapes (
81 GeomAlgoAPI_MakeShape* theMS,
82 boost::shared_ptr<GeomAPI_Shape> theShapeIn,
83 const int theKindOfShape,
85 GeomAPI_DataMapOfShapeShape& theSubShapes) = 0;
86 /// load and orient generated shapes
87 virtual void loadAndOrientGeneratedShapes (
88 GeomAlgoAPI_MakeShape* theMS,
89 boost::shared_ptr<GeomAPI_Shape> theShapeIn,
90 const int theKindOfShape,
92 GeomAPI_DataMapOfShapeShape& theSubShapes) = 0;
94 /// load shapes of the first level (to be used during shape import)
95 virtual void loadFirstLevel(boost::shared_ptr<GeomAPI_Shape> theShape, int& theTag) = 0;
97 /// load disconnected edges
98 virtual void loadDisconnectedEdges(boost::shared_ptr<GeomAPI_Shape> theShape, int& theTag) = 0;
100 /// load disconnected vetexes
101 virtual void loadDisconnectedVertexes(boost::shared_ptr<GeomAPI_Shape> theShape, int& theTag) = 0;
106 //! Pointer on feature object
107 typedef boost::shared_ptr<ModelAPI_ResultBody> ResultBodyPtr;