src/SketchPlugin/SketchPlugin_ConstraintPerpendicular.h

   1 // File:    SketchPlugin_ConstraintPerpendicular.h
   2 // Created: 26 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_ConstraintPerpendicular_H_
   6 #define SketchPlugin_ConstraintPerpendicular_H_
   7
   8 #include "SketchPlugin.h"
   9 #include <SketchPlugin_Sketch.h>
  10 #include "SketchPlugin_Constraint.h"
  11
  12 #define PERPENDICULAR_COLOR "255, 255, 0"
  13
  14 /** \class SketchPlugin_ConstraintPerpendicular
  15  *  \ingroup DataModel
  16  *  \brief Feature for creation of a new constraint for perpendicularity of two lines
  17  *
  18  *  These constraint has two attributes:
  19  *  SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  20  */
  21 class SketchPlugin_ConstraintPerpendicular: public SketchPlugin_Constraint
  22 {
  23 public:
  24   /// Perpendicular constraint kind
  25   inline static const std::string& ID()
  26   {
  27     static const std::string MY_CONSTRAINT_PERPENDICULAR_ID("SketchConstraintPerpendicular");
  28     return MY_CONSTRAINT_PERPENDICULAR_ID;
  29   }
  30   /// \brief Returns the kind of a feature
  31   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  32   {static std::string MY_KIND = SketchPlugin_ConstraintPerpendicular::ID(); return MY_KIND;}
  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   /// Returns the AIS preview
  41   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  42                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  43
  44   /// Moves the feature
  45   /// \param theDeltaX the delta for X coordinate is moved
  46   /// \param theDeltaY the delta for Y coordinate is moved
  47   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  48
  49   /// \brief Use plugin manager for features creation
  50   SketchPlugin_ConstraintPerpendicular();
  51 };
  52
  53 #endif