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 "SketchPlugin_Sketch.h"
  11
  12 #include <GeomAPI_IPresentable.h>
  13 #include <list>
  14
  15 /** \class SketchPlugin_ConstraintDistance
  16  *  \ingroup DataModel
  17  *  \brief Feature for creation of a new constraint which defines a distance
  18  *         between a point and another feature (point, line, plane or face)
  19  *
  20  *  These constraint has three attributes:
  21  *  SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  22  */
  23 class SketchPlugin_ConstraintDistance: public SketchPlugin_Constraint,
  24                                        public GeomAPI_IPresentable
  25 {
  26 public:
  27   /// Distance constraint kind
  28   inline static const std::string& ID()
  29   {
  30     static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistance");
  31     return MY_CONSTRAINT_DISTANCE_ID;
  32   }
  33
  34   /// \brief Returns the kind of a feature
  35   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  36   {static std::string MY_KIND = SketchPlugin_ConstraintDistance::ID(); return MY_KIND;}
  37
  38   /// \brief Creates a new part document if needed
  39   SKETCHPLUGIN_EXPORT virtual void execute();
  40
  41   /// \brief Request for initialization of data model of the feature: adding all attributes
  42   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  43
  44   /// Returns the AIS preview
  45   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  46                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  47
  48   /// Moves the feature
  49   /// \param theDeltaX the delta for X coordinate is moved
  50   /// \param theDeltaY the delta for Y coordinate is moved
  51   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  52
  53   /// \brief Use plugin manager for features creation
  54   SketchPlugin_ConstraintDistance();
  55 };
  56
  57 #endif