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   /// Creates a new part document if needed
  31   SKETCHPLUGIN_EXPORT virtual void execute();
  32
  33   /// Request for initialization of data model of the feature: adding all attributes
  34   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  35
  36   /// Returns the AIS preview
  37   virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  38                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious)
  39   {return simpleAISObject(firstResult(), thePrevious);}
  40
  41   /// Moves the feature
  42   /// \param theDeltaX the delta for X coordinate is moved
  43   /// \param theDeltaY the delta for Y coordinate is moved
  44   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  45
  46   /// Return the distance between the feature and the point
  47   /// \param thePoint the point
  48   virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  49
  50   /// Use plugin manager for features creation
  51   SketchPlugin_Point();
  52 };
  53
  54 #endif