Open CASCADE Technology  7.3.1.dev
Public Member Functions
GeomAPI_ProjectPointOnCurve Class Reference

This class implements methods for computing all the orthogonal projections of a 3D point onto a 3D curve. More...

#include <GeomAPI_ProjectPointOnCurve.hxx>

Public Member Functions

 GeomAPI_ProjectPointOnCurve ()
 Creates an empty object. Use an Init function for further initialization. More...
 
 GeomAPI_ProjectPointOnCurve (const gp_Pnt &P, const Handle< Geom_Curve > &Curve)
 Create the projection of a point. More...
 
 GeomAPI_ProjectPointOnCurve (const gp_Pnt &P, const Handle< Geom_Curve > &Curve, const Standard_Real Umin, const Standard_Real Usup)
 Create the projection of a point. More...
 
void Init (const gp_Pnt &P, const Handle< Geom_Curve > &Curve)
 Init the projection of a point. More...
 
void Init (const gp_Pnt &P, const Handle< Geom_Curve > &Curve, const Standard_Real Umin, const Standard_Real Usup)
 Init the projection of a point. More...
 
void Init (const Handle< Geom_Curve > &Curve, const Standard_Real Umin, const Standard_Real Usup)
 Init the projection of a point. More...
 
void Perform (const gp_Pnt &P)
 Performs the projection of a point on the current curve. More...
 
Standard_Integer NbPoints () const
 Returns the number of computed orthogonal projection points. Note: if this algorithm fails, NbPoints returns 0. More...
 
 operator Standard_Integer () const
 
gp_Pnt 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...
 
Standard_Real Parameter (const Standard_Integer Index) const
 Returns the parameter on the curve of the point, which is the orthogonal projection. 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...
 
void Parameter (const Standard_Integer Index, Standard_Real &U) const
 Returns the parameter on the curve of the point, which is the orthogonal projection. 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...
 
Standard_Real Distance (const Standard_Integer Index) const
 Computes the distance between the point and its 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...
 
gp_Pnt NearestPoint () const
 Returns the nearest orthogonal projection of the point on the curve. Exceptions: StdFail_NotDone if this algorithm fails. More...
 
 operator gp_Pnt () 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. More...
 
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. More...
 
 operator Standard_Real () const
 
const Extrema_ExtPCExtrema () const
 return the algorithmic object from Extrema More...
 

Detailed Description

This class implements methods for computing all the orthogonal projections of a 3D point onto a 3D curve.

Constructor & Destructor Documentation

◆ GeomAPI_ProjectPointOnCurve() [1/3]

GeomAPI_ProjectPointOnCurve::GeomAPI_ProjectPointOnCurve ( )

Creates an empty object. Use an Init function for further initialization.

◆ GeomAPI_ProjectPointOnCurve() [2/3]

GeomAPI_ProjectPointOnCurve::GeomAPI_ProjectPointOnCurve ( const gp_Pnt P,
const Handle< Geom_Curve > &  Curve 
)

Create the projection of a point.

on a curve <Curve>

◆ GeomAPI_ProjectPointOnCurve() [3/3]

GeomAPI_ProjectPointOnCurve::GeomAPI_ProjectPointOnCurve ( const gp_Pnt P,
const Handle< Geom_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.

Member Function Documentation

◆ Distance()

Standard_Real GeomAPI_ProjectPointOnCurve::Distance ( const Standard_Integer  Index) const

Computes the distance between the point and its 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.

◆ Extrema()

const Extrema_ExtPC& GeomAPI_ProjectPointOnCurve::Extrema ( ) const

return the algorithmic object from Extrema

◆ Init() [1/3]

void GeomAPI_ProjectPointOnCurve::Init ( const gp_Pnt P,
const Handle< Geom_Curve > &  Curve 
)

Init the projection of a point.

on a curve <Curve>

◆ Init() [2/3]

void GeomAPI_ProjectPointOnCurve::Init ( const gp_Pnt P,
const Handle< Geom_Curve > &  Curve,
const Standard_Real  Umin,
const Standard_Real  Usup 
)

Init the projection of a point.

on a curve <Curve> limited by the two points of parameter Umin and Usup.

◆ Init() [3/3]

void GeomAPI_ProjectPointOnCurve::Init ( const Handle< Geom_Curve > &  Curve,
const Standard_Real  Umin,
const Standard_Real  Usup 
)

Init the projection of a point.

on a curve <Curve> limited by the two points of parameter Umin and Usup.

◆ LowerDistance()

Standard_Real GeomAPI_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 GeomAPI_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 GeomAPI_ProjectPointOnCurve::NbPoints ( ) const

Returns the number of computed orthogonal projection points. Note: if this algorithm fails, NbPoints returns 0.

◆ NearestPoint()

gp_Pnt GeomAPI_ProjectPointOnCurve::NearestPoint ( ) const

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

◆ operator gp_Pnt()

GeomAPI_ProjectPointOnCurve::operator gp_Pnt ( ) const

◆ operator Standard_Integer()

GeomAPI_ProjectPointOnCurve::operator Standard_Integer ( ) const

◆ operator Standard_Real()

GeomAPI_ProjectPointOnCurve::operator Standard_Real ( ) const

◆ Parameter() [1/2]

Standard_Real GeomAPI_ProjectPointOnCurve::Parameter ( const Standard_Integer  Index) const

Returns the parameter on the curve of the point, which is the orthogonal projection. 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.

◆ Parameter() [2/2]

void GeomAPI_ProjectPointOnCurve::Parameter ( const Standard_Integer  Index,
Standard_Real U 
) const

Returns the parameter on the curve of the point, which is the orthogonal projection. 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.-.

◆ Perform()

void GeomAPI_ProjectPointOnCurve::Perform ( const gp_Pnt P)

Performs the projection of a point on the current curve.

◆ Point()

gp_Pnt GeomAPI_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: