X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAPI%2FGeomAPI_PlanarEdges.h;h=c26ad2505e180e386ff739d3852b85012581ab52;hb=61cd0845b41710ad4e7eae07cc6106904be67b9f;hp=1cb638530404779baacb5d608c3601277282af7c;hpb=93390904f99935a117856d9777d1bb542b1b38bd;p=modules%2Fshaper.git

diff --git a/src/GeomAPI/GeomAPI_PlanarEdges.h b/src/GeomAPI/GeomAPI_PlanarEdges.h
index 1cb638530..c26ad2505 100644
--- a/src/GeomAPI/GeomAPI_PlanarEdges.h
+++ b/src/GeomAPI/GeomAPI_PlanarEdges.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        GeomAPI_PlanarEdges.hxx
 // Created:     24 Jul 2014
 // Author:      Artem ZHIDKOV
@@ -9,6 +11,7 @@
 #include "GeomAPI_Edge.h"
 #include "GeomAPI_Pnt.h"
 #include "GeomAPI_Dir.h"
+#include "GeomAPI_Ax3.h"
 
 #include <memory>
 
@@ -16,48 +19,53 @@
 
 /**\class GeomAPI_PlanarEdges
  * \ingroup DataModel
- * \brief Interface to the edge object
+ * \brief Interface to the set of edges located in one plane
+ *
+ * Normally this interface corresponds to theedges of the sketch
  */
-
 class GeomAPI_PlanarEdges : public GeomAPI_Shape
 {
  public:
   /// Creation of empty (null) shape
   GEOMAPI_EXPORT GeomAPI_PlanarEdges();
 
+  /// Returns whether the shape is alone vertex
   GEOMAPI_EXPORT virtual bool isVertex() const;
 
-  /// Returns whether the shape is an edge
+  /// Returns whether the shape is alone edge
   GEOMAPI_EXPORT virtual bool isEdge() const;
-
+  /// Appends the edge to the set
   GEOMAPI_EXPORT void addEdge(std::shared_ptr<GeomAPI_Shape> theEdge);
+  /// Returns the list of edges in this interface
   GEOMAPI_EXPORT std::list<std::shared_ptr<GeomAPI_Shape> > getEdges();
 
   /// Returns True if the wire is defined in a plane
   GEOMAPI_EXPORT bool hasPlane() const;
 
-  /// Set/Get origin point
-  GEOMAPI_EXPORT void setOrigin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin);
-
+  /// Returns the plane origin point
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> origin() const;
 
-  /// Set/Get X direction vector
-  GEOMAPI_EXPORT void setDirX(const std::shared_ptr<GeomAPI_Dir>& theDirX);
+  /// Returns X direction vector
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirX() const;
 
-  /// Set/Get Y direction vector
-  GEOMAPI_EXPORT void setDirY(const std::shared_ptr<GeomAPI_Dir>& theDirY);
+  /// Returns Y direction vector
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirY() const;
 
-  /// Set/Get Normal direction vector
-  GEOMAPI_EXPORT void setNorm(const std::shared_ptr<GeomAPI_Dir>& theNorm);
+  /// Returns Z direction vector
   GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> norm() const;
 
+  /// Set working plane
+  /// \param theOrigin origin of the plane axis
+  /// \param theDirX X direction of the plane axis
+  /// \param theDirY Y direction of the plane axis
+  /// \param theNorm normal direction of the plane axis
+  GEOMAPI_EXPORT void setPlane(const std::shared_ptr<GeomAPI_Pnt>& theOrigin,
+                               const std::shared_ptr<GeomAPI_Dir>& theDirX,
+                               const std::shared_ptr<GeomAPI_Dir>& theNorm);
+
 private:
-  std::shared_ptr<GeomAPI_Pnt> myOrigin;
-  std::shared_ptr<GeomAPI_Dir> myDirX;
-  std::shared_ptr<GeomAPI_Dir> myDirY;
-  std::shared_ptr<GeomAPI_Dir> myNorm;
+
+  std::shared_ptr<GeomAPI_Ax3> myPlane;
 };
 
 #endif