Salome HOME
Merge branch 'Results_Hierarchy'
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Boolean.h
index e9f28ae1dd60580b4844c2a7724dd663ba48cbcd..ce70e57bc619a23adb39ed2f23015eab795ec68b 100644 (file)
@@ -1,75 +1,89 @@
-// File:        FeaturesPlugin_Boolean.h
-// Created:     02 Sept 2014
-// Author:      Vitaly SMETANNIKOV
+// Copyright (C) 2014-2017  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<mailto:webmaster.salome@opencascade.com>
+//
 
-#ifndef FeaturesPlugin_Cut_H_
-#define FeaturesPlugin_Cut_H_
+#ifndef FeaturesPlugin_Boolean_H_
+#define FeaturesPlugin_Boolean_H_
 
 #include "FeaturesPlugin.h"
+
+#include <GeomAlgoAPI_MakeShape.h>
+
 #include <ModelAPI_Feature.h>
-#include <GeomAPI_Shape.h>
-#include <GeomAlgoAPI_Boolean.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
 {
- public:
-  /// Extrusion kind
-  inline static const std::string& ID()
-  {
-    static const std::string MY_ID("Boolean");
-    return MY_ID;
-  }
-  /// attribute name of referenced object
-  inline static const std::string& OBJECT_ID()
-  {
-    static const std::string MY_OBJECT_ID("main_object");
-    return MY_OBJECT_ID;
-  }
-  /// attribute name of tool object
-  inline static const std::string& TOOL_ID()
-  {
-    static const std::string MY_TOOL_ID("tool_object");
-    return MY_TOOL_ID;
-  }
-  /// attribute name of operation type
-  inline static const std::string& TYPE_ID()
-  {
-    static const std::string MY_TYPE_ID("bool_type");
-    return MY_TYPE_ID;
-  }
-
-  enum {
-       BOOL_CUT,
-       BOOL_FUSE,
-    BOOL_COMMON
+public:
+  enum OperationType {
+    BOOL_CUT,
+    BOOL_FUSE,
+    BOOL_COMMON,
+    BOOL_FILL,
+    BOOL_SMASH
   };
 
+  /// Attribute name of main objects.
+  inline static const std::string& OBJECT_LIST_ID()
+  {
+    static const std::string MY_OBJECT_LIST_ID("main_objects");
+    return MY_OBJECT_LIST_ID;
+  }
 
-  /// Returns the kind of a feature
-  FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
+  /// Attribute name of tool objects.
+  inline static const std::string& TOOL_LIST_ID()
   {
-    static std::string MY_KIND = FeaturesPlugin_Boolean::ID();
-    return MY_KIND;
+    static const std::string MY_TOOL_LIST_ID("tool_objects");
+    return MY_TOOL_LIST_ID;
   }
 
-  /// Creates a new part document if needed
+  /// \return boolean operation type.
+  FEATURESPLUGIN_EXPORT OperationType operationType();
+
+  /// Creates a new part document if needed.
   FEATURESPLUGIN_EXPORT virtual void execute();
 
-  /// Request for initialization of data model of the feature: adding all attributes
+  /// 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:
+
+  /// Use plugin manager for features creation.
+  FeaturesPlugin_Boolean(const OperationType theOperationType);
 
 private:
   std::shared_ptr<GeomAPI_Shape> getShape(const std::string& theAttrName);
-  
+
   /// Load Naming data structure of the feature to the document
-  void LoadNamingDS(GeomAlgoAPI_Boolean* theFeature, 
-                                       std::shared_ptr<ModelAPI_ResultBody> theResultBody,
-                       std::shared_ptr<GeomAPI_Shape> theObject,
-                       std::shared_ptr<GeomAPI_Shape> theTool,
-                                       int theType);
+  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 bool theIsStoreAsGenerated = false);
+
+private:
+  OperationType myOperationType;
 };
 
 #endif