Salome HOME
Init feature by model widget factory content
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Sketch.h
index 0fc24fb11ed0bea2f9b5f91501a7da4194ad3c0a..8337c8d2478d18a9c13fc1524373753eb4cdf405 100644 (file)
@@ -10,6 +10,9 @@
 #include <GeomAPI_Pnt.h>
 #include <list>
 
+/// Sketch feature kind
+const std::string SKETCH_KIND("Sketch");
+
 /// Origin point of the sketcher in 3D space
 const std::string SKETCH_ATTR_ORIGIN("Origin");
 /// Vector X inside of the sketch plane
@@ -18,6 +21,8 @@ const std::string SKETCH_ATTR_DIRX("DirX");
 const std::string SKETCH_ATTR_DIRY("DirY");
 /// Vector Z, normal to the sketch plane
 const std::string SKETCH_ATTR_NORM("Norm");
+/// All features of this sketch (list of references)
+const std::string SKETCH_ATTR_FEATURES("Features");
 
 /**\class SketchPlugin_Sketch
  * \ingroup DataModel
@@ -27,18 +32,18 @@ class SketchPlugin_Sketch: public SketchPlugin_Feature
 {
 public:
   /// Returns the kind of a feature
- SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = "Sketch"; return MY_KIND;}
 SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
+  {static std::string MY_KIND = SKETCH_KIND; return MY_KIND;}
 
   /// Returns to which group in the document must be added feature
- SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() 
 SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() 
   {static std::string MY_GROUP = "Construction"; return MY_GROUP;}
 
   /// Creates a new part document if needed
- SKETCHPLUGIN_EXPORT virtual void execute();
 SKETCHPLUGIN_EXPORT virtual void execute();
 
   /// Request for initialization of data model of the feature: adding all attributes
- SKETCHPLUGIN_EXPORT virtual void initAttributes();
 SKETCHPLUGIN_EXPORT virtual void initAttributes();
 
   /// Returns the sketch preview
   SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
@@ -46,12 +51,15 @@ public:
   /// Adds sub-feature of the higher level feature (sub-element of the sketch)
   /// \param theFeature sub-feature
   SKETCHPLUGIN_EXPORT virtual const void addSub(
-    const boost::shared_ptr<ModelAPI_Feature>& theFeature);
+    const FeaturePtr& theFeature);
 
   /// Converts a 2D sketch space point into point in 3D space
   SKETCHPLUGIN_EXPORT boost::shared_ptr<GeomAPI_Pnt> to3D(
     const double theX, const double theY);
 
+  /// Returns true if this feature must be displayed in the history (top level of Part tree)
+  SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return true;}
+
   /// Use plugin manager for features creation
   SketchPlugin_Sketch();
 protected:
@@ -62,6 +70,10 @@ protected:
   /// \param theShapes the list of result shapes
   void addPlane(double theX, double theY, double theZ,
                 std::list<boost::shared_ptr<GeomAPI_Shape> >& theShapes) const;
+
+  /// Checks whether the plane is set in the sketch.
+  /// \returns the boolean state
+  bool isPlaneSet();
 };
 
 #endif