Salome HOME
Improvement #635: Move maximum functionality to API class
[modules/shaper.git] / src / FeaturesPlugin / FeaturesPlugin_Boolean.h
index 824dcd0dbb5dd787032974c50c93f6c0b95dde69..df9065b25fcc609de4bf909427f3af470e279f79 100644 (file)
@@ -9,12 +9,21 @@
 
 #include "FeaturesPlugin.h"
 #include <ModelAPI_Feature.h>
-#include <GeomAPI_Shape.h>
+
 #include <GeomAlgoAPI_Boolean.h>
 
+class GeomAlgoAPI_MakeShapeList;
+
+/**\class FeaturesPlugin_Boolean
+ * \ingroup Plugins
+ * \brief Feature for applying of Boolean operations on Solids.
+ *
+ * Supports three kinds of Boolean operations: Cut, Fuse and Common.
+ * For all of them requires two Solids: object and tool.
+ */
 class FeaturesPlugin_Boolean : public ModelAPI_Feature
 {
- public:
+public:
   /// Extrusion kind
   inline static const std::string& ID()
   {
@@ -22,6 +31,12 @@ class FeaturesPlugin_Boolean : public ModelAPI_Feature
     return MY_ID;
   }
   /// attribute name of referenced object
+  inline static const std::string& OBJECT_LIST_ID()
+  {
+    static const std::string MY_OBJECT_LIST_ID("main_objects");
+    return MY_OBJECT_LIST_ID;
+  }
+  /// attribute name of referenced object
   inline static const std::string& OBJECT_ID()
   {
     static const std::string MY_OBJECT_ID("main_object");
@@ -33,6 +48,12 @@ class FeaturesPlugin_Boolean : public ModelAPI_Feature
     static const std::string MY_TOOL_ID("tool_object");
     return MY_TOOL_ID;
   }
+  /// attribute name of tool object
+  inline static const std::string& TOOL_LIST_ID()
+  {
+    static const std::string MY_TOOL_LIST_ID("tool_objects");
+    return MY_TOOL_LIST_ID;
+  }
   /// attribute name of operation type
   inline static const std::string& TYPE_ID()
   {
@@ -41,12 +62,11 @@ class FeaturesPlugin_Boolean : public ModelAPI_Feature
   }
 
   enum {
-       BOOL_CUT,
-       BOOL_FUSE,
+    BOOL_CUT,
+    BOOL_FUSE,
     BOOL_COMMON
   };
 
-
   /// Returns the kind of a feature
   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
   {
@@ -65,13 +85,12 @@ class FeaturesPlugin_Boolean : public ModelAPI_Feature
 
 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>& theBaseObject,
+                    const ListOfShape& theTools,
+                    const GeomAlgoAPI_Boolean& theAlgo);
 };
 
 #endif