1 // File: SketchPlugin_Feature.h
2 // Created: 27 Mar 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef SketchPlugin_Feature_HeaderFile
6 #define SketchPlugin_Feature_HeaderFile
8 #include "SketchPlugin.h"
9 #include <ModelAPI_Feature.h>
10 #include <GeomAPI_Shape.h>
12 class SketchPlugin_Sketch;
14 /**\class SketchPlugin_Feature
16 * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
17 * an interface to create the sketch feature preview.
19 class SketchPlugin_Feature: public ModelAPI_Feature
22 /// Returns the sketch preview
23 /// \param theSketch the owner of this feature
24 /// \return the built preview
25 SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview() = 0;
27 /// Adds sub-feature of the higher level feature (sub-element of the sketch)
28 /// \param theFeature sub-feature
29 SKETCHPLUGIN_EXPORT virtual const void addSub(
30 const FeaturePtr& theFeature) = 0;
32 /// Returns true if this feature must be displayed in the history (top level of Part tree)
33 SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return false;}
36 /// \param theDeltaX the delta for X coordinate is moved
37 /// \param theDeltaY the delta for Y coordinate is moved
38 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) = 0;
41 /// Set the shape to the internal preview field
42 /// \param theShape a preview shape
43 void setPreview(const boost::shared_ptr<GeomAPI_Shape>& theShape); ///< the preview shape
44 /// Return the shape from the internal preview field
45 /// \return theShape a preview shape
46 const boost::shared_ptr<GeomAPI_Shape>& getPreview() const;
47 /// Sets the higher-level feature for the sub-feature (sketch for line)
48 void setSketch(SketchPlugin_Sketch* theSketch) {mySketch = theSketch;}
49 /// Returns the sketch of this feature
50 SketchPlugin_Sketch* sketch();
51 /// initializes mySketch
52 SketchPlugin_Feature();
54 friend class SketchPlugin_Sketch;
57 boost::shared_ptr<GeomAPI_Shape> myPreview; ///< the preview shape
58 SketchPlugin_Sketch* mySketch; /// sketch that contains this feature