src/SketchPlugin/SketchPlugin_ConstraintDistance.h

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