Salome HOME
Merge branch 'Dev_1.1.0' of newgeom:newgeom into Dev_1.1.0
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_Sketch.h
index 5cde6adadcb174fe0b8541fd21655b02262c615e..43a6e370792dc38e1d020ee6808fe739d6b5e04f 100644 (file)
@@ -1,23 +1,31 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
+
 // File:        SketchPlugin_Sketch.h
 // 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 <GeomAPI_Ax3.h>
 #include <list>
 
+#define YZ_PLANE_COLOR "#ff0000"
+#define XZ_PLANE_COLOR "#00ff00"
+#define XY_PLANE_COLOR "#0000ff"
+
 /**\class SketchPlugin_Sketch
- * \ingroup DataModel
+ * \ingroup Plugins
  * \brief Feature for creation of the new part in PartSet.
  */
-class SketchPlugin_Sketch: public SketchPlugin_Feature
+class SketchPlugin_Sketch : public ModelAPI_CompositeFeature//, public GeomAPI_IPresentable
 {
-public:
+ public:
   /// Sketch feature kind
   inline static const std::string& ID()
   {
@@ -56,12 +64,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;}
-
-  /// 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;}
+  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();
@@ -69,48 +76,69 @@ 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
-  SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
-                                boost::shared_ptr<GeomAPI_AISObject> 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);
-
   /// 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 std::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 std::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:
-  /// 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;
+  std::shared_ptr<GeomAPI_Pln> plane();
+
+  SKETCHPLUGIN_EXPORT std::shared_ptr<GeomAPI_Ax3> coordinatePlane() const;
+
+  //virtual AISObjectPtr getAISObject(AISObjectPtr thePrevious);
+
+  /// removes also all sub-sketch elements
+  SKETCHPLUGIN_EXPORT virtual void erase();
+
+  /// appends a feature to the sketch sub-elements container
+  SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID);
+
+  /// Just to synchronise the container of sub-features
+  virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature);
+
+  /// Returns the number of sub-elements
+  SKETCHPLUGIN_EXPORT virtual int numberOfSubs() const;
 
+  /// Returns the sub-feature by zero-base index
+  SKETCHPLUGIN_EXPORT virtual std::shared_ptr<ModelAPI_Feature> 
+    subFeature(const int theIndex) const;
+
+  /// Returns the sub-feature unique identifier in this composite feature by zero-base index
+  SKETCHPLUGIN_EXPORT virtual int subFeatureId(const int theIndex) const;
+
+  /// Returns true if feature or reuslt belong to this composite feature as subs
+  SKETCHPLUGIN_EXPORT virtual bool isSub(ObjectPtr theObject) const;
+
+  /// Construction result is allways recomuted on the fly
+  SKETCHPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
+
+  /// Returns the point projected into the sketch plane
+  std::shared_ptr<GeomAPI_Pnt2d> to2D(const std::shared_ptr<GeomAPI_Pnt>& thePnt);
+
+  SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
+protected:
   /// Checks whether the plane is set in the sketch.
   /// \returns the boolean state
   bool isPlaneSet();