src/SketchPlugin/SketchPlugin_Point.h

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