src/SketchPlugin/SketchPlugin_Point.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:    SketchPlugin_Point.h
   4 // Created: 07 May 2014
   5 // Author:  Artem ZHIDKOV
   6
   7 #ifndef SketchPlugin_Point_H_
   8 #define SketchPlugin_Point_H_
   9
  10 #include "SketchPlugin.h"
  11 #include <SketchPlugin_Sketch.h>
  12 #include "SketchPlugin_SketchEntity.h"
  13 #include <list>
  14
  15 /**\class SketchPlugin_Point
  16  * \ingroup Plugins
  17  * \brief Feature for creation of a new point.
  18  */
  19 class SketchPlugin_Point : public SketchPlugin_SketchEntity
  20 {
  21  public:
  22   /// Point feature kind
  23   inline static const std::string& ID()
  24   {
  25     static const std::string MY_POINT_ID("SketchPoint");
  26     return MY_POINT_ID;
  27   }
  28   /// Coordinates of the point
  29   inline static const std::string& COORD_ID()
  30   {
  31     static const std::string MY_COORD_ID("PointCoordindates");
  32     return MY_COORD_ID;
  33   }
  34   /// Coordinates of the point
  35   inline static const std::string& TABLE_ID()
  36   {
  37     static const std::string MY_TABLE_ID("TableValue");
  38     return MY_TABLE_ID;
  39   }
  40
  41   /// Returns the kind of a feature
  42   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  43   {
  44     static std::string MY_KIND = SketchPlugin_Point::ID();
  45     return MY_KIND;
  46   }
  47
  48   /// Returns true is sketch element is under the rigid constraint
  49   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  50
  51   /// Creates a new part document if needed
  52   SKETCHPLUGIN_EXPORT virtual void execute();
  53
  54   /// Request for initialization of data model of the feature: adding all attributes
  55   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  56
  57   /// Moves the feature
  58   /// \param theDeltaX the delta for X coordinate is moved
  59   /// \param theDeltaY the delta for Y coordinate is moved
  60   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  61
  62   /// Called on change of any argument-attribute of this object: for external point
  63   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  64
  65   /// Use plugin manager for features creation
  66   SketchPlugin_Point();
  67 };
  68
  69 #endif