src/SketchPlugin/SketchPlugin_ConstraintLength.h

   1 // File:    SketchPlugin_ConstraintLength.h
   2 // Created: 30 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_ConstraintLength_HeaderFile
   6 #define SketchPlugin_ConstraintLength_HeaderFile
   7
   8 #include "SketchPlugin.h"
   9 #include "SketchPlugin_Constraint.h"
  10 #include <SketchPlugin_Sketch.h>
  11 #include <list>
  12
  13 /// Length constraint kind
  14 const std::string SKETCH_CONSTRAINT_LENGTH_KIND("SketchConstraintLength");
  15
  16 /** \class SketchPlugin_ConstraintLength
  17  *  \ingroup DataModel
  18  *  \brief Feature for creation of a new constraint which defines a length of a line segment
  19  *
  20  *  These constraint has two attributes:
  21  *  CONSTRAINT_ATTR_VALUE (length) and CONSTRAINT_ATTR_ENTITY_A (segment)
  22  */
  23 class SketchPlugin_ConstraintLength: 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_LENGTH_KIND; return MY_KIND;}
  29
  30   /// \brief Returns to which group in the document must be added feature
  31   SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
  32   {static std::string MY_GROUP = SKETCH_KIND; return MY_GROUP;}
  33
  34   /// \brief Creates a new part document if needed
  35   SKETCHPLUGIN_EXPORT virtual void execute();
  36
  37   /// \brief Request for initialization of data model of the feature: adding all attributes
  38   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  39
  40   /// \brief Returns the sketch preview
  41   SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
  42
  43   /// \brief Use plugin manager for features creation
  44   SketchPlugin_ConstraintLength();
  45 };
  46
  47 #endif