src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h

   1 // Copyright (C) 2014-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 email : webmaster.salome@opencascade.com<mailto: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
  26 #include <GeomAPI_Shape.h>
  27
  28 /// \class GeomAlgoAPI_Boolean
  29 /// \ingroup DataAlgo
  30 /// \brief Allows to perform of boolean operations
  31 class GeomAlgoAPI_Boolean : public GeomAlgoAPI_MakeShape
  32 {
  33 public:
  34   /// Type of booelan operation
  35   enum OperationType {
  36     BOOL_CUT,   ///< Cut objects
  37     BOOL_FUSE,  ///< Fuse objects
  38     BOOL_COMMON ///< Take common part of objects
  39   };
  40
  41  public:
  42
  43   /// Constructor.
  44   GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const ListOfShape& theObjects,
  45                                          const ListOfShape& theTools,
  46                                          const OperationType theOperationType);
  47
  48 private:
  49   /// Builds resulting shape.
  50   void build(const ListOfShape& theObjects,
  51              const ListOfShape& theTools,
  52              const OperationType theOperationType);
  53 };
  54
  55 #endif