Issue #662 Warning on remove or rename of (may be) used object in PartSet

[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Boolean.h

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h
index 790e7950c25ede6c4d2b0d6e52f0ad49adc35367..1c3655d9b0fdcbbc13c4854d88064109da3079b9 100644 (file)
--- a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        GeomAlgoAPI_Boolean.h
 // Created:     02 Sept 2014
 // Author:      Vitaly Smetannikov
@@ -6,24 +8,84 @@
 #define GeomAlgoAPI_Boolean_H_
 
 #include <GeomAlgoAPI.h>
+#include <GeomAlgoAPI_MakeShape.h>
+
 #include <GeomAPI_Shape.h>
-#include <boost/shared_ptr.hpp>
+#include <GeomAPI_Interface.h>
+#include <GeomAPI_DataMapOfShapeShape.h>
 
-/**\class GeomAlgoAPI_Boolean
- * \ingroup DataAlgo
- * \brief Allows to perform of boolean operations
+#include <memory>
+
+/** \class GeomAlgoAPI_Boolean
+ *  \ingroup DataAlgo
+ *  \brief Allows to perform of boolean operations
  */
-class GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean
+class GeomAlgoAPI_Boolean : public GeomAPI_Interface
 {
+public:
+  enum OperationType{
+    BOOL_CUT,
+    BOOL_FUSE,
+    BOOL_COMMON
+  };
+
  public:
-  /* \brief Creates cut boolean operation
-   * \param[in] theShape face or wire to be extruded
-   * \param[in] theTool  toole shape for boolean
-   * \return a solid as result of operation
+  /** \brief Creates cut boolean operation.
+   *  \param[in] theObjects the main shape.
+   *  \param[in] theTools  toole shape for boolean.
+   *  \return a solid or compound of solids as result of operation.
+   */
+  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> makeCut(const ListOfShape& theObjects,
+                                                                   const ListOfShape& theTools);
+
+  /** \brief Creates fuse boolean operation.
+   *  \param[in] theObjects the main shape.
+   *  \param[in] theTools  second shape.
+   *  \return a solid as result of operation.
+   */
+  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> makeFuse(const ListOfShape& theObjects,
+                                                                    const ListOfShape& theTools);
+
+  /** \brief Creates common boolean operation.
+   *  \param[in] theObjects the main shape.
+   *  \param[in] theTools  second shape.
+   *  \return a solid as result of operation.
    */
-  static boost::shared_ptr<GeomAPI_Shape> makeCut(boost::shared_ptr<GeomAPI_Shape> theShape,
-                                                        boost::shared_ptr<GeomAPI_Shape> theTool);
+  GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> makeCommon(const ListOfShape& theObjects,
+                                                                      const ListOfShape& theTools);
+
+  /// Constructor.
+  GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean(const ListOfShape& theObjects,
+                                         const ListOfShape& theTools,
+                                         const OperationType theOperationType);
+
+  /// \return true if algorithm succeed.
+  GEOMALGOAPI_EXPORT const bool isDone() const;
+
+  /// \return true if resulting shape is valid.
+  GEOMALGOAPI_EXPORT const bool isValid() const;
+
+  /// \return result of the boolean algorithm.
+  GEOMALGOAPI_EXPORT const std::shared_ptr<GeomAPI_Shape>& shape() const;
+
+  /// \return map of sub-shapes of the result. To be used for History keeping.
+  GEOMALGOAPI_EXPORT std::shared_ptr<GeomAPI_DataMapOfShapeShape> mapOfShapes() const;
+
+  /// \return interface for for History processing.
+  GEOMALGOAPI_EXPORT std::shared_ptr<GeomAlgoAPI_MakeShape> makeShape() const;
+
+private:
+  /// Builds resulting shape.
+  void build(const ListOfShape& theObjects,
+             const ListOfShape& theTools,
+             const OperationType theOperationType);
 
+private:
+  /// Fields.
+  bool myDone;
+  std::shared_ptr<GeomAPI_Shape> myShape;
+  std::shared_ptr<GeomAPI_DataMapOfShapeShape> myMap;
+  std::shared_ptr<GeomAlgoAPI_MakeShape> myMkShape;
 };
 
 #endif