src/SketchPlugin/SketchPlugin_ConstraintRadius.h

   1 // File:    SketchPlugin_ConstraintRadius.h
   2 // Created: 26 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_ConstraintRadius_HeaderFile
   6 #define SketchPlugin_ConstraintRadius_HeaderFile
   7
   8 #include "SketchPlugin.h"
   9 #include "SketchPlugin_Constraint.h"
  10
  11
  12 /** \class SketchPlugin_ConstraintRadius
  13  *  \ingroup DataModel
  14  *  \brief Feature for creation of a new constraint which defines
  15  *         a radius of a circle or an arc of circle
  16  *
  17  *  These constraint has two attributes:
  18  *  CONSTRAINT_ATTR_VALUE (radius), CONSTRAINT_ATTR_ENTITY_A (a circle)
  19  */
  20 class SketchPlugin_ConstraintRadius: public SketchPlugin_Constraint
  21 {
  22 public:
  23   /// \brief Returns the kind of a feature
  24   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  25   {static std::string MY_KIND = "SketchConstraintRadius"; return MY_KIND;}
  26
  27   /// \brief Returns to which group in the document must be added feature
  28   SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
  29   {static std::string MY_GROUP = "Sketch"; return MY_GROUP;}
  30
  31   /// \brief Creates a new part document if needed
  32   SKETCHPLUGIN_EXPORT virtual void execute();
  33
  34   /// \brief Request for initialization of data model of the feature: adding all attributes
  35   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  36
  37   /// \brief Returns the sketch preview
  38   SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
  39
  40   /// \brief Use plugin manager for features creation
  41   SketchPlugin_ConstraintRadius();
  42 };
  43
  44 #endif