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>
14 /** \class SketchPlugin_ConstraintDistance
16 * \brief Feature for creation of a new constraint which defines a distance
17 * between a point and another feature (point, line, plane or face)
19 * These constraint has three attributes:
20 * CONSTRAINT_ATTR_VALUE, CONSTRAINT_ATTR_ENTITY_A and CONSTRAINT_ATTR_ENTITY_B
22 class SketchPlugin_ConstraintDistance: public SketchPlugin_Constraint
25 /// \brief Returns the kind of a feature
26 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
27 {static std::string MY_KIND = "SketchConstraintDistance"; return MY_KIND;}
29 /// \brief Returns to which group in the document must be added feature
30 SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
31 {static std::string MY_GROUP = SKETCH_KIND; return MY_GROUP;}
33 /// \brief Creates a new part document if needed
34 SKETCHPLUGIN_EXPORT virtual void execute();
36 /// \brief Request for initialization of data model of the feature: adding all attributes
37 SKETCHPLUGIN_EXPORT virtual void initAttributes();
39 /// \brief Returns the sketch preview
40 SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
42 /// \brief Use plugin manager for features creation
43 SketchPlugin_ConstraintDistance();