src/SketchPlugin/SketchPlugin_Feature.h

   1 // File:        SketchPlugin_Feature.h
   2 // Created:     27 Mar 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef SketchPlugin_Feature_HeaderFile
   6 #define SketchPlugin_Feature_HeaderFile
   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 boost::shared_ptr<GeomAPI_AISObject> simpleAISObject(
  28     boost::shared_ptr<ModelAPI_Result> theRes, boost::shared_ptr<GeomAPI_AISObject> 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(
  33     const FeaturePtr& theFeature) {};
  34
  35   /// Returns true if this feature must be displayed in the history (top level of Part tree)
  36   SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return false;}
  37
  38   /// Moves the feature
  39   /// \param theDeltaX the delta for X coordinate is moved
  40   /// \param theDeltaY the delta for Y coordinate is moved
  41   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY) = 0;
  42
  43   /// Return the distance between the feature and the point
  44   /// \param thePoint the point
  45   virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) = 0;
  46
  47 protected:
  48   /// Sets the higher-level feature for the sub-feature (sketch for line)
  49   void setSketch(SketchPlugin_Sketch* theSketch) {mySketch = theSketch;}
  50   /// Returns the sketch of this feature
  51   SketchPlugin_Sketch* sketch();
  52   /// initializes mySketch
  53   SketchPlugin_Feature();
  54
  55   friend class SketchPlugin_Sketch;
  56
  57 private:
  58   boost::shared_ptr<GeomAPI_Shape> myPreview; ///< the preview shape
  59   SketchPlugin_Sketch* mySketch; /// sketch that contains this feature
  60 };
  61
  62 #endif