1 // Copyright (C) 2014-2019 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef GeomAPI_Edge_H_
21 #define GeomAPI_Edge_H_
23 #include <GeomAPI_Shape.h>
29 class GeomAPI_Ellipse;
32 /**\class GeomAPI_Edge
34 * \brief Interface to the edge object
37 class GeomAPI_Edge : public GeomAPI_Shape
40 /// Makes an undefined Edge (no geometry).
44 /// Creation of edge by the edge-shape
46 GeomAPI_Edge(const std::shared_ptr<GeomAPI_Shape>& theShape);
48 /// Return vertices of the edge;
50 void vertices(std::shared_ptr<GeomAPI_Vertex>& theStartVertex,
51 std::shared_ptr<GeomAPI_Vertex>& theEndVertex) const;
53 /// Returns \c true if edges have same underlying curve
55 virtual bool isSameGeometry(const std::shared_ptr<GeomAPI_Shape> theShape) const;
57 /// Verifies that the edge is a line
61 /// Verifies that the edge is a circle
63 bool isCircle() const;
65 /// Verifies that the edge is an arc of circle
69 /// Verifies that the edge is an arc of circle
71 bool isEllipse() const;
73 /// Returns the first vertex coordinates of the edge
75 std::shared_ptr<GeomAPI_Pnt> firstPoint();
77 /// Returns the Last vertex coordinates of the edge
79 std::shared_ptr<GeomAPI_Pnt> lastPoint();
81 /// Returns a circle if edge is based on the circle curve
83 std::shared_ptr<GeomAPI_Circ> circle() const;
85 /// Returns an ellipse if edge is based on the ellipse curve
87 std::shared_ptr<GeomAPI_Ellipse> ellipse() const;
89 /// Returns a line if edge is based on the linear curve
91 std::shared_ptr<GeomAPI_Lin> line() const;
93 /// Returns true if the current edge is geometrically equal to the given edge
95 bool isEqual(const std::shared_ptr<GeomAPI_Shape> theEdge) const;
97 /// Returns range of parameter on the curve
99 void getRange(double& theFirst, double& theLast) const;
101 /// Returns true, if the edge is fully placed in the specified plane
102 /// \param thePlane a plane for intersection
104 bool isInPlane(const std::shared_ptr<GeomAPI_Pln> thePlane) const;
106 /// Returns list of intersection points if the edge has intersections with the given plane
107 /// \param thePlane a plane for intersection
109 void intersectWithPlane(const std::shared_ptr<GeomAPI_Pln> thePlane,
110 std::list<std::shared_ptr<GeomAPI_Pnt> >& theResult) const;
112 /// Returns edge length.
114 double length() const;
116 /// Returns true if the edge is closed (like full circle)
118 bool isClosed() const;
120 /// Returns true if the edge is degenerated (has no 3D curve)
122 bool isDegenerated() const;
125 void setFirstPointTolerance(const double theTolerance);
128 void setLastPointTolerance(const double theTolerance);
130 /// Return middle point on the edge
132 virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
135 //! Pointer on object
136 typedef std::shared_ptr<GeomAPI_Edge> GeomEdgePtr;