src/GeomAlgoAPI/GeomAlgoAPI_Revolution.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef GeomAlgoAPI_Revolution_H_
  21 #define GeomAlgoAPI_Revolution_H_
  22
  23 #include "GeomAlgoAPI.h"
  24
  25 #include "GeomAlgoAPI_MakeSweep.h"
  26
  27 #include <GeomAPI_Ax1.h>
  28
  29 /// \class GeomAlgoAPI_Revolution
  30 /// \ingroup DataAlgo
  31 /// \brief Allows to create the revolution based on a given face, angles and bounding planes.
  32 /// \n Note that only the planar faces are allowed as bounding faces and resulting
  33 /// revolution will be bounded by the infinite planes taken from the faces.
  34 /// \n If the bounding plane was specified with the angle then this plane will be rotated around
  35 /// the axis to the value of the angle.
  36 /// \n Note that algorithm return only one solid object. So in case when after cutting with bounding
  37 /// planes algorithm got more than one solid it will return the closest to the center of mass of
  38 /// the base face.
  39 class GeomAlgoAPI_Revolution : public GeomAlgoAPI_MakeSweep
  40 {
  41 public:
  42   /// \brief Creates revolution for the given shape.
  43   /// \param[in] theBaseShape face for revolution.
  44   /// \param[in] theAxis axis for revolution.
  45   /// \param[in] theToShape to bounding shape. Can be empty.
  46   ///                       In this case offset will be applied to the basis.
  47   /// \param[in] theToAngle to angle.
  48   /// \param[in] theFromShape from bounding shape. Can be empty.
  49   ///                       In this case offset will be applied to the basis.
  50   /// \param[in] theFromAngle from angle.
  51   GEOMALGOAPI_EXPORT GeomAlgoAPI_Revolution(const GeomShapePtr                 theBaseShape,
  52                                             const std::shared_ptr<GeomAPI_Ax1> theAxis,
  53                                             const GeomShapePtr                 theToShape,
  54                                             const double                       theToAngle,
  55                                             const GeomShapePtr                 theFromShape,
  56                                             const double                       theFromAngle);
  57
  58 private:
  59   /// Builds resulting shape.
  60   void build(const GeomShapePtr&                 theBaseShape,
  61              const std::shared_ptr<GeomAPI_Ax1>& theAxis,
  62              const GeomShapePtr&                 theToShape,
  63              const double                        theToAngle,
  64              const GeomShapePtr&                 theFromShape,
  65              const double                        theFromAngle);
  66 };
  67
  68 #endif