Open CASCADE Technology  7.1.0.beta
Public Member Functions

Geom2dAPI_ProjectPointOnCurve Class Reference

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. More...
 
 Geom2dAPI_ProjectPointOnCurve (const gp_Pnt2d &P, const Handle< Geom2d_Curve > &Curve)
 Create the projection of a point. More...
 
 Geom2dAPI_ProjectPointOnCurve (const gp_Pnt2d &P, const Handle< Geom2d_Curve > &Curve, const Quantity_Parameter Umin, const Quantity_Parameter Usup)
 Create the projection of a point. More...
 
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. More...
 
void Init (const gp_Pnt2d &P, const Handle< Geom2d_Curve > &Curve, const Quantity_Parameter Umin, const Quantity_Parameter 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. More...
 
Standard_Integer NbPoints () const
 return the number of of computed orthogonal projectionn points. More...
 
 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. More...
 
Quantity_Parameter 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. More...
 
void Parameter (const Standard_Integer Index, Quantity_Parameter &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. More...
 
Quantity_Length 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. More...
 
gp_Pnt2d NearestPoint () const
 Returns the nearest orthogonal projection of the point on the curve. Exceptions StdFail_NotDone if this algorithm fails. More...
 
 operator gp_Pnt2d () const
 
Quantity_Parameter LowerDistanceParameter () const
 Returns the parameter on the curve of the nearest orthogonal projection of the point. Exceptions StdFail_NotDone if this algorithm fails. More...
 
Quantity_Length LowerDistance () const
 Computes the distance between the point and its nearest orthogonal projection on the curve. Exceptions StdFail_NotDone if this algorithm fails. More...
 
 operator Standard_Real () const
 
const Extrema_ExtPC2dExtrema () const
 return the algorithmic object from Extrema More...
 

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::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::Geom2dAPI_ProjectPointOnCurve ( const gp_Pnt2d P,
const Handle< Geom2d_Curve > &  Curve 
)

Create the projection of a point.

on a curve <Curve>

Geom2dAPI_ProjectPointOnCurve::Geom2dAPI_ProjectPointOnCurve ( const gp_Pnt2d P,
const Handle< Geom2d_Curve > &  Curve,
const Quantity_Parameter  Umin,
const Quantity_Parameter  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

Quantity_Length 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.

const Extrema_ExtPC2d& Geom2dAPI_ProjectPointOnCurve::Extrema ( ) const

return the algorithmic object from Extrema

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>

void Geom2dAPI_ProjectPointOnCurve::Init ( const gp_Pnt2d P,
const Handle< Geom2d_Curve > &  Curve,
const Quantity_Parameter  Umin,
const Quantity_Parameter  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.

Quantity_Length 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.

Quantity_Parameter 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.

Standard_Integer Geom2dAPI_ProjectPointOnCurve::NbPoints ( ) const

return the number of of computed orthogonal projectionn points.

gp_Pnt2d Geom2dAPI_ProjectPointOnCurve::NearestPoint ( ) const

Returns the nearest orthogonal projection of the point on the curve. Exceptions StdFail_NotDone if this algorithm fails.

Geom2dAPI_ProjectPointOnCurve::operator gp_Pnt2d ( ) const
Geom2dAPI_ProjectPointOnCurve::operator Standard_Integer ( ) const
Geom2dAPI_ProjectPointOnCurve::operator Standard_Real ( ) const
Quantity_Parameter 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.

void Geom2dAPI_ProjectPointOnCurve::Parameter ( const Standard_Integer  Index,
Quantity_Parameter 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.

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: