src/SketchPlugin/SketchPlugin_Point.h

   1 // File:    SketchPlugin_Point.h
   2 // Created: 07 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_Point_HeaderFile
   6 #define SketchPlugin_Point_HeaderFile
   7
   8 #include "SketchPlugin.h"
   9 #include <SketchPlugin_Sketch.h>
  10 #include "SketchPlugin_Feature.h"
  11 #include <list>
  12
  13 /// Point feature kind
  14 const std::string SKETCH_POINT_KIND("SketchPoint");
  15
  16 /// Coordinates of the point
  17 const std::string POINT_ATTR_COORD("PointCoordindates");
  18
  19 /**\class SketchPlugin_Point
  20  * \ingroup DataModel
  21  * \brief Feature for creation of a new point.
  22  */
  23 class SketchPlugin_Point: public SketchPlugin_Feature
  24 {
  25 public:
  26   /// Returns the kind of a feature
  27   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  28   {static std::string MY_KIND = SKETCH_POINT_KIND; return MY_KIND;}
  29
  30   /// Returns to which group in the document must be added feature
  31   SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
  32   {static std::string MY_GROUP = SKETCH_KIND; return MY_GROUP;}
  33
  34   /// Creates a new part document if needed
  35   SKETCHPLUGIN_EXPORT virtual void execute();
  36
  37   /// Request for initialization of data model of the feature: adding all attributes
  38   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  39
  40   /// Returns the sketch preview
  41   SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
  42
  43   /// Returns the AIS preview
  44   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  45                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  46
  47   /// Adds sub-feature of the higher level feature (sub-element of the sketch)
  48   /// \param theFeature sub-feature
  49   SKETCHPLUGIN_EXPORT virtual const void addSub(
  50     const FeaturePtr& theFeature) {};
  51
  52   /// Moves the feature
  53   /// \param theDeltaX the delta for X coordinate is moved
  54   /// \param theDeltaY the delta for Y coordinate is moved
  55   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  56
  57   /// Return the distance between the feature and the point
  58   /// \param thePoint the point
  59   virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  60
  61   /// Use plugin manager for features creation
  62   SketchPlugin_Point();
  63 };
  64
  65 #endif