src/SketchPlugin/SketchPlugin_Circle.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        SketchPlugin_Circle.h
   4 // Created:     26 May 2014
   5 // Author:      Artem ZHIDKOV
   6
   7 #ifndef SketchPlugin_Circle_H_
   8 #define SketchPlugin_Circle_H_
   9
  10 #include "SketchPlugin.h"
  11 #include <SketchPlugin_SketchEntity.h>
  12 #include <SketchPlugin_Sketch.h>
  13 #include <GeomAPI_IPresentable.h>
  14
  15 /**\class SketchPlugin_Circle
  16  * \ingroup Plugins
  17  * \brief Feature for creation of the new circle in PartSet.
  18  */
  19 class SketchPlugin_Circle : public SketchPlugin_SketchEntity, public GeomAPI_IPresentable
  20 {
  21  public:
  22   /// Circle feature kind
  23   inline static const std::string& ID()
  24   {
  25     static const std::string MY_CIRCLE_ID("SketchCircle");
  26     return MY_CIRCLE_ID;
  27   }
  28
  29   inline static const std::string& CIRCLE_TYPE()
  30   {
  31     static const std::string TYPE("CircleType");
  32     return TYPE;
  33   }
  34
  35   /// 2D point - center of the circle
  36   inline static const std::string& CENTER_ID()
  37   {
  38     static const std::string MY_CIRCLE_CENTER_ID("CircleCenter");
  39     return MY_CIRCLE_CENTER_ID;
  40   }
  41
  42   /// Radius of the circle
  43   inline static const std::string& RADIUS_ID()
  44   {
  45     static const std::string MY_CIRCLE_RADIUS_ID("CircleRadius");
  46     return MY_CIRCLE_RADIUS_ID;
  47   }
  48
  49   /// Returns the kind of a feature
  50   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  51   {
  52     static std::string MY_KIND = SketchPlugin_Circle::ID();
  53     return MY_KIND;
  54   }
  55
  56   /// Returns true is sketch element is under the rigid constraint
  57   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  58
  59   /// Creates a new part document if needed
  60   SKETCHPLUGIN_EXPORT virtual void execute();
  61
  62   /// Adds sub-feature of the higher level feature (sub-element of the sketch)
  63   /// \param theFeature sub-feature
  64   SKETCHPLUGIN_EXPORT virtual const void addSub(const FeaturePtr& theFeature)
  65   {
  66   }
  67
  68   /// Moves the feature
  69   /// \param theDeltaX the delta for X coordinate is moved
  70   /// \param theDeltaY the delta for Y coordinate is moved
  71   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  72
  73   /// Called on change of any argument-attribute of this object
  74   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  75
  76   /// Returns the AIS preview
  77   virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  78
  79   /// Use plugin manager for features creation
  80   SketchPlugin_Circle();
  81
  82 protected:
  83   /// \brief Initializes attributes of derived class.
  84   virtual void initDerivedClassAttributes();
  85
  86 private:
  87   /// Returns true if all obligatory attributes are initialized
  88   bool isFeatureValid();
  89
  90   /// Update coordinates of representation by three points
  91   void adjustThreePoints();
  92 };
  93
  94 #endif