Union of validator and filter functionalities.

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

diff --git a/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h b/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h
index c6c500fe211a9caaab4ddbd2f1b6852f9a81db32..2150ce72023c8a72023a77e4775e6b52b0387122 100644 (file)
--- a/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h
+++ b/src/FeaturesPlugin/FeaturesPlugin_Extrusion.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        FeaturesPlugin_Extrusion.h
 // Created:     30 May 2014
 // Author:      Vitaly SMETANNIKOV
@@ -10,6 +12,15 @@
 #include <ModelAPI_ResultBody.h>
 #include <GeomAlgoAPI_Extrusion.h>
 #include <GeomAPI_Shape.h>
+
+/**\class FeaturesPlugin_Extrusion
+ * \ingroup Plugins
+ * \brief Feature for creation of extrusion from the planar face.
+ *
+ * Extrusion creates the lateral faces based on edges of the base face and
+ * the top face equal to the base face. Direction of extrusion is taken from the face
+ * plane, but can be corrected by the "reverse" flag.
+ */
 class FeaturesPlugin_Extrusion : public ModelAPI_Feature
 {
  public:
@@ -19,22 +30,24 @@ class FeaturesPlugin_Extrusion : public ModelAPI_Feature
     static const std::string MY_EXTRUSION_ID("Extrusion");
     return MY_EXTRUSION_ID;
   }
-  /// attribute name of referenced face
-  inline static const std::string& FACE_ID()
+  /// attribute name of references sketch entities list, it should contain a sketch result or
+  /// a pair a sketch result to sketch face
+  inline static const std::string& LIST_ID()
   {
-    static const std::string MY_FACE_ID("extrusion_face");
-    return MY_FACE_ID;
+    static const std::string MY_GROUP_LIST_ID("base");
+    return MY_GROUP_LIST_ID;
   }
+
   /// attribute name of extrusion size
   inline static const std::string& SIZE_ID()
   {
-    static const std::string MY_SIZE_ID("extrusion_size");
+    static const std::string MY_SIZE_ID("size");
     return MY_SIZE_ID;
   }
   /// attribute name of reverse direction
   inline static const std::string& REVERSE_ID()
   {
-    static const std::string MY_REVERSE_ID("extrusion_reverse");
+    static const std::string MY_REVERSE_ID("reverse");
     return MY_REVERSE_ID;
   }
 
@@ -53,11 +66,14 @@ class FeaturesPlugin_Extrusion : public ModelAPI_Feature
 
   /// Use plugin manager for features creation
   FeaturesPlugin_Extrusion();
-
+private:
   /// Load Naming data structure of the feature to the document
-  void LoadNamingDS(GeomAlgoAPI_Extrusion& theFeature, boost::shared_ptr<ModelAPI_ResultBody> theResultBody,
-                       boost::shared_ptr<GeomAPI_Shape> theBasis,
-                       boost::shared_ptr<GeomAPI_Shape> theContext);
+  void LoadNamingDS(GeomAlgoAPI_Extrusion& theFeature, std::shared_ptr<ModelAPI_ResultBody> theResultBody,
+                       std::shared_ptr<GeomAPI_Shape> theBasis,
+                       std::shared_ptr<GeomAPI_Shape> theContext);
+
+  /// Set an empty shape to the result of extrusion
+  void clearResult();
 };
 
 #endif