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 /// Distance constraint kind
14 const std::string SKETCH_CONSTRAINT_DISTANCE_KIND("SketchConstraintDistance");
16 /** \class SketchPlugin_ConstraintDistance
18 * \brief Feature for creation of a new constraint which defines a distance
19 * between a point and another feature (point, line, plane or face)
21 * These constraint has three attributes:
22 * CONSTRAINT_ATTR_VALUE, CONSTRAINT_ATTR_ENTITY_A and CONSTRAINT_ATTR_ENTITY_B
24 class SketchPlugin_ConstraintDistance: public SketchPlugin_Constraint
27 /// \brief Returns the kind of a feature
28 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
29 {static std::string MY_KIND = SKETCH_CONSTRAINT_DISTANCE_KIND; return MY_KIND;}
31 /// \brief Creates a new part document if needed
32 SKETCHPLUGIN_EXPORT virtual void execute();
34 /// \brief Request for initialization of data model of the feature: adding all attributes
35 SKETCHPLUGIN_EXPORT virtual void initAttributes();
37 /// Returns the AIS preview
38 SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
39 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
42 /// \param theDeltaX the delta for X coordinate is moved
43 /// \param theDeltaY the delta for Y coordinate is moved
44 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
46 /// \brief Use plugin manager for features creation
47 SketchPlugin_ConstraintDistance();