]> SALOME platform Git repositories - modules/shaper.git/blob - src/GeomAlgoAPI/GeomAlgoAPI_Chamfer.h
Salome HOME
Add Chamfer feature
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Chamfer.h
1 // Copyright (C) 2017-2019  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 aMapEdgeFace      map that associates an edge to a face when the chamfer is applied to a face
40   /// \param performDistances  boolean that indicates whether the operation is performed with two distances or not
41   /// \param aVal1             double D1 if performDistances is true or D
42   /// \param aVal2             double D2 if performDistances is true or Angle
43   GEOMALGOAPI_EXPORT GeomAlgoAPI_Chamfer(const GeomShapePtr& theBaseSolid,
44                                          const ListOfShape&  theChamferShapes,
45                                          const std::map<GeomShapePtr, GeomShapePtr> aMapEdgeFace,
46                                          const bool performDistances,
47                                          const double aVal1,
48                                          const double aVal2);
49   
50 private:
51   /// Perform chamfer operation.
52   /// \param theBaseSolid    a changing solid
53   /// \param theChamferShapes  list of edges the chamfer is performed on
54   /// \param aMapEdgeFace      map that associates an edge to a face when the chamfer is applied to a face
55   /// \param performDistances  boolean that indicates whether the operation is performed with two distances or not
56   /// \param aVal1             double D1 if performDistances is true or D
57   /// \param aVal2             double D2 if performDistances is true or Angle
58   GEOMALGOAPI_EXPORT void build(const GeomShapePtr& theBaseSolid,
59                                 const ListOfShape&  theChamferShapes,
60                                 const std::map<GeomShapePtr, GeomShapePtr> aMapEdgeFace,
61                                 const bool performDistances,
62                                 const double aVal1,
63                                 const double aVal2);
64 };
65
66 #endif