Salome HOME
Merge branch 'master' of newgeom:newgeom.git
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Sketch.h
index 374f8a9e1d9cf1ae62458093272301f17b6cdb1f..07f8ae269ec8e34eee0af6f9a4559b15e9c61d7d 100644 (file)
@@ -2,8 +2,8 @@
 // Created:     27 Mar 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef SketchPlugin_Sketch_HeaderFile
-#define SketchPlugin_Sketch_HeaderFile
+#ifndef SketchPlugin_Sketch_H_
+#define SketchPlugin_Sketch_H_
 
 #include "SketchPlugin.h"
 #include <SketchPlugin_Feature.h>
 #include <GeomAPI_IPresentable.h>
 #include <list>
 
+/// the plane edge color
+#define SKETCH_PLANE_COLOR "#700000" 
+
+/// the plane edge width
+#define SKETCH_WIDTH        "4"
+
+/// face of the square-face displayed for selection of general plane
+#define PLANE_SIZE          "200"     
+
 /**\class SketchPlugin_Sketch
  * \ingroup DataModel
  * \brief Feature for creation of the new part in PartSet.
  */
-class SketchPlugin_Sketch: public SketchPlugin_Feature, public GeomAPI_IPresentable
+class SketchPlugin_Sketch : public SketchPlugin_Feature, public GeomAPI_IPresentable
 {
-public:
+ public:
   /// Sketch feature kind
   inline static const std::string& ID()
   {
@@ -57,8 +66,11 @@ public:
   }
 
   /// Returns the kind of a feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = SketchPlugin_Sketch::ID(); return MY_KIND;}
+  SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
+  {
+    static std::string MY_KIND = SketchPlugin_Sketch::ID();
+    return MY_KIND;
+  }
 
   /// Creates a new part document if needed
   SKETCHPLUGIN_EXPORT virtual void execute();
@@ -68,24 +80,32 @@ public:
 
   /// 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);
+  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) {};
+  SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY)
+  {
+  }
+  ;
 
   /// Return the distance between the feature and the point
   /// \param thePoint the point
-  virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint) { return 0; };
+  virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint)
+  {
+    return 0;
+  }
+  ;
 
   /// Converts a 2D sketch space point into point in 3D space
-  SKETCHPLUGIN_EXPORT boost::shared_ptr<GeomAPI_Pnt> to3D(
-    const double theX, const double theY);
+  SKETCHPLUGIN_EXPORT boost::shared_ptr<GeomAPI_Pnt> to3D(const double theX, const double theY);
 
   /// Returns true if this feature must be displayed in the history (top level of Part tree)
-  SKETCHPLUGIN_EXPORT virtual bool isInHistory() {return true;}
+  SKETCHPLUGIN_EXPORT virtual bool isInHistory()
+  {
+    return true;
+  }
 
   /// Use plugin manager for features creation
   SketchPlugin_Sketch();
@@ -93,12 +113,12 @@ public:
   /// Returns the basis plane for the sketch
   boost::shared_ptr<GeomAPI_Pln> plane();
 
-  virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
-                            boost::shared_ptr<GeomAPI_AISObject> thePrevious);
+  virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
 
-  static FeaturePtr getFeature(ObjectPtr theObject);
+  /// removes also all sub-sketch elements
+  SKETCHPLUGIN_EXPORT virtual void erase();
 
-protected:
+ protected:
   /// Creates a plane and append it to the list
   /// \param theX the X normal value
   /// \param theY the Y normal value