Salome HOME
Sources formated according to the codeing standards
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Sketch.h
index 1f16d72ca90f1dfa2e5d5c6c2705eaf699b11d18..806025dd7c608c0465096cb55238141be762c9bb 100644 (file)
@@ -2,43 +2,75 @@
 // 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_Pnt.h>
 #include <GeomAPI_Pln.h>
+#include <GeomAPI_IPresentable.h>
 #include <list>
 
-/// Sketch feature kind
-const std::string SKETCH_KIND("Sketch");
+/// the plane edge color
+#define SKETCH_PLANE_COLOR "#700000" 
 
-/// Origin point of the sketcher in 3D space
-const std::string SKETCH_ATTR_ORIGIN("Origin");
-/// Vector X inside of the sketch plane
-const std::string SKETCH_ATTR_DIRX("DirX");
-/// Vector Y inside of the sketch plane
-const std::string SKETCH_ATTR_DIRY("DirY");
-/// Vector Z, normal to the sketch plane
-const std::string SKETCH_ATTR_NORM("Norm");
-/// All features of this sketch (list of references)
-const std::string SKETCH_ATTR_FEATURES("Features");
+/// 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
+class SketchPlugin_Sketch : public SketchPlugin_Feature, public GeomAPI_IPresentable
 {
-public:
-  /// Returns the kind of a feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getKind() 
-  {static std::string MY_KIND = SKETCH_KIND; return MY_KIND;}
+ public:
+  /// Sketch feature kind
+  inline static const std::string& ID()
+  {
+    static const std::string MY_SKETCH_ID("Sketch");
+    return MY_SKETCH_ID;
+  }
+  /// Origin point of the sketcher in 3D space
+  inline static const std::string& ORIGIN_ID()
+  {
+    static const std::string MY_ORIGIN_ID("Origin");
+    return MY_ORIGIN_ID;
+  }
+  /// Vector X inside of the sketch plane
+  inline static const std::string& DIRX_ID()
+  {
+    static const std::string MY_DIRX_ID("DirX");
+    return MY_DIRX_ID;
+  }
+  /// Vector Y inside of the sketch plane
+  inline static const std::string& DIRY_ID()
+  {
+    static const std::string MY_DIRY_ID("DirY");
+    return MY_DIRY_ID;
+  }
+  /// Vector Z, normal to the sketch plane
+  inline static const std::string& NORM_ID()
+  {
+    static const std::string MY_NORM_ID("Norm");
+    return MY_NORM_ID;
+  }
+  /// All features of this sketch (list of references)
+  inline static const std::string& FEATURES_ID()
+  {
+    static const std::string MY_FEATURES_ID("Features");
+    return MY_FEATURES_ID;
+  }
 
-  /// Returns to which group in the document must be added feature
-  SKETCHPLUGIN_EXPORT virtual const std::string& getGroup() 
-  {static std::string MY_GROUP = "Construction"; return MY_GROUP;}
+  /// Returns the kind of a feature
+  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();
@@ -46,46 +78,51 @@ 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 sketch preview
-  SKETCHPLUGIN_EXPORT virtual Handle_AIS_InteractiveObject getAISShape(Handle_AIS_InteractiveObject thePrevious);
-
   /// 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();
 
   /// Returns the basis plane for the sketch
   boost::shared_ptr<GeomAPI_Pln> plane();
-protected:
+
+  virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
+
+ protected:
   /// Creates a plane and append it to the list
   /// \param theX the X normal value
   /// \param theY the Y normal value
   /// \param theZ the Z normal value
   /// \param theShapes the list of result shapes
-  void addPlane(double theX, double theY, double theZ,
-                std::list<boost::shared_ptr<GeomAPI_Shape> >& theShapes) const;
+  //void addPlane(double theX, double theY, double theZ,
+  //              std::list<boost::shared_ptr<GeomAPI_Shape> >& theShapes) const;
 
   /// Checks whether the plane is set in the sketch.
   /// \returns the boolean state