Salome HOME
Fix for the issue #1100
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Boolean.h
index 6a8f9c657f155d3783933181a3aea02dc246f7b5..5c2059b88f1cf20867e1980b056152be198347dd 100644 (file)
@@ -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,39 +8,62 @@
 #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>
+
+#include <memory>
 
-/**\class GeomAlgoAPI_Boolean
- * \ingroup DataAlgo
- * \brief Allows to perform of boolean operations
+/** \class GeomAlgoAPI_Boolean
+ *  \ingroup DataAlgo
+ *  \brief Allows to perform of boolean operations
  */
-class GEOMALGOAPI_EXPORT GeomAlgoAPI_Boolean
+class GeomAlgoAPI_Boolean : public GeomAPI_Interface
 {
+public:
+  /// Type of booelan operation
+  enum OperationType{
+    BOOL_CUT, ///< Cut objects
+    BOOL_FUSE, ///< Fuse objects
+    BOOL_COMMON ///< Take common part of objects
+  };
+
  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
-   */
-  static boost::shared_ptr<GeomAPI_Shape> makeCut(boost::shared_ptr<GeomAPI_Shape> theShape,
-                                                        boost::shared_ptr<GeomAPI_Shape> theTool);
-
-  /* \brief Creates fuse boolean operation
-   * \param[in] theShape the main shape
-   * \param[in] theTool  second shape
-   * \return a solid as result of operation
-   */
-  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] theShape the main shape
-   * \param[in] theTool  second shape
-   * \return a solid as result of operation
-   */
-  static boost::shared_ptr<GeomAPI_Shape> makeCommon(boost::shared_ptr<GeomAPI_Shape> theShape,
-                                                     boost::shared_ptr<GeomAPI_Shape> theTool);
+
+  /// 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