This class implements methods for computing all the orthogonal projections of a 2D point onto a 2D curve. More...
#include <Geom2dAPI_ProjectPointOnCurve.hxx>
Public Member Functions | |
| Geom2dAPI_ProjectPointOnCurve () | |
| Constructs an empty projector algorithm. Use an Init function to define the point and the curve on which it is going to work. | |
| Geom2dAPI_ProjectPointOnCurve (const gp_Pnt2d &P, const Handle< Geom2d_Curve > &Curve) | |
| Create the projection of a point. | |
| Geom2dAPI_ProjectPointOnCurve (const gp_Pnt2d &P, const Handle< Geom2d_Curve > &Curve, const Standard_Real Umin, const Standard_Real Usup) | |
| Create the projection of a point. | |
| void | Init (const gp_Pnt2d &P, const Handle< Geom2d_Curve > &Curve) |
| Initializes this algorithm with the given arguments, and computes the orthogonal projections of a point. | |
| void | Init (const gp_Pnt2d &P, const Handle< Geom2d_Curve > &Curve, const Standard_Real Umin, const Standard_Real Usup) |
| Initializes this algorithm with the given arguments, and computes the orthogonal projections of the point P onto the portion of the curve Curve limited by the two points of parameter Umin and Usup. | |
| Standard_Integer | NbPoints () const |
| return the number of of computed orthogonal projectionn points. | |
| operator Standard_Integer () const | |
| gp_Pnt2d | Point (const Standard_Integer Index) const |
| Returns the orthogonal projection on the curve. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points. | |
| Standard_Real | Parameter (const Standard_Integer Index) const |
| Returns the parameter on the curve of a point which is the orthogonal projection. Index is a number of a computed projected point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points. | |
| void | Parameter (const Standard_Integer Index, Standard_Real &U) const |
| Returns the parameter on the curve of a point which is the orthogonal projection. Index is a number of a computed projected point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points. | |
| Standard_Real | Distance (const Standard_Integer Index) const |
| Computes the distance between the point and its computed orthogonal projection on the curve. Index is a number of computed projected point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points. | |
| gp_Pnt2d | NearestPoint () const |
| Returns the nearest orthogonal projection of the point on the curve. Exceptions StdFail_NotDone if this algorithm fails. | |
| operator gp_Pnt2d () const | |
| Standard_Real | LowerDistanceParameter () const |
| Returns the parameter on the curve of the nearest orthogonal projection of the point. Exceptions StdFail_NotDone if this algorithm fails. | |
| Standard_Real | LowerDistance () const |
| Computes the distance between the point and its nearest orthogonal projection on the curve. Exceptions StdFail_NotDone if this algorithm fails. | |
| operator Standard_Real () const | |
| const Extrema_ExtPC2d & | Extrema () const |
| return the algorithmic object from Extrema | |
Detailed Description
This class implements methods for computing all the orthogonal projections of a 2D point onto a 2D curve.
Constructor & Destructor Documentation
◆ Geom2dAPI_ProjectPointOnCurve() [1/3]
| Geom2dAPI_ProjectPointOnCurve::Geom2dAPI_ProjectPointOnCurve | ( | ) |
Constructs an empty projector algorithm. Use an Init function to define the point and the curve on which it is going to work.
◆ Geom2dAPI_ProjectPointOnCurve() [2/3]
| Geom2dAPI_ProjectPointOnCurve::Geom2dAPI_ProjectPointOnCurve | ( | const gp_Pnt2d & | P, |
| const Handle< Geom2d_Curve > & | Curve ) |
Create the projection of a point.
on a curve <Curve>
◆ Geom2dAPI_ProjectPointOnCurve() [3/3]
| Geom2dAPI_ProjectPointOnCurve::Geom2dAPI_ProjectPointOnCurve | ( | const gp_Pnt2d & | P, |
| const Handle< Geom2d_Curve > & | Curve, | ||
| const Standard_Real | Umin, | ||
| const Standard_Real | Usup ) |
Create the projection of a point.
on a curve <Curve> limited by the two points of parameter Umin and Usup. Warning Use the function NbPoints to obtain the number of solutions. If projection fails, NbPoints returns 0.
Member Function Documentation
◆ Distance()
| Standard_Real Geom2dAPI_ProjectPointOnCurve::Distance | ( | const Standard_Integer | Index | ) | const |
Computes the distance between the point and its computed orthogonal projection on the curve. Index is a number of computed projected point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.
◆ Extrema()
| const Extrema_ExtPC2d & Geom2dAPI_ProjectPointOnCurve::Extrema | ( | ) | const |
return the algorithmic object from Extrema
◆ Init() [1/2]
| void Geom2dAPI_ProjectPointOnCurve::Init | ( | const gp_Pnt2d & | P, |
| const Handle< Geom2d_Curve > & | Curve ) |
Initializes this algorithm with the given arguments, and computes the orthogonal projections of a point.
on a curve <Curve>
◆ Init() [2/2]
| void Geom2dAPI_ProjectPointOnCurve::Init | ( | const gp_Pnt2d & | P, |
| const Handle< Geom2d_Curve > & | Curve, | ||
| const Standard_Real | Umin, | ||
| const Standard_Real | Usup ) |
Initializes this algorithm with the given arguments, and computes the orthogonal projections of the point P onto the portion of the curve Curve limited by the two points of parameter Umin and Usup.
◆ LowerDistance()
| Standard_Real Geom2dAPI_ProjectPointOnCurve::LowerDistance | ( | ) | const |
Computes the distance between the point and its nearest orthogonal projection on the curve. Exceptions StdFail_NotDone if this algorithm fails.
◆ LowerDistanceParameter()
| Standard_Real Geom2dAPI_ProjectPointOnCurve::LowerDistanceParameter | ( | ) | const |
Returns the parameter on the curve of the nearest orthogonal projection of the point. Exceptions StdFail_NotDone if this algorithm fails.
◆ NbPoints()
| Standard_Integer Geom2dAPI_ProjectPointOnCurve::NbPoints | ( | ) | const |
return the number of of computed orthogonal projectionn points.
◆ NearestPoint()
| gp_Pnt2d Geom2dAPI_ProjectPointOnCurve::NearestPoint | ( | ) | const |
Returns the nearest orthogonal projection of the point on the curve. Exceptions StdFail_NotDone if this algorithm fails.
◆ operator gp_Pnt2d()
| Geom2dAPI_ProjectPointOnCurve::operator gp_Pnt2d | ( | ) | const |
◆ operator Standard_Integer()
| Geom2dAPI_ProjectPointOnCurve::operator Standard_Integer | ( | ) | const |
◆ operator Standard_Real()
| Geom2dAPI_ProjectPointOnCurve::operator Standard_Real | ( | ) | const |
◆ Parameter() [1/2]
| Standard_Real Geom2dAPI_ProjectPointOnCurve::Parameter | ( | const Standard_Integer | Index | ) | const |
Returns the parameter on the curve of a point which is the orthogonal projection. Index is a number of a computed projected point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.
◆ Parameter() [2/2]
| void Geom2dAPI_ProjectPointOnCurve::Parameter | ( | const Standard_Integer | Index, |
| Standard_Real & | U ) const |
Returns the parameter on the curve of a point which is the orthogonal projection. Index is a number of a computed projected point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.
◆ Point()
| gp_Pnt2d Geom2dAPI_ProjectPointOnCurve::Point | ( | const Standard_Integer | Index | ) | const |
Returns the orthogonal projection on the curve. Index is a number of a computed point. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbPoints ], where NbPoints is the number of solution points.
The documentation for this class was generated from the following file:
Generated by
1.12.0