Salome HOME
Make SHAPER STUDY fields exported in SMESH into MED file
[modules/shaper.git] / src / GeomAPI / GeomAPI_Edge.h
index 05ac002f1decb9b11ccb6d32d7729d1cbb553bb2..fdf82ed6fb57954343676c3969fa3805791f44a1 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAPI_Edge.hxx
-// Created:     24 Jul 2014
-// Author:      Artem ZHIDKOV
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef GeomAPI_Edge_H_
 #define GeomAPI_Edge_H_
@@ -14,6 +27,7 @@ class GeomAPI_Pnt;
 class GeomAPI_Circ;
 class GeomAPI_Lin;
 class GeomAPI_Ellipse;
+class GeomAPI_Vertex;
 
 /**\class GeomAPI_Edge
 * \ingroup DataModel
@@ -31,6 +45,15 @@ public:
   GEOMAPI_EXPORT
    GeomAPI_Edge(const std::shared_ptr<GeomAPI_Shape>& theShape);
 
+  /// Return vertices of the edge;
+  GEOMAPI_EXPORT
+  void vertices(std::shared_ptr<GeomAPI_Vertex>& theStartVertex,
+                std::shared_ptr<GeomAPI_Vertex>& theEndVertex) const;
+
+  /// Returns \c true if edges have same underlying curve
+  GEOMAPI_EXPORT
+  virtual bool isSameGeometry(const std::shared_ptr<GeomAPI_Shape> theShape) const;
+
   /// Verifies that the edge is a line
   GEOMAPI_EXPORT
   bool isLine() const;
@@ -76,15 +99,40 @@ public:
   void getRange(double& theFirst, double& theLast) const;
 
   /// Returns true, if the edge is fully placed in the specified plane
+  /// \param thePlane a plane for intersection
   GEOMAPI_EXPORT
   bool isInPlane(const std::shared_ptr<GeomAPI_Pln> thePlane) const;
 
+  /// Returns list of intersection points if the edge has intersections with the given plane
+  /// \param thePlane a plane for intersection
+  GEOMAPI_EXPORT
+  void intersectWithPlane(const std::shared_ptr<GeomAPI_Pln> thePlane,
+                          std::list<std::shared_ptr<GeomAPI_Pnt> >& theResult) const;
+
   /// Returns edge length.
   GEOMAPI_EXPORT
   double length() const;
+
+  /// Returns true if the edge is closed (like full circle)
+  GEOMAPI_EXPORT
+  bool isClosed() const;
+
+  /// Returns true if the edge is degenerated (has no 3D curve)
+  GEOMAPI_EXPORT
+  bool isDegenerated() const;
+
+  GEOMAPI_EXPORT
+  void setFirstPointTolerance(const double theTolerance);
+
+  GEOMAPI_EXPORT
+  void setLastPointTolerance(const double theTolerance);
+
+  /// Return middle point on the edge
+  GEOMAPI_EXPORT
+  virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
 };
 
-//! Pointer on attribute object
+//! Pointer on object
 typedef std::shared_ptr<GeomAPI_Edge> GeomEdgePtr;
 
 #endif