Salome HOME
Simplification and refactoring of unit tests for SketchPlugin
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Circle.h
index 10fee4f7bba9f27b1c453d745528138dcced52d9..df577cda870313f2814807e53458e4d7249155ab 100644 (file)
@@ -1,53 +1,71 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        SketchPlugin_Circle.h
 // Created:     26 May 2014
 // Author:      Artem ZHIDKOV
 
-#ifndef SketchPlugin_Circle_HeaderFile
-#define SketchPlugin_Circle_HeaderFile
+#ifndef SketchPlugin_Circle_H_
+#define SketchPlugin_Circle_H_
 
 #include "SketchPlugin.h"
-#include <SketchPlugin_Feature.h>
+#include <SketchPlugin_SketchEntity.h>
 #include <SketchPlugin_Sketch.h>
 
-/// Circle feature kind
-const std::string SKETCH_CIRCLE_KIND("SketchCircle");
-
-/// 2D point - center of the circle
-const std::string CIRCLE_ATTR_CENTER("CircleCenter");
-/// Radius of the circle
-const std::string CIRCLE_ATTR_RADIUS("CircleRadius");
-
 /**\class SketchPlugin_Circle
- * \ingroup DataModel
- * \brief Feature for creation of the new circle in PartSet.
+ * \ingroup Plugins
+ * \brief Feature for creation of the new circle in Sketch.
  */
-class SketchPlugin_Circle: public SketchPlugin_Feature
+class SketchPlugin_Circle: public SketchPlugin_SketchEntity
 {
-public:
+ public:
+  /// Circle feature kind
+  inline static const std::string& ID()
+  {
+    static const std::string ID("SketchCircle");
+    return ID;
+  }
+
+  /// 2D point - center of the circle
+  inline static const std::string& CENTER_ID()
+  {
+    static const std::string ID("circle_center");
+    return ID;
+  }
+
+  /// Radius of the circle
+  inline static const std::string& RADIUS_ID()
+  {
+    static const std::string ID("circle_radius");
+    return ID;
+  }
+
   /// Returns the kind of a feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = SKETCH_CIRCLE_KIND; return MY_KIND;}
+  SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
+  {
+    static std::string MY_KIND = SketchPlugin_Circle::ID();
+    return MY_KIND;
+  }
+
+  /// Returns true is sketch element is under the rigid constraint
+  SKETCHPLUGIN_EXPORT virtual bool isFixed();
 
-  /// Returns to which group in the document must be added feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() 
-  {static std::string MY_GROUP = SKETCH_KIND; return MY_GROUP;}
+  /// Called on change of any argument-attribute of this object
+  SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 
   /// Creates a new part document if needed
   SKETCHPLUGIN_EXPORT virtual void execute();
 
-  /// Request for initialization of data model of the feature: adding all attributes
-  SKETCHPLUGIN_EXPORT virtual void initAttributes();
-
-  /// Returns the sketch preview
-  SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
-
-  /// Adds sub-feature of the higher level feature (sub-element of the sketch)
-  /// \param theFeature sub-feature
-  SKETCHPLUGIN_EXPORT virtual const void addSub(
-    const FeaturePtr& theFeature) {};
+  /// Moves the feature
+  /// \param theDeltaX the delta for X coordinate is moved
+  /// \param theDeltaY the delta for Y coordinate is moved
+  SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
 
   /// Use plugin manager for features creation
   SketchPlugin_Circle();
+
+protected:
+  /// \brief Initializes attributes of derived class.
+  virtual void initDerivedClassAttributes();
 };
 
 #endif