1 // File: SketchPlugin_ConstraintDistance.h
2 // Created: 23 May 2014
3 // Author: Artem ZHIDKOV
5 #ifndef SketchPlugin_ConstraintDistance_HeaderFile
6 #define SketchPlugin_ConstraintDistance_HeaderFile
8 #include "SketchPlugin.h"
9 #include "SketchPlugin_Constraint.h"
10 #include <SketchPlugin_Sketch.h>
13 /** \class SketchPlugin_ConstraintDistance
15 * \brief Feature for creation of a new constraint which defines a distance
16 * between a point and another feature (point, line, plane or face)
18 * These constraint has three attributes:
19 * SketchPlugin_Constraint::VALUE(), SketchPlugin_Constraint::ENTITY_A() and SketchPlugin_Constraint::ENTITY_B()
21 class SketchPlugin_ConstraintDistance: public SketchPlugin_Constraint
24 /// Distance constraint kind
25 inline static const std::string& ID()
27 static const std::string MY_CONSTRAINT_DISTANCE_ID("SketchConstraintDistance");
28 return MY_CONSTRAINT_DISTANCE_ID;
31 /// \brief Returns the kind of a feature
32 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
33 {static std::string MY_KIND = SketchPlugin_ConstraintDistance::ID(); return MY_KIND;}
35 /// \brief Creates a new part document if needed
36 SKETCHPLUGIN_EXPORT virtual void execute();
38 /// \brief Request for initialization of data model of the feature: adding all attributes
39 SKETCHPLUGIN_EXPORT virtual void initAttributes();
41 /// Returns the AIS preview
42 SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
43 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
46 /// \param theDeltaX the delta for X coordinate is moved
47 /// \param theDeltaY the delta for Y coordinate is moved
48 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
50 /// \brief Use plugin manager for features creation
51 SketchPlugin_ConstraintDistance();