src/GeomAlgoAPI/GeomAlgoAPI_Fillet.h

   1 // Copyright (C) 2017-2023  CEA/DEN, EDF R&D
   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_Fillet_H_
  21 #define GeomAlgoAPI_Fillet_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25
  26 #include <GeomAPI_Shape.h>
  27
  28 /// \class GeomAlgoAPI_Fillet
  29 /// \ingroup DataAlgo
  30 /// \brief Perform fillet
  31 class GeomAlgoAPI_Fillet : public GeomAlgoAPI_MakeShape
  32 {
  33 public:
  34   /// Run fillet operation with fixed radius.
  35   /// \param theBaseSolid    a changing solid
  36   /// \param theFilletEdges  list of edges the fillet is performed on
  37   /// \param theFilletRadius radius of the fillet
  38   GEOMALGOAPI_EXPORT GeomAlgoAPI_Fillet(const GeomShapePtr& theBaseSolid,
  39                                         const ListOfShape&  theFilletEdges,
  40                                         const double        theFilletRadius);
  41
  42   /// Run fillet operation with variable radius.
  43   /// \param theBaseSolid    a changing solid
  44   /// \param theFilletEdges  list of edges the fillet is performed on
  45   /// \param theStartRadius  start radius of the fillet
  46   /// \param theEndRadius    end radius of the fillet
  47   GEOMALGOAPI_EXPORT GeomAlgoAPI_Fillet(const GeomShapePtr& theBaseSolid,
  48                                         const ListOfShape&  theFilletEdges,
  49                                         const double        theStartRadius,
  50                                         const double        theEndRadius);
  51
  52 private:
  53   /// Perform fillet operation.
  54   /// If theEndRadius is less than 0., the fixed radius fillet will be built.
  55   /// \param theBaseSolid    a changing solid
  56   /// \param theFilletEdges  list of edges the fillet is performed on
  57   /// \param theStartRadius  start radius of the fillet
  58   /// \param theEndRadius    end radius of the fillet
  59   void build(const GeomShapePtr& theBaseSolid,
  60              const ListOfShape&  theFilletEdges,
  61              const double        theStartRadius,
  62              const double        theEndRadius = -1.0);
  63 };
  64
  65 #endif