1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_ConstraintLength.h
4 // Created: 30 May 2014
5 // Author: Artem ZHIDKOV
7 #ifndef SketchPlugin_ConstraintLength_H_
8 #define SketchPlugin_ConstraintLength_H_
10 #include "SketchPlugin.h"
11 #include "SketchPlugin_ConstraintBase.h"
12 #include <SketchPlugin_Sketch.h>
15 class GeomDataAPI_Point2D;
17 #define LENGTH_COLOR "#ff00ff"
19 /** \class SketchPlugin_ConstraintLength
21 * \brief Feature for creation of a new constraint which defines a length of a line segment
23 * This constraint has two attributes:
24 * SketchPlugin_Constraint::VALUE() (length) and SketchPlugin_Constraint::ENTITY_A() (segment),
25 * SketchPlugin_Constraint::FLYOUT_VALUE_PNT() (distance of a constraints handle)
27 class SketchPlugin_ConstraintLength : public SketchPlugin_ConstraintBase
30 /// Length constraint kind
31 inline static const std::string& ID()
33 static const std::string MY_CONSTRAINT_LENGTH_ID("SketchConstraintLength");
34 return MY_CONSTRAINT_LENGTH_ID;
36 /// \brief Returns the kind of a feature
37 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
39 static std::string MY_KIND = SketchPlugin_ConstraintLength::ID();
43 /// \brief Creates a new part document if needed
44 SKETCHPLUGIN_EXPORT virtual void execute();
46 /// Computes the attribute value on the base of other attributes if the value can be computed
47 /// \param theAttributeId an attribute index to be computed
48 /// \return a boolean value about it is computed
49 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
51 /// \brief Request for initialization of data model of the feature: adding all attributes
52 SKETCHPLUGIN_EXPORT virtual void initAttributes();
54 /// Returns the AIS preview
55 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
58 /// \param theDeltaX the delta for X coordinate is moved
59 /// \param theDeltaY the delta for Y coordinate is moved
60 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
62 /// Called on change of any argument-attribute of this object
63 /// \param theID identifier of changed attribute
64 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
66 /// \brief Use plugin manager for features creation
67 SketchPlugin_ConstraintLength();
70 // retrns the points-base of length, returns false if it is not possible
72 std::shared_ptr<GeomAPI_Pnt>& thePoint1, std::shared_ptr<GeomAPI_Pnt>& thePoint2,
73 std::shared_ptr<GeomDataAPI_Point2D>& theStartPoint,
74 std::shared_ptr<GeomDataAPI_Point2D>& theEndPoint);