Merge branch 'Dev_1.1.0' of newgeom:newgeom.git into Dev_1.1.0

[modules/shaper.git] / src / GeomAPI / GeomAPI_PlanarEdges.h

diff --git a/src/GeomAPI/GeomAPI_PlanarEdges.h b/src/GeomAPI/GeomAPI_PlanarEdges.h
index 1521d5addae1d5cc1004c43f12bf2381bde9c0e9..c26ad2505e180e386ff739d3852b85012581ab52 100644 (file)
--- 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,54 +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();
 
-  GEOMAPI_EXPORT virtual bool isVertex() const
-  {
-    return false;
-  }
-
-  /// Returns whether the shape is an edge
-  GEOMAPI_EXPORT virtual bool isEdge() const
-  {
-    return false;
-  }
+  /// Returns whether the shape is alone vertex
+  GEOMAPI_EXPORT virtual bool isVertex() const;
 
+  /// 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 { return myOrigin && myNorm && myDirX && myDirY; }
+  GEOMAPI_EXPORT bool hasPlane() const;
 
-  /// Set/Get origin point
-  GEOMAPI_EXPORT void setOrigin(const std::shared_ptr<GeomAPI_Pnt>& theOrigin) 
-  { myOrigin = theOrigin; }
-  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Pnt> origin() const { return myOrigin; }
+  /// 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) { myDirX = theDirX; }
-  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirX() const { return myDirX; }
+  /// 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) { myDirY = theDirY; }
-  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> dirY() const { return myDirY; }
+  /// 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) { myNorm = theNorm; }
-  GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Dir> norm() const { return myNorm; }
+  /// 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