src/GeomAlgoAPI/GeomAlgoAPI_Fillet.h

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