src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h

   1 // Copyright (C) 2014-2023  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_Boolean_H_
  21 #define GeomAlgoAPI_Boolean_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAlgoAPI_MakeShape.h>
  25 #include <GeomAlgoAPI_Tools.h>
  26
  27 #include <GeomAPI_Shape.h>
  28
  29 /// \class GeomAlgoAPI_Boolean
  30 /// \ingroup DataAlgo
  31 /// \brief Allows to perform of boolean operations
  32 class GeomAlgoAPI_Boolean : public GeomAlgoAPI_MakeShape
  33 {
  34 public:
  35
  36   /// Constructor.
  37   /// \param[in] theObject the main object.
  38   /// \param[in] theTool the tool object.
  39   /// \param[in] theOperationType type of boolean operation.
  40   /// \param[in] theFuzzy additional tolerance value.
  41   ///            If the fuzzy value is non-positive, the boolean operation will use a default
  42   //             additional tolerance value of 1.e-5.
  43   GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const GeomShapePtr theObject,
  44                                          const GeomShapePtr theTool,
  45                                          const GeomAlgoAPI_Tools::BOPType theOperationType,
  46                                          const double theFuzzy = -1);
  47
  48   /// Constructor.
  49   /// \param[in] theObject the main object.
  50   /// \param[in] theTools list of tools.
  51   /// \param[in] theOperationType type of boolean operation.
  52   /// \param[in] theFuzzy additional tolerance value.
  53   ///            If the fuzzy value is non-positive, the boolean operation will use a default
  54   //             additional tolerance value of 1.e-5.
  55   GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const GeomShapePtr theObject,
  56                                          const ListOfShape& theTools,
  57                                          const GeomAlgoAPI_Tools::BOPType theOperationType,
  58                                          const double theFuzzy = -1);
  59
  60
  61   /// Constructor.
  62   /// \param[in] theObjects list of main objects.
  63   /// \param[in] theTools list of tools.
  64   /// \param[in] theOperationType type of boolean operation.
  65   /// \param[in] theFuzzy additional tolerance value.
  66   ///            If the fuzzy value is non-positive, the boolean operation will use a default
  67   //             additional tolerance value of 1.e-5.
  68   GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const ListOfShape& theObjects,
  69                                          const ListOfShape& theTools,
  70                                          const GeomAlgoAPI_Tools::BOPType theOperationType,
  71                                          const double theFuzzy = -1);
  72
  73   /// Redefinition of the generic method for the Fuse problem: OCCT 30481
  74   GEOMALGOAPI_EXPORT virtual void modified(const GeomShapePtr theOldShape,
  75                                            ListOfShape& theNewShapes);
  76
  77 private:
  78   /// Builds resulting shape.
  79   void build(const ListOfShape& theObjects,
  80              const ListOfShape& theTools,
  81              const GeomAlgoAPI_Tools::BOPType theOperationType,
  82              const double theFuzzy);
  83 };
  84
  85 #endif