1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GeomAlgoAPI_Revolution_H_
22 #define GeomAlgoAPI_Revolution_H_
24 #include "GeomAlgoAPI.h"
26 #include "GeomAlgoAPI_MakeSweep.h"
28 #include <GeomAPI_Ax1.h>
30 /// \class GeomAlgoAPI_Revolution
32 /// \brief Allows to create the revolution based on a given face, angles and bounding planes.
33 /// \n Note that only the planar faces are allowed as bounding faces and resulting
34 /// revolution will be bounded by the infinite planes taken from the faces.
35 /// \n If the bounding plane was specified with the angle then this plane will be rotated around
36 /// the axis to the value of the angle.
37 /// \n Note that algorithm return only one solid object. So in case when after cutting with bounding
38 /// planes algorithm got more than one solid it will return the closest to the center of mass of
40 class GeomAlgoAPI_Revolution : public GeomAlgoAPI_MakeSweep
43 /// \brief Creates revolution for the given shape.
44 /// \param[in] theBaseShape face for revolution.
45 /// \param[in] theAxis axis for revolution.
46 /// \param[in] theToAngle to angle.
47 /// \param[in] theFromAngle from angle.
48 GEOMALGOAPI_EXPORT GeomAlgoAPI_Revolution(const GeomShapePtr theBaseShape,
49 const std::shared_ptr<GeomAPI_Ax1> theAxis,
50 const double theToAngle,
51 const double theFromAngle);
53 /// \brief Creates revolution for the given shape.
54 /// \param[in] theBaseShape face for revolution.
55 /// \param[in] theAxis axis for revolution.
56 /// \param[in] theToShape to bounding shape. Can be empty.
57 /// In this case offset will be applied to the basis.
58 /// \param[in] theToAngle to angle.
59 /// \param[in] theFromShape from bounding shape. Can be empty.
60 /// In this case offset will be applied to the basis.
61 /// \param[in] theFromAngle from angle.
62 GEOMALGOAPI_EXPORT GeomAlgoAPI_Revolution(const GeomShapePtr theBaseShape,
63 const std::shared_ptr<GeomAPI_Ax1> theAxis,
64 const GeomShapePtr theToShape,
65 const double theToAngle,
66 const GeomShapePtr theFromShape,
67 const double theFromAngle);
70 /// Builds resulting shape.
71 void build(const GeomShapePtr& theBaseShape,
72 const std::shared_ptr<GeomAPI_Ax1>& theAxis,
73 const GeomShapePtr& theToShape,
74 const double theToAngle,
75 const GeomShapePtr& theFromShape,
76 const double theFromAngle);