Make the doxygen documentation more structurized and added a general description...

[modules/shaper.git] / src / SketchPlugin / SketchPlugin_ConstraintRadius.h

diff --git a/src/SketchPlugin/SketchPlugin_ConstraintRadius.h b/src/SketchPlugin/SketchPlugin_ConstraintRadius.h
index f330a31ece851d68fd568389b4de86e3a4c20767..84c2043c422f715722191e5918522cc7524cbaa6 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_ConstraintRadius.h
+++ b/src/SketchPlugin/SketchPlugin_ConstraintRadius.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:    SketchPlugin_ConstraintRadius.h
 // Created: 26 May 2014
 // Author:  Artem ZHIDKOV
@@ -12,24 +14,28 @@
 #define RADIUS_COLOR "#ff00ff"
 
 /** \class SketchPlugin_ConstraintRadius
- *  \ingroup DataModel
+ *  \ingroup Plugins
  *  \brief Feature for creation of a new constraint which defines 
  *         a radius of a circle or an arc of circle
  *
- *  These constraint has two attributes:
+ *  This constraint has two attributes:
  *  SketchPlugin_Constraint::VALUE() (radius), SketchPlugin_Constraint::ENTITY_A() (a circle)
  */
-class SketchPlugin_ConstraintRadius: public SketchPlugin_ConstraintBase
+class SketchPlugin_ConstraintRadius : public SketchPlugin_ConstraintBase
 {
-public:
+ public:
   /// Radius constraint kind
-  inline static const std::string& ID() {
+  inline static const std::string& ID()
+  {
     static const std::string MY_CONSTRAINT_RADIUS_ID("SketchConstraintRadius");
     return MY_CONSTRAINT_RADIUS_ID;
   }
   /// \brief Returns the kind of a feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = SketchPlugin_ConstraintRadius::ID(); return MY_KIND;}
+  SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
+  {
+    static std::string MY_KIND = SketchPlugin_ConstraintRadius::ID();
+    return MY_KIND;
+  }
 
   /// \brief Creates a new part document if needed
   SKETCHPLUGIN_EXPORT virtual void execute();
@@ -45,8 +51,17 @@ public:
   /// \param theDeltaY the delta for Y coordinate is moved
   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
 
+  /// Called on change of any argument-attribute of this object
+  /// \param theID identifier of changed attribute
+  SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
+
   /// \brief Use plugin manager for features creation
   SketchPlugin_ConstraintRadius();
+
+private:
+  /// Checks and gets the radius of referenced circle (or arc) otherwise returns -1.
+  /// \param theCircData the found referenced circle returned by this method
+  double circleRadius(std::shared_ptr<ModelAPI_Feature>& theCirc);
 };
 
 #endif