Open CASCADE Technology 6.6.0
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.

#include <GeomAPI_ProjectPointOnCurve.hxx>

Public Member Functions

 GeomAPI_ProjectPointOnCurve ()
 Creates an empty object. Use an
Init function for further initialization.

 GeomAPI_ProjectPointOnCurve (const gp_Pnt &P, const Handle< Geom_Curve > &Curve)
 Create the projection of a point.
 GeomAPI_ProjectPointOnCurve (const gp_Pnt &P, const Handle< Geom_Curve > &Curve, const Quantity_Parameter Umin, const Quantity_Parameter Usup)
 Create the projection of a point.
void Init (const gp_Pnt &P, const Handle< Geom_Curve > &Curve)
 Init the projection of a point.
void Init (const gp_Pnt &P, const Handle< Geom_Curve > &Curve, const Quantity_Parameter Umin, const Quantity_Parameter Usup)
 Init the projection of a point.
void Init (const Handle< Geom_Curve > &Curve, const Quantity_Parameter Umin, const Quantity_Parameter Usup)
 Init the projection of a point.
void Perform (const gp_Pnt &P)
 Performs the projection of a point on the current curve.

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

 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.

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

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

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

gp_Pnt NearestPoint () const
 Returns the nearest orthogonal
projection of the point on the curve.
Exceptions: StdFail_NotDone if this algorithm fails.

 operator gp_Pnt () 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.

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.

 operator Standard_Real () const
const Extrema_ExtPCExtrema () const
 return the algorithmic object from Extrema


Constructor & Destructor Documentation

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

on a curve
<Curve>

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

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


Member Function Documentation

Quantity_Length GeomAPI_ProjectPointOnCurve::Distance ( const Standard_Integer  Index) const
const Extrema_ExtPC& GeomAPI_ProjectPointOnCurve::Extrema ( ) const
void GeomAPI_ProjectPointOnCurve::Init ( const gp_Pnt P,
const Handle< Geom_Curve > &  Curve 
)

on a curve
<Curve>

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

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

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

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

Quantity_Length GeomAPI_ProjectPointOnCurve::LowerDistance ( ) const
Quantity_Parameter GeomAPI_ProjectPointOnCurve::LowerDistanceParameter ( ) const
Standard_Integer GeomAPI_ProjectPointOnCurve::NbPoints ( ) const
gp_Pnt GeomAPI_ProjectPointOnCurve::NearestPoint ( ) const
GeomAPI_ProjectPointOnCurve::operator gp_Pnt ( ) const
GeomAPI_ProjectPointOnCurve::operator Standard_Integer ( ) const
GeomAPI_ProjectPointOnCurve::operator Standard_Real ( ) const
void GeomAPI_ProjectPointOnCurve::Parameter ( const Standard_Integer  Index,
Quantity_Parameter U 
) const
Quantity_Parameter GeomAPI_ProjectPointOnCurve::Parameter ( const Standard_Integer  Index) const
void GeomAPI_ProjectPointOnCurve::Perform ( const gp_Pnt P)
gp_Pnt GeomAPI_ProjectPointOnCurve::Point ( const Standard_Integer  Index) const

The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines