Salome HOME
27.10.2014. Naming data structure for Extrusion feature.
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Extrusion.h
1 // File:        GeomAlgoAPI_Extrusion.h
2 // Created:     22 October 2014
3 // Author:      Sergey Zaritchny
4
5 #ifndef GeomAlgoAPI_Extrusion_H_
6 #define GeomAlgoAPI_Extrusion_H_
7
8 #include <GeomAlgoAPI.h>
9 #include <GeomAPI_Shape.h>
10 #include <GeomAPI_Dir.h>
11 #include <ModelAPI_ResultBody.h>
12 #include <boost/shared_ptr.hpp>
13 #include <BRepPrimAPI_MakePrism.hxx>
14 #include <TopoDS_Shape.hxx>
15 /**\class GeomAlgoAPI_Extrusion
16  * \ingroup DataAlgo
17  * \brief Allows to create the prism based on a given face and a direction
18  */
19
20 class GEOMALGOAPI_EXPORT GeomAlgoAPI_Extrusion  
21 {
22  public:
23
24   /* \brief Creates extrusion for the given shape along the normal for this shape
25    * \param[in] theShape face or wire to be extruded
26    * \param[in] theSize  the length of extrusion (if the value is less than 0, the extrusion in opposite normal)
27    * \return a solid or a face which is obtained from specified one
28   
29   static boost::shared_ptr<GeomAPI_Shape> makeExtrusion(boost::shared_ptr<ModelAPI_ResultBody> theResult,
30                                                                                                                 boost::shared_ptr<GeomAPI_Shape> theBasis,
31                                                                                                                 boost::shared_ptr<GeomAPI_Shape> theContext,
32                                                         double theSize); */
33   /// Constructor
34   GeomAlgoAPI_Extrusion (boost::shared_ptr<GeomAPI_Shape> theBasis, double theSize);
35
36   /// Returns True if algorithm succeed
37   const bool isDone() const;
38
39   ///  Returns True if resulting shape is valid
40   const bool isValid() const;
41
42   /// Returns True if resulting shape has volume
43   const bool hasVolume() const;
44
45   /// Returns result of the Extrusion algorithm which may be a Solid or a Face
46   const boost::shared_ptr<GeomAPI_Shape>& shape () const;
47
48   /// Returns list of shapes generated from theShape
49   const ListOfShape& generated(const boost::shared_ptr<GeomAPI_Shape> theShape);
50
51   /// Returns the first shape 
52   const boost::shared_ptr<GeomAPI_Shape>& firstShape();
53
54   /// returns last shape
55   const boost::shared_ptr<GeomAPI_Shape>& lastShape();   
56
57 private:
58   /// builds resulting shape
59   void build();
60
61   BRepPrimAPI_MakePrism * myBuilder;
62   TopoDS_Shape myBasis;
63   double mySize;
64   bool myDone;
65   TopoDS_Shape myResult;
66   ListOfShape myHistory;
67   boost::shared_ptr<GeomAPI_Shape> myShape;
68   boost::shared_ptr<GeomAPI_Shape> myFirst;
69   boost::shared_ptr<GeomAPI_Shape> myLast;
70 };
71
72 #endif