src/SketchPlugin/SketchPlugin_Circle.h

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