src/SketchPlugin/SketchPlugin_ConstraintDistance.h

   1 // File:    SketchPlugin_ConstraintDistance.h
   2 // Created: 23 May 2014
   3 // Author:  Artem ZHIDKOV
   4
   5 #ifndef SketchPlugin_ConstraintDistance_H_
   6 #define SketchPlugin_ConstraintDistance_H_
   7
   8 #include "SketchPlugin.h"
   9 #include "SketchPlugin_Constraint.h"
  10 #include "SketchPlugin_Sketch.h"
  11 #include "ModelAPI_Data.h"
  12
  13 #include <list>
  14
  15 class SketchPlugin_Line;
  16 class GeomDataAPI_Point2D;
  17
  18 #define DISTANCE_COLOR "#ff00ff"
  19
  20 /** \class SketchPlugin_ConstraintDistance
  21  *  \ingroup DataModel
  22  *  \brief Feature for creation of a new constraint which defines a distance
  23  *         between a point and another feature (point, line, plane or face)
  24  *
  25  *  These constraint has three attributes:
  26  *  SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
  27  */
  28 class SketchPlugin_ConstraintDistance: public SketchPlugin_Constraint
  29 {
  30 public:
  31   /// Distance constraint kind
  32   inline static const std::string& ID()
  33   {
  34     static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistance");
  35     return MY_CONSTRAINT_DISTANCE_ID;
  36   }
  37
  38   /// \brief Returns the kind of a feature
  39   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  40   {static std::string MY_KIND = SketchPlugin_ConstraintDistance::ID(); return MY_KIND;}
  41
  42   /// \brief Creates a new part document if needed
  43   SKETCHPLUGIN_EXPORT virtual void execute();
  44
  45   /// \brief Request for initialization of data model of the feature: adding all attributes
  46   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  47
  48   /// Returns the AIS preview
  49   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  50                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  51
  52   /// Moves the feature
  53   /// \param theDeltaX the delta for X coordinate is moved
  54   /// \param theDeltaY the delta for Y coordinate is moved
  55   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  56
  57   /// \brief Use plugin manager for features creation
  58   SketchPlugin_ConstraintDistance();
  59 };
  60
  61
  62 /// Obtain the point object from specified constraint parameter
  63 boost::shared_ptr<GeomDataAPI_Point2D> getFeaturePoint(DataPtr theData,
  64                                                        const std::string&  theAttribute);
  65
  66 boost::shared_ptr<SketchPlugin_Line> getFeatureLine(DataPtr theData, const std::string& theAttribute);
  67
  68 boost::shared_ptr<GeomAPI_Pnt2d> getProjectionPoint(const boost::shared_ptr<SketchPlugin_Line>& theLine,
  69                                                     const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  70
  71
  72 #endif