src/GeomAlgoAPI/GeomAlgoAPI_Chamfer.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_Chamfer_H_
  21 #define GeomAlgoAPI_Chamfer_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25
  26 #include <GeomAPI_Shape.h>
  27 //#include <GeomAPI_Edge.h>
  28 //#include <GeomAPI_Face.h>
  29
  30 /// \class GeomAlgoAPI_Chamfer
  31 /// \ingroup DataAlgo
  32 /// \brief Perform chamfer
  33 class GeomAlgoAPI_Chamfer : public GeomAlgoAPI_MakeShape
  34 {
  35 public:
  36   /// Run chamfer operation with two distances or with a distance and an angle .
  37   /// \param theBaseSolid      a changing solid
  38   /// \param theChamferShapes  list of edges the chamfer is performed on
  39   /// \param theMapEdgeFace    map that associates an edge to a face when the chamfer is applied
  40   ///                          to a face
  41   /// \param performDistances  boolean that indicates whether the operation is performed with
  42   ///                          two distances or not
  43   /// \param theVal1           double D1 if performDistances is true or D
  44   /// \param theVal2           double D2 if performDistances is true or Angle
  45   GEOMALGOAPI_EXPORT GeomAlgoAPI_Chamfer(const GeomShapePtr& theBaseSolid,
  46                                          const ListOfShape&  theChamferShapes,
  47                                          const std::map<GeomShapePtr, GeomShapePtr> theMapEdgeFace,
  48                                          const bool performDistances,
  49                                          const double theVal1,
  50                                          const double theVal2);
  51
  52 private:
  53   /// Perform chamfer operation.
  54   /// \param theBaseSolid     a changing solid
  55   /// \param theChamferShapes list of edges the chamfer is performed on
  56   /// \param theMapEdgeFace   map that associates an edge to a face when the chamfer is applied
  57   ///                         to a face
  58   /// \param performDistances boolean that indicates whether the operation is performed with two
  59   ///                         distances or not
  60   /// \param theVal1          double D1 if performDistances is true or D
  61   /// \param theVal2          double D2 if performDistances is true or Angle
  62   GEOMALGOAPI_EXPORT void build(const GeomShapePtr& theBaseSolid,
  63                                 const ListOfShape&  theChamferShapes,
  64                                 const std::map<GeomShapePtr, GeomShapePtr> theMapEdgeFace,
  65                                 const bool performDistances,
  66                                 const double theVal1,
  67                                 const double theVal2);
  68 };
  69
  70 #endif