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_Sketch.h>
  10 #include "SketchPlugin_Constraint.h"
  11
  12 /// Radius constraint kind
  13 const std::string SKETCH_CONSTRAINT_RADIUS_KIND("SketchConstraintRadius");
  14
  15 /** \class SketchPlugin_ConstraintRadius
  16  *  \ingroup DataModel
  17  *  \brief Feature for creation of a new constraint which defines
  18  *         a radius of a circle or an arc of circle
  19  *
  20  *  These constraint has two attributes:
  21  *  CONSTRAINT_ATTR_VALUE (radius), CONSTRAINT_ATTR_ENTITY_A (a circle)
  22  */
  23 class SketchPlugin_ConstraintRadius: public SketchPlugin_Constraint
  24 {
  25 public:
  26   /// \brief Returns the kind of a feature
  27   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  28   {static std::string MY_KIND = SKETCH_CONSTRAINT_RADIUS_KIND; return MY_KIND;}
  29
  30   /// \brief Creates a new part document if needed
  31   SKETCHPLUGIN_EXPORT virtual void execute(boost::shared_ptr<ModelAPI_Result>& theResult);
  32
  33   /// \brief Request for initialization of data model of the feature: adding all attributes
  34   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  35
  36   /// Returns the AIS preview
  37   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  38                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  39
  40   /// Moves the feature
  41   /// \param theDeltaX the delta for X coordinate is moved
  42   /// \param theDeltaY the delta for Y coordinate is moved
  43   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  44
  45   /// \brief Use plugin manager for features creation
  46   SketchPlugin_ConstraintRadius();
  47 };
  48
  49 #endif