Salome HOME
"Internal" feature XML procesing. Fixes #40
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Feature.h
index 4b91631c9ed43e799a43ae00cf83959c8ffa2f5a..db6a6d6607aff088a251a6e4f6e43fb30d71b82e 100644 (file)
@@ -7,23 +7,50 @@
 
 #include "SketchPlugin.h"
 #include <ModelAPI_Feature.h>
+#include <GeomAPI_Shape.h>
 
-#include "TopoDS_Shape.hxx"
+class SketchPlugin_Sketch;
 
 /**\class SketchPlugin_Feature
  * \ingroup DataModel
- * \brief Feature for creation of the new part in PartSet.
+ * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
+ * an interface to create the sketch feature preview.
  */
 class SketchPlugin_Feature: public ModelAPI_Feature
 {
 public:
- SKETCHPLUGIN_EXPORT virtual const TopoDS_Shape& preview() = 0;
+  /// Returns the sketch preview
+  /// \param theSketch the owner of this feature
+  /// \return the built preview
+  SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview() = 0;
+
+  /// 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) = 0;
+
+  /// Returns true if this feature must be displayed in the history (top level of Part tree)
+  SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return false;}
 
 protected:
-  void setPreview(const TopoDS_Shape& theShape); ///< the preview shape
+  /// Set the shape to the internal preview field
+  /// \param theShape a preview shape
+  void setPreview(const boost::shared_ptr<GeomAPI_Shape>& theShape); ///< the preview shape
+  /// Return the shape from the internal preview field
+  /// \return theShape a preview shape
+  const boost::shared_ptr<GeomAPI_Shape>& getPreview() const;
+  /// Sets the higher-level feature for the sub-feature (sketch for line)
+  void setSketch(SketchPlugin_Sketch* theSketch) {mySketch = theSketch;}
+  /// Returns the sketch of this feature
+  SketchPlugin_Sketch* sketch();
+  /// initializes mySketch
+  SketchPlugin_Feature();
+
+  friend class SketchPlugin_Sketch;
 
 private:
-  TopoDS_Shape myPreview; ///< the preview shape
+  boost::shared_ptr<GeomAPI_Shape> myPreview; ///< the preview shape
+  SketchPlugin_Sketch* mySketch; /// sketch that contains this feature
 };
 
 #endif