src/GeomAlgoAPI/GeomAlgoAPI_Partition.h

   1 // Copyright (C) 2014-2024  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_Partition_H_
  21 #define GeomAlgoAPI_Partition_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25
  26 #include <GeomAPI_Shape.h>
  27
  28 /// \class GeomAlgoAPI_Partition
  29 /// \ingroup DataAlgo
  30 /// \brief Allows to perform of partition operations
  31 class GeomAlgoAPI_Partition : public GeomAlgoAPI_MakeShape
  32 {
  33 public:
  34   /// Constructor.
  35   /// \param[in] theObjects list of main objects.
  36   /// \param[in] theTools list of tools.
  37   /// \param[in] theFuzzy additional tolerance value.
  38   ///            If the fuzzy value is below the minimum tolerance value (1.e-7), the
  39   ///            algorithm will use the default internal fuzzy value from OCCT.
  40   GEOMALGOAPI_EXPORT GeomAlgoAPI_Partition(const ListOfShape& theObjects,
  41                                            const ListOfShape& theTools,
  42                                            const double theFuzzy = 1.e-8);
  43
  44 private:
  45   /// Builds resulting shape.
  46   void build(const ListOfShape& theObjects,
  47              const ListOfShape& theTools,
  48              const double theFuzzy);
  49 };
  50
  51 #endif