Salome HOME
Merge branch 'master' of newgeom:newgeom.git
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Feature.h
1 // File:        SketchPlugin_Feature.h
2 // Created:     27 Mar 2014
3 // Author:      Mikhail PONIKAROV
4
5 #ifndef SketchPlugin_Feature_H_
6 #define SketchPlugin_Feature_H_
7
8 #include "SketchPlugin.h"
9 #include <ModelAPI_Feature.h>
10 #include <GeomAPI_Shape.h>
11 #include <GeomAPI_AISObject.h>
12 #include <ModelAPI_Document.h>
13
14 class SketchPlugin_Sketch;
15 class GeomAPI_Pnt2d;
16 class Handle_AIS_InteractiveObject;
17
18 /**\class SketchPlugin_Feature
19  * \ingroup DataModel
20  * \brief Feature for creation of the new feature in PartSet. This is an abstract class to give
21  * an interface to create the sketch feature preview.
22  */
23 class SketchPlugin_Feature : public ModelAPI_Feature
24 {
25  public:
26   /// Simple creation of interactive object by the result of the object
27   static AISObjectPtr simpleAISObject(boost::shared_ptr<ModelAPI_Result> theRes,
28                                       AISObjectPtr thePrevious);
29
30   /// Adds sub-feature of the higher level feature (sub-element of the sketch)
31   /// \param theFeature sub-feature
32   SKETCHPLUGIN_EXPORT virtual const void addSub(const FeaturePtr& theFeature)
33   {
34   }
35   ;
36
37   /// Returns true if this feature must be displayed in the history (top level of Part tree)
38   SKETCHPLUGIN_EXPORT virtual bool isInHistory()
39   {
40     return false;
41   }
42
43   /// Moves the feature
44   /// \param theDeltaX the delta for X coordinate is moved
45   /// \param theDeltaY the delta for Y coordinate is moved
46   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) = 0;
47
48   /// Return the distance between the feature and the point
49   /// \param thePoint the point
50   virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
51
52  protected:
53   /// Sets the higher-level feature for the sub-feature (sketch for line)
54   void setSketch(SketchPlugin_Sketch* theSketch)
55   {
56     mySketch = theSketch;
57   }
58   /// Returns the sketch of this feature
59   SketchPlugin_Sketch* sketch();
60   /// initializes mySketch
61   SketchPlugin_Feature();
62
63   friend class SketchPlugin_Sketch;
64
65  private:
66   boost::shared_ptr<GeomAPI_Shape> myPreview;  ///< the preview shape
67   SketchPlugin_Sketch* mySketch;  /// sketch that contains this feature
68 };
69
70 #endif