src/SketchPlugin/SketchPlugin_ConstraintPerpendicular.h

   1 // File:    SketchPlugin_ConstraintPerpendicular.h
   2 // Created: 26 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_ConstraintPerpendicular_HeaderFile
   6 #define SketchPlugin_ConstraintPerpendicular_HeaderFile
   7
   8 #include "SketchPlugin.h"
   9 #include <SketchPlugin_Sketch.h>
  10 #include "SketchPlugin_Constraint.h"
  11
  12 /** \class SketchPlugin_ConstraintPerpendicular
  13  *  \ingroup DataModel
  14  *  \brief Feature for creation of a new constraint for perpendicularity of two lines
  15  *
  16  *  These constraint has two attributes:
  17  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  18  */
  19 class SketchPlugin_ConstraintPerpendicular: public SketchPlugin_Constraint
  20 {
  21 public:
  22   /// Perpendicular constraint kind
  23   inline static const std::string& ID()
  24   {
  25     static const std::string MY_CONSTRAINT_PERPENDICULAR_ID("SketchConstraintPerpendicular");
  26     return MY_CONSTRAINT_PERPENDICULAR_ID;
  27   }
  28   /// \brief Returns the kind of a feature
  29   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  30   {static std::string MY_KIND = SketchPlugin_ConstraintPerpendicular::ID(); return MY_KIND;}
  31
  32   /// \brief Returns to which group in the document must be added feature
  33   SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
  34   {static std::string MY_GROUP = SketchPlugin_Sketch::ID(); return MY_GROUP;}
  35
  36   /// \brief Creates a new part document if needed
  37   SKETCHPLUGIN_EXPORT virtual void execute();
  38
  39   /// \brief Request for initialization of data model of the feature: adding all attributes
  40   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  41
  42   /// \brief Returns the sketch preview
  43   SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
  44
  45   /// Returns the AIS preview
  46   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  47                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  48
  49   /// Moves the feature
  50   /// \param theDeltaX the delta for X coordinate is moved
  51   /// \param theDeltaY the delta for Y coordinate is moved
  52   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  53
  54   /// \brief Use plugin manager for features creation
  55   SketchPlugin_ConstraintPerpendicular();
  56 };
  57
  58 #endif