1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
20 #ifndef SketchPlugin_ConstraintRadius_H_
21 #define SketchPlugin_ConstraintRadius_H_
23 #include "SketchPlugin.h"
24 #include <SketchPlugin_Sketch.h>
25 #include "SketchPlugin_ConstraintBase.h"
27 /** \class SketchPlugin_ConstraintRadius
29 * \brief Feature for creation of a new constraint which defines
30 * a radius of a circle or an arc of circle
32 * This constraint has two attributes:
33 * SketchPlugin_Constraint::VALUE() (radius), SketchPlugin_Constraint::ENTITY_A() (a circle)
35 class SketchPlugin_ConstraintRadius : public SketchPlugin_ConstraintBase
38 /// Radius constraint kind
39 inline static const std::string& ID()
41 static const std::string MY_CONSTRAINT_RADIUS_ID("SketchConstraintRadius");
42 return MY_CONSTRAINT_RADIUS_ID;
44 /// \brief Returns the kind of a feature
45 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
47 static std::string MY_KIND = SketchPlugin_ConstraintRadius::ID();
51 /// \brief Creates a new part document if needed
52 SKETCHPLUGIN_EXPORT virtual void execute();
54 /// Computes the attribute value on the base of other attributes if the value can be computed
55 /// \param theAttributeId an attribute index to be computed
56 /// \return a boolean value about it is computed
57 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
59 /// \brief Request for initialization of data model of the feature: adding all attributes
60 SKETCHPLUGIN_EXPORT virtual void initAttributes();
62 /// Retuns the parameters of color definition in the resources config manager
63 SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
64 std::string& theDefault);
66 /// Returns the AIS preview
67 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
70 /// \param theDeltaX the delta for X coordinate is moved
71 /// \param theDeltaY the delta for Y coordinate is moved
72 SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
74 /// Called on change of any argument-attribute of this object
75 /// \param theID identifier of changed attribute
76 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
78 /// \brief Use plugin manager for features creation
79 SketchPlugin_ConstraintRadius();
82 /// Checks and gets the radius of referenced circle (or arc) otherwise returns -1.
83 /// \param theCircData the found referenced circle returned by this method
84 double circleRadius(std::shared_ptr<ModelAPI_Feature>& theCirc);
87 bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point