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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef SketchPlugin_ConstraintRadius_H_
22 #define SketchPlugin_ConstraintRadius_H_
24 #include "SketchPlugin.h"
25 #include <SketchPlugin_Sketch.h>
26 #include "SketchPlugin_ConstraintBase.h"
28 /** \class SketchPlugin_ConstraintRadius
30 * \brief Feature for creation of a new constraint which defines
31 * a radius of a circle or an arc of circle
33 * This constraint has two attributes:
34 * SketchPlugin_Constraint::VALUE() (radius), SketchPlugin_Constraint::ENTITY_A() (a circle)
36 class SketchPlugin_ConstraintRadius : public SketchPlugin_ConstraintBase
39 /// Radius constraint kind
40 inline static const std::string& ID()
42 static const std::string MY_CONSTRAINT_RADIUS_ID("SketchConstraintRadius");
43 return MY_CONSTRAINT_RADIUS_ID;
45 /// \brief Returns the kind of a feature
46 SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
48 static std::string MY_KIND = SketchPlugin_ConstraintRadius::ID();
52 /// attribute name of dimension location type
53 inline static const std::string& LOCATION_TYPE_ID()
55 static const std::string MY_LOCATION_TYPE_ID("LocationType");
56 return MY_LOCATION_TYPE_ID;
59 /// \brief Creates a new part document if needed
60 SKETCHPLUGIN_EXPORT virtual void execute();
62 /// Computes the attribute value on the base of other attributes if the value can be computed
63 /// \param theAttributeId an attribute index to be computed
64 /// \return a boolean value about it is computed
65 SKETCHPLUGIN_EXPORT virtual bool compute(const std::string& theAttributeId);
67 /// \brief Request for initialization of data model of the feature: adding all attributes
68 SKETCHPLUGIN_EXPORT virtual void initAttributes();
70 /// Retuns the parameters of color definition in the resources config manager
71 SKETCHPLUGIN_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
72 std::string& theDefault);
74 /// Returns the AIS preview
75 SKETCHPLUGIN_EXPORT virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
77 /// Called on change of any argument-attribute of this object
78 /// \param theID identifier of changed attribute
79 SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
81 /// \brief Use plugin manager for features creation
82 SketchPlugin_ConstraintRadius();
85 /// Checks and gets the radius of referenced circle (or arc) otherwise returns -1.
86 /// \param theCircData the found referenced circle returned by this method
87 double circleRadius(std::shared_ptr<ModelAPI_Feature>& theCirc);
90 bool myFlyoutUpdate; ///< to avoid cyclic dependencies on automatic updates of flyout point