Issue #273: Add copyright string

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

diff --git a/src/SketchPlugin/SketchPlugin_Point.h b/src/SketchPlugin/SketchPlugin_Point.h
index b18bffb08646be9264dbec3f9f26fe01bd22664f..4d2845c1c0958eb1c5bb9fcca2cf1541cece47f2 100644 (file)
--- a/src/SketchPlugin/SketchPlugin_Point.h
+++ b/src/SketchPlugin/SketchPlugin_Point.h
@@ -1,31 +1,45 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:    SketchPlugin_Point.h
 // Created: 07 May 2014
 // Author:  Artem ZHIDKOV
 
-#ifndef SketchPlugin_Point_HeaderFile
-#define SketchPlugin_Point_HeaderFile
+#ifndef SketchPlugin_Point_H_
+#define SketchPlugin_Point_H_
 
 #include "SketchPlugin.h"
+#include <SketchPlugin_Sketch.h>
 #include "SketchPlugin_Feature.h"
 #include <list>
 
-/// Coordinates of the point
-const std::string POINT_ATTR_COORD("PointCoordindates");
-
 /**\class SketchPlugin_Point
  * \ingroup DataModel
  * \brief Feature for creation of a new point.
  */
-class SketchPlugin_Point: public SketchPlugin_Feature
+class SketchPlugin_Point : public SketchPlugin_Feature
 {
-public:
+ public:
+  /// Point feature kind
+  inline static const std::string& ID()
+  {
+    static const std::string MY_POINT_ID("SketchPoint");
+    return MY_POINT_ID;
+  }
+  /// Coordinates of the point
+  inline static const std::string& COORD_ID()
+  {
+    static const std::string MY_COORD_ID("PointCoordindates");
+    return MY_COORD_ID;
+  }
   /// Returns the kind of a feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = "SketchPoint"; return MY_KIND;}
+  SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
+  {
+    static std::string MY_KIND = SketchPlugin_Point::ID();
+    return MY_KIND;
+  }
 
-  /// Returns to which group in the document must be added feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() 
-  {static std::string MY_GROUP = "Sketch"; return MY_GROUP;}
+  /// Returns true is sketch element is under the rigid constraint
+  SKETCHPLUGIN_EXPORT virtual bool isFixed();
 
   /// Creates a new part document if needed
   SKETCHPLUGIN_EXPORT virtual void execute();
@@ -33,13 +47,20 @@ public:
   /// 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();
+  /// Returns the AIS preview
+  virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious)
+  {
+    return simpleAISObject(firstResult(), thePrevious);
+  }
+
+  /// 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);
 
-  /// Adds sub-feature of the higher level feature (sub-element of the sketch)
-  /// \param theFeature sub-feature
-  SKETCHPLUGIN_EXPORT virtual const void addSub(
-    const boost::shared_ptr<ModelAPI_Feature>& theFeature) {};
+  /// Return the distance between the feature and the point
+  /// \param thePoint the point
+  virtual double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
 
   /// Use plugin manager for features creation
   SketchPlugin_Point();