1 // Copyright (C) 2014-2017 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
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GeomAPI_Edge_H_
22 #define GeomAPI_Edge_H_
24 #include <GeomAPI_Shape.h>
30 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 /// Verifies that the edge is a line
52 /// Verifies that the edge is a circle
54 bool isCircle() const;
56 /// Verifies that the edge is an arc of circle
60 /// Verifies that the edge is an arc of circle
62 bool isEllipse() const;
64 /// Returns the first vertex coordinates of the edge
66 std::shared_ptr<GeomAPI_Pnt> firstPoint();
68 /// Returns the Last vertex coordinates of the edge
70 std::shared_ptr<GeomAPI_Pnt> lastPoint();
72 /// Returns a circle if edge is based on the circle curve
74 std::shared_ptr<GeomAPI_Circ> circle() const;
76 /// Returns an ellipse if edge is based on the ellipse curve
78 std::shared_ptr<GeomAPI_Ellipse> ellipse() const;
80 /// Returns a line if edge is based on the linear curve
82 std::shared_ptr<GeomAPI_Lin> line() const;
84 /// Returns true if the current edge is geometrically equal to the given edge
86 bool isEqual(const std::shared_ptr<GeomAPI_Shape> theEdge) const;
88 /// Returns range of parameter on the curve
90 void getRange(double& theFirst, double& theLast) const;
92 /// Returns true, if the edge is fully placed in the specified plane
93 /// \param thePlane a plane for intersection
95 bool isInPlane(const std::shared_ptr<GeomAPI_Pln> thePlane) const;
97 /// Returns list of intersection points if the edge has intersections with the given plane
98 /// \param thePlane a plane for intersection
100 void intersectWithPlane(const std::shared_ptr<GeomAPI_Pln> thePlane,
101 std::list<std::shared_ptr<GeomAPI_Pnt> >& theResult) const;
103 /// Returns edge length.
105 double length() const;
107 /// Returns true if the edge is closed (like full circle)
109 bool isClosed() const;
111 /// Returns true if the edge is degenerated (has no 3D curve)
113 bool isDegenerated() const;
116 void setFirstPointTolerance(const double theTolerance);
119 void setLastPointTolerance(const double theTolerance);
121 /// Return middle point on the edge
123 virtual std::shared_ptr<GeomAPI_Pnt> middlePoint() const;
126 //! Pointer on attribute object
127 typedef std::shared_ptr<GeomAPI_Edge> GeomEdgePtr;