Salome HOME
updated copyright message
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Boolean.h
index a46ab91a969f902f170e9e6821d1f6e13b7a89ce..ab7ae15772a8ed96fdca2e21814196ef7581c314 100644 (file)
@@ -1,90 +1,85 @@
-// File:        GeomAlgoAPI_Boolean.h
-// Created:     02 Sept 2014
-// Author:      Vitaly Smetannikov
+// Copyright (C) 2014-2023  CEA, EDF
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef GeomAlgoAPI_Boolean_H_
 #define GeomAlgoAPI_Boolean_H_
 
 #include <GeomAlgoAPI.h>
-#include <GeomAPI_Shape.h>
 #include <GeomAlgoAPI_MakeShape.h>
-#include <GeomAPI_DataMapOfShapeShape.h>
-#include <boost/shared_ptr.hpp>
-
-/**\class GeomAlgoAPI_Boolean
- * \ingroup DataAlgo
- * \brief Allows to perform of boolean operations
- */
-class GeomAlgoAPI_Boolean : public GeomAPI_Interface
-{
- public:
-  /* \brief Creates cut boolean operation
-   * \param[in] theShape the main shape
-   * \param[in] theTool  toole shape for boolean
-   * \return a solid as result of operation
-   */
-  GEOMALGOAPI_EXPORT static boost::shared_ptr<GeomAPI_Shape> makeCut(
-                                                 boost::shared_ptr<GeomAPI_Shape> theShape,
-                                              boost::shared_ptr<GeomAPI_Shape> theTool);
+#include <GeomAlgoAPI_Tools.h>
 
-  /* \brief Creates fuse boolean operation
-   * \param[in] theShape the main shape
-   * \param[in] theTool  second shape
-   * \return a solid as result of operation
-   */
-  GEOMALGOAPI_EXPORT static boost::shared_ptr<GeomAPI_Shape> makeFuse(
-                                                 boost::shared_ptr<GeomAPI_Shape> theShape,
-                                              boost::shared_ptr<GeomAPI_Shape> theTool);
-
-  /* \brief Creates common boolean operation
-   * \param[in] theObject the main shape
-   * \param[in] theTool  second shape
-   * \param[in] theType  type of the operation: Fuse, Cut, Common
-   * \return a solid as result of operation
-   */
-  GEOMALGOAPI_EXPORT static boost::shared_ptr<GeomAPI_Shape> makeCommon(
-                                                 boost::shared_ptr<GeomAPI_Shape> theObject,
-                                              boost::shared_ptr<GeomAPI_Shape> theTool);
+#include <GeomAPI_Shape.h>
 
-   enum {
-       BOOL_CUT,
-    BOOL_FUSE,
-    BOOL_COMMON
-  };
-  /// Constructor
-  GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean (boost::shared_ptr<GeomAPI_Shape> theObject,
-                                          boost::shared_ptr<GeomAPI_Shape> theTool,
-                                                                                 int theType);
+/// \class GeomAlgoAPI_Boolean
+/// \ingroup DataAlgo
+/// \brief Allows to perform of boolean operations
+class GeomAlgoAPI_Boolean : public GeomAlgoAPI_MakeShape
+{
+public:
 
-  /// Returns True if algorithm succeed
-  GEOMALGOAPI_EXPORT const bool isDone() const;
+  /// Constructor.
+  /// \param[in] theObject the main object.
+  /// \param[in] theTool the tool object.
+  /// \param[in] theOperationType type of boolean operation.
+  /// \param[in] theFuzzy additional tolerance value.
+  ///            If the fuzzy value is non-positive, the boolean operation will use a default
+  //             additional tolerance value of 1.e-5.
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const GeomShapePtr theObject,
+                                         const GeomShapePtr theTool,
+                                         const GeomAlgoAPI_Tools::BOPType theOperationType,
+                                         const double theFuzzy = -1);
 
-  ///  Returns True if resulting shape is valid
-  GEOMALGOAPI_EXPORT const bool isValid() const;
+  /// Constructor.
+  /// \param[in] theObject the main object.
+  /// \param[in] theTools list of tools.
+  /// \param[in] theOperationType type of boolean operation.
+  /// \param[in] theFuzzy additional tolerance value.
+  ///            If the fuzzy value is non-positive, the boolean operation will use a default
+  //             additional tolerance value of 1.e-5.
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const GeomShapePtr theObject,
+                                         const ListOfShape& theTools,
+                                         const GeomAlgoAPI_Tools::BOPType theOperationType,
+                                         const double theFuzzy = -1);
 
-  /// Returns result of the boolean algorithm which may be a Solid or a Face
-  GEOMALGOAPI_EXPORT const boost::shared_ptr<GeomAPI_Shape>& shape () const; 
-  /// Returns map of sub-shapes of the result. To be used for History keeping
-  GEOMALGOAPI_EXPORT void  mapOfShapes (GeomAPI_DataMapOfShapeShape& theMap) const;
 
-  /// Return interface for for History processing
-  GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape* makeShape () const;
+  /// Constructor.
+  /// \param[in] theObjects list of main objects.
+  /// \param[in] theTools list of tools.
+  /// \param[in] theOperationType type of boolean operation.
+  /// \param[in] theFuzzy additional tolerance value.
+  ///            If the fuzzy value is non-positive, the boolean operation will use a default
+  //             additional tolerance value of 1.e-5.
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const ListOfShape& theObjects,
+                                         const ListOfShape& theTools,
+                                         const GeomAlgoAPI_Tools::BOPType theOperationType,
+                                         const double theFuzzy = -1);
 
-  ///Destructor
-  GEOMALGOAPI_EXPORT  ~GeomAlgoAPI_Boolean();
+  /// Redefinition of the generic method for the Fuse problem: OCCT 30481
+  GEOMALGOAPI_EXPORT virtual void modified(const GeomShapePtr theOldShape,
+                                           ListOfShape& theNewShapes);
 
-  private:
-  /// builds resulting shape
-  void build(boost::shared_ptr<GeomAPI_Shape> theObject,
-             boost::shared_ptr<GeomAPI_Shape> theTool);
-  /// fields
-  double mySize;
-  bool myDone;
-  int  myOperation;
-  boost::shared_ptr<GeomAPI_Shape> myShape;  
-  GeomAPI_DataMapOfShapeShape myMap;
-  GeomAlgoAPI_MakeShape * myMkShape;
+private:
+  /// Builds resulting shape.
+  void build(const ListOfShape& theObjects,
+             const ListOfShape& theTools,
+             const GeomAlgoAPI_Tools::BOPType theOperationType,
+             const double theFuzzy);
 };
 
 #endif