Salome HOME
Issue #2873: Freeze when inserting a new folder
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Boolean.h
1 // Copyright (C) 2014-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_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 GeomShapePtr theObject,
45                                          const GeomShapePtr theTool,
46                                          const OperationType theOperationType);
47
48   /// Constructor.
49   GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const GeomShapePtr theObject,
50                                          const ListOfShape& theTools,
51                                          const OperationType theOperationType);
52
53
54   /// Constructor.
55   GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const ListOfShape& theObjects,
56                                          const ListOfShape& theTools,
57                                          const OperationType theOperationType);
58
59   /// Redefinition of the generic method for the Fuse problem: OCCT 30481
60   GEOMALGOAPI_EXPORT virtual void modified(const GeomShapePtr theOldShape,
61     ListOfShape& theNewShapes);
62
63 private:
64   /// Builds resulting shape.
65   void build(const ListOfShape& theObjects,
66              const ListOfShape& theTools,
67              const OperationType theOperationType);
68 };
69
70 #endif