Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Boolean.h
index fd25cff88e439979e86532865f70d4be7c321e08..e1a32b240fe19b0191264b9b38b03d345e366d75 100644 (file)
@@ -1,39 +1,42 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesPlugin_Boolean.h
-// Created:     02 Sept 2014
-// Author:      Vitaly SMETANNIKOV
-
-#ifndef FeaturesPlugin_Cut_H_
-#define FeaturesPlugin_Cut_H_
-
-#include "FeaturesPlugin.h"
-
-#include <GeomAlgoAPI_MakeShape.h>
-
-#include <ModelAPI_Feature.h>
+// 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 FeaturesPlugin_Boolean_H_
+#define FeaturesPlugin_Boolean_H_
+
+#include "FeaturesPlugin_VersionedBoolean.h"
 
 /// \class FeaturesPlugin_Boolean
 /// \ingroup Plugins
 /// \brief Feature for applying of Boolean operations on Solids.
 /// Supports four kinds of Boolean operations: Cut, Fuse, Common and Smash.
-class FeaturesPlugin_Boolean : public ModelAPI_Feature
+class FeaturesPlugin_Boolean : public FeaturesPlugin_VersionedBoolean
 {
 public:
   enum OperationType {
     BOOL_CUT,
     BOOL_FUSE,
     BOOL_COMMON,
+    BOOL_FILL,
     BOOL_SMASH
   };
 
-  /// Feature kind.
-  inline static const std::string& ID()
-  {
-    static const std::string MY_ID("Boolean");
-    return MY_ID;
-  }
-
   /// Attribute name of main objects.
   inline static const std::string& OBJECT_LIST_ID()
   {
@@ -48,39 +51,48 @@ public:
     return MY_TOOL_LIST_ID;
   }
 
-  /// Attribute name of operation type.
-  inline static const std::string& TYPE_ID()
+  /// Attribute name of use fuzzy parameter.
+  inline static const std::string& USE_FUZZY_ID()
   {
-    static const std::string MY_TYPE_ID("bool_type");
-    return MY_TYPE_ID;
+    static const std::string MY_USE_FUZZY_ID("use_fuzzy");
+    return MY_USE_FUZZY_ID;
   }
 
-  /// \return the kind of a feature.
-  FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
+  /// Attribute name of fuzzy parameter.
+  inline static const std::string& FUZZY_PARAM_ID()
   {
-    static std::string MY_KIND = FeaturesPlugin_Boolean::ID();
-    return MY_KIND;
+    static const std::string MY_FUZZY_PARAM_ID("fuzzy_param");
+    return MY_FUZZY_PARAM_ID;
   }
 
-  /// Creates a new part document if needed.
-  FEATURESPLUGIN_EXPORT virtual void execute();
+  /// \return boolean operation type.
+  FEATURESPLUGIN_EXPORT OperationType operationType();
 
   /// Request for initialization of data model of the feature: adding all attributes.
   FEATURESPLUGIN_EXPORT virtual void initAttributes();
 
-  /// Use plugin manager for features creation.
-  FeaturesPlugin_Boolean();
+protected:
 
-private:
-  std::shared_ptr<GeomAPI_Shape> getShape(const std::string& theAttrName);
+  /// Use plugin manager for features creation.
+  FeaturesPlugin_Boolean(const OperationType theOperationType);
 
   /// Load Naming data structure of the feature to the document
   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
                     const ListOfShape& theTools,
                     const std::shared_ptr<GeomAPI_Shape> theResultShape,
-                    GeomAlgoAPI_MakeShape& theMakeShape,
-                    GeomAPI_DataMapOfShapeShape& theMapOfShapes);
+                    const GeomMakeShapePtr& theMakeShape);
+
+  /// Store result shape if it is not empty and increase results counter
+  void storeResult(const ListOfShape& theObjects,
+                   const ListOfShape& theTools,
+                   const GeomShapePtr theResultShape,
+                   int& theResultIndex,
+                   std::shared_ptr<GeomAlgoAPI_MakeShapeList> theMakeShapeList,
+                   std::vector<ModelAPI_Tools::ResultBaseAlgo>& theResultBaseAlgoList);
+
+private:
+  OperationType myOperationType;
 };
 
 #endif