src/SketchPlugin/SketchPlugin_ConstraintLength.h

   1 // File:    SketchPlugin_ConstraintLength.h
   2 // Created: 30 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_ConstraintLength_H_
   6 #define SketchPlugin_ConstraintLength_H_
   7
   8 #include "SketchPlugin.h"
   9 #include "SketchPlugin_ConstraintBase.h"
  10 #include <SketchPlugin_Sketch.h>
  11 #include <list>
  12
  13 class GeomDataAPI_Point2D;
  14
  15 #define LENGTH_COLOR "#ff00ff"
  16
  17 /** \class SketchPlugin_ConstraintLength
  18  *  \ingroup DataModel
  19  *  \brief Feature for creation of a new constraint which defines a length of a line segment
  20  *
  21  *  This constraint has two attributes:
  22  *  SketchPlugin_Constraint::VALUE() (length) and SketchPlugin_Constraint::ENTITY_A() (segment),
  23  *  SketchPlugin_Constraint::FLYOUT_VALUE_PNT() (distance of a constraints handle)
  24  */
  25 class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
  26 {
  27  public:
  28   /// Length constraint kind
  29   inline static const std::string& ID()
  30   {
  31     static const std::string MY_CONSTRAINT_LENGTH_ID("SketchConstraintLength");
  32     return MY_CONSTRAINT_LENGTH_ID;
  33   }
  34   /// \brief Returns the kind of a feature
  35   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  36   {
  37     static std::string MY_KIND = SketchPlugin_ConstraintLength::ID();
  38     return MY_KIND;
  39   }
  40
  41   /// \brief Creates a new part document if needed
  42   SKETCHPLUGIN_EXPORT virtual void execute();
  43
  44   /// \brief Request for initialization of data model of the feature: adding all attributes
  45   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  46
  47   /// Returns the AIS preview
  48   SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
  49
  50   /// Moves the feature
  51   /// \param theDeltaX the delta for X coordinate is moved
  52   /// \param theDeltaY the delta for Y coordinate is moved
  53   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  54
  55   /// Called on change of any argument-attribute of this object
  56   /// \param theID identifier of changed attribute
  57   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  58
  59   /// \brief Use plugin manager for features creation
  60   SketchPlugin_ConstraintLength();
  61
  62 private:
  63   // retrns the points-base of length, returns false if it is not possible
  64   bool getPoints(
  65     std::shared_ptr<GeomAPI_Pnt>& thePoint1, std::shared_ptr<GeomAPI_Pnt>& thePoint2,
  66     std::shared_ptr<GeomDataAPI_Point2D>& theStartPoint,
  67     std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint);
  68 };
  69
  70 #endif