Salome HOME
updated copyright message
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Partition.h
old mode 100755 (executable)
new mode 100644 (file)
index 444d3e8..d780743
@@ -1,51 +1,73 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-// File:        FeaturesPlugin_Partition.h
-// Created:     31 Jul 2015
-// Author:      Natalia ERMOLAEVA
+// 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_Partition_H_
 #define FeaturesPlugin_Partition_H_
 
-#include "FeaturesPlugin.h"
+#include "FeaturesPlugin_VersionedBoolean.h"
 #include <ModelAPI_Feature.h>
 
-/**\class FeaturesPlugin_Partition
- * \ingroup Plugins
- * \brief Feature for applying of Partition operations on Solids. Partition makes conjunctional
- * faces of solids as shared. The result of partitions is a compsolid.
- * Main objects are solids, tool objects are solids or faces
- */
-class FeaturesPlugin_Partition : public ModelAPI_Feature
+#include <GeomAlgoAPI_Partition.h>
+
+/// \class FeaturesPlugin_Partition
+/// \ingroup Plugins
+/// \brief Feature for applying of Partition operations on Shapes. Partition makes conjunctional
+/// faces of solids as shared. The result of partitions is a compsolid.
+class FeaturesPlugin_Partition : public FeaturesPlugin_VersionedBoolean
 {
 public:
-  /// Extrusion kind
+  /// Feature kind.
   inline static const std::string& ID()
   {
     static const std::string MY_ID("Partition");
     return MY_ID;
   }
-  /// attribute name of referenced object
-  inline static const std::string& OBJECT_LIST_ID()
+
+  /// Attribute name of base objects.
+  inline static const std::string& BASE_OBJECTS_ID()
   {
-    static const std::string MY_OBJECT_LIST_ID("main_objects");
-    return MY_OBJECT_LIST_ID;
+    static const std::string MY_BASE_OBJECTS_ID("base_objects");
+    return MY_BASE_OBJECTS_ID;
   }
-  /// attribute name of tool object
-  inline static const std::string& TOOL_LIST_ID()
+
+  /// Attribute name of use fuzzy parameter.
+  inline static const std::string& USE_FUZZY_ID()
+  {
+    static const std::string MY_USE_FUZZY_ID("use_fuzzy");
+    return MY_USE_FUZZY_ID;
+  }
+
+  /// Attribute name of fuzzy parameter.
+  inline static const std::string& FUZZY_PARAM_ID()
   {
-    static const std::string MY_TOOL_LIST_ID("tool_objects");
-    return MY_TOOL_LIST_ID;
+    static const std::string MY_FUZZY_PARAM_ID("fuzzy_param");
+    return MY_FUZZY_PARAM_ID;
   }
 
-  /// Returns the kind of a feature
+  /// \return the kind of a feature.
   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
   {
     static std::string MY_KIND = FeaturesPlugin_Partition::ID();
     return MY_KIND;
   }
 
-  /// Creates a new part document if needed
+  /// Performs the algorithm and stores results it in the data structure.
   FEATURESPLUGIN_EXPORT virtual void execute();
 
   /// Request for initialization of data model of the feature: adding all attributes
@@ -55,8 +77,22 @@ public:
   FeaturesPlugin_Partition();
 
 private:
-  std::shared_ptr<GeomAPI_Shape> getShape(const std::string& theAttrName);
+  /// Stores result of generation.
+  void storeResult(ListOfShape& theObjects,
+                   ListOfShape& thePlanes,
+                   const GeomShapePtr theResultShape,
+                   const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape,
+                   const int theIndex = 0);
 
+  /// Cut all of unused subs of compsolids by the full compsolid of the first selected object,
+  /// and vice versa, cut all objects of Partition by not used subs of the first selected object.
+  /// Store results of operation to the separated lists of shapes.
+  bool cutSubs(GeomAPI_ShapeHierarchy& theHierarchy,
+               ListOfShape& theUsed,
+               ListOfShape& theNotUsed,
+               const double theFuzzy,
+               std::shared_ptr<GeomAlgoAPI_MakeShapeList>& theMakeShapeList,
+               std::string& theError);
 };
 
 #endif