updated copyright message

[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_CompositeBoolean.h

diff --git a/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h b/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h
index daa2e060d9635cf00c9bd1232ff797547b984a40..86bb438b7a1cc0585eb06fb4294c3fd2f3d3ba81 100644 (file)
--- a/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h
+++ b/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        FeaturesPlugin_CompositeBoolean.h
-// Created:     11 June 2015
-// Author:      Dmitry Bobylev
+// Copyright (C) 2014-2023  CEA/DEN, EDF R&D
+//
+// 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 FeaturesPlugin_CompositeBoolean_H_
 #define FeaturesPlugin_CompositeBoolean_H_
@@ -12,6 +25,7 @@
 #include <ModelAPI_Feature.h>
 #include <ModelAPI_ResultBody.h>
 #include <GeomAlgoAPI_MakeShape.h>
+#include <GeomAlgoAPI_MakeShapeList.h>
 
 /// \class FeaturesPlugin_CompositeBoolean
 /// \ingroup Plugins
@@ -33,8 +47,17 @@ public:
     return MY_OBJECTS_ID;
   }
 
-  /// Creates a new part document if needed.
-  FEATURESPLUGIN_EXPORT virtual void execute();
+  /// Performs the algorithm and stores results it in the data structure.
+  FEATURESPLUGIN_EXPORT virtual void executeCompositeBoolean();
+
+  const OperationType& operationType() const { return myOperationType; }
+
+protected:
+  struct ResultBaseAlgo {
+    ResultBodyPtr resultBody;
+    GeomShapePtr baseShape;
+    std::shared_ptr<GeomAlgoAPI_MakeShape> makeShape;
+  };
 
 protected:
   FeaturesPlugin_CompositeBoolean(){};
@@ -50,7 +73,7 @@ protected:
   /// \param[in] theTools list of tools.
   /// \param[out] theObjects list of objects.
   /// \param[out] theMakeShapes list of according algos.
-  /// \return false in failed.
+  /// \return false if failed.
   bool makeBoolean(const ListOfShape& theTools,
                    ListOfShape& theObjects,
                    ListOfMakeShape& theMakeShapes);
@@ -58,15 +81,41 @@ protected:
   /// Stores generation history.
   virtual void storeGenerationHistory(ResultBodyPtr theResultBody,
                                       const GeomShapePtr theBaseShape,
-                                      const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
-                                      int& theTag) = 0;
+                                      const GeomMakeShapePtr theMakeShape) = 0;
 
   /// Stores modification history.
   void storeModificationHistory(ResultBodyPtr theResultBody,
                                 const GeomShapePtr theObject,
                                 const ListOfShape& theTools,
-                                const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
-                                int& theTag);
+                                const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape);
+
+  /// Stores deleted shapes.
+  void storeDeletedShapes(std::vector<ResultBaseAlgo>& theResultBaseAlgoList,
+                          const ListOfShape& theTools,
+                          const GeomShapePtr theResultShapesCompound);
+
+private:
+  /// Makes cut operation recursively.
+  /// Called from makeBoolean().
+  /// \param[in] theCompound the shape to be cut.
+  /// \param[in] theTools list of tools.
+  /// \param[out] theMakeShapeList list of according algos.
+  /// \param[out] theResult result of cut.
+  /// \return false if failed or no cuts done (this is normal case).
+  bool cutRecursiveCompound (const GeomShapePtr theCompound,
+                             const ListOfShape& theTools,
+                             std::shared_ptr<GeomAlgoAPI_MakeShapeList>& theMakeShapeList,
+                             GeomShapePtr& theResult);
+
+  /// Add subshapes of \a theCompound to \a theSubShapesToAdd list,
+  /// except ones from \a theSubShapesToAvoid.
+  /// Called from makeBoolean().
+  /// \param[in] theCompound the shape to collect sub-shapes of.
+  /// \param[in] theSubShapesToAvoid list of shapes that should not be added to the result.
+  /// \param[out] theSubShapesToAdd list of found sub-shapes.
+  void addSubShapes (const GeomShapePtr theCompound,
+                     const ListOfShape& theSubShapesToAvoid,
+                     ListOfShape& theSubShapesToAdd);
 
 protected:
   ModelAPI_Feature* myFeature;