1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 // File: SketchPlugin_ConstraintRadius.h
4 // Created: 26 May 2014
5 // Author: Artem ZHIDKOV
7 #ifndef SketchPlugin_ConstraintRadius_H_
8 #define SketchPlugin_ConstraintRadius_H_
10 #include "SketchPlugin.h"
11 #include <SketchPlugin_Sketch.h>
12 #include "SketchPlugin_ConstraintBase.h"
14 #define RADIUS_COLOR "#ff00ff"
16 /** \class SketchPlugin_ConstraintRadius
18 * \brief Feature for creation of a new constraint which defines
19 * a radius of a circle or an arc of circle
21 * This constraint has two attributes:
22 * SketchPlugin_Constraint::VALUE() (radius), SketchPlugin_Constraint::ENTITY_A() (a circle)
24 class SketchPlugin_ConstraintRadius : public SketchPlugin_ConstraintBase
27 /// Radius constraint kind
28 inline static const std::string& ID()
30 static const std::string MY_CONSTRAINT_RADIUS_ID("SketchConstraintRadius");
31 return MY_CONSTRAINT_RADIUS_ID;
33 /// \brief Returns the kind of a feature
34 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
36 static std::string MY_KIND = SketchPlugin_ConstraintRadius::ID();
40 /// \brief Creates a new part document if needed
41 SKETCHPLUGIN_EXPORT virtual void execute();
43 /// Computes the attribute value on the base of other attributes if the value can be computed
44 /// \param theAttributeId an attribute index to be computed
45 /// \return a boolean value about it is computed
46 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
48 /// \brief Request for initialization of data model of the feature: adding all attributes
49 SKETCHPLUGIN_EXPORT virtual void initAttributes();
51 /// Returns the AIS preview
52 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
55 /// \param theDeltaX the delta for X coordinate is moved
56 /// \param theDeltaY the delta for Y coordinate is moved
57 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
59 /// Called on change of any argument-attribute of this object
60 /// \param theID identifier of changed attribute
61 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
63 /// \brief Use plugin manager for features creation
64 SketchPlugin_ConstraintRadius();
67 /// Checks and gets the radius of referenced circle (or arc) otherwise returns -1.
68 /// \param theCircData the found referenced circle returned by this method
69 double circleRadius(std::shared_ptr<ModelAPI_Feature>& theCirc);