OCC Main Page | ModelingAlgorithms | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingAlgorithms
TKGeomAlgo
GeomAPI


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

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT GeomAPI_ProjectPointOnCurve ()
 Creates an empty object. Use an
Init function for further initialization.
.
Standard_EXPORT GeomAPI_ProjectPointOnCurve (const gp_Pnt &P, const Handle(Geom_Curve)&Curve)
 Create the projection of a point

on a curve
<curve>
.

Standard_EXPORT 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

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

Standard_EXPORT void Init (const gp_Pnt &P, const Handle(Geom_Curve)&Curve)
 Init the projection of a point

on a curve
<curve>
.

Standard_EXPORT 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

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

Standard_EXPORT void Init (const Handle(Geom_Curve)&Curve, const Quantity_Parameter Umin, const Quantity_Parameter Usup)
 Init the projection of a point

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

Standard_EXPORT void Perform (const gp_Pnt &P)
 Performs the projection of a point on the current curve.
.
Standard_EXPORT Standard_Integer NbPoints () const
 Returns the number of computed
orthogonal projection points.
Note: if this algorithm fails, NbPoints returns 0.
.
Standard_EXPORT operator Standard_Integer () const
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT 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.-
.
Standard_EXPORT 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.
.
Standard_EXPORT gp_Pnt NearestPoint () const
 Returns the nearest orthogonal
projection of the point on the curve.
Exceptions: StdFail_NotDone if this algorithm fails.
.
Standard_EXPORT operator gp_Pnt () const
Standard_EXPORT 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.
.
Standard_EXPORT 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.
.
Standard_EXPORT operator Standard_Real () const
const Extrema_ExtPC & Extrema () const
 return the algorithmic object from Extrema


Private Attributes

Standard_Boolean myIsDone
Standard_Integer myIndex
Extrema_ExtPC myExtPC
GeomAdaptor_Curve myC


Constructor & Destructor Documentation

Standard_EXPORT GeomAPI_ProjectPointOnCurve::GeomAPI_ProjectPointOnCurve  ) 
 

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

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


Member Function Documentation

Standard_EXPORT Quantity_Length GeomAPI_ProjectPointOnCurve::Distance const Standard_Integer  Index  )  const
 

const Extrema_ExtPC & GeomAPI_ProjectPointOnCurve::Extrema  )  const [inline]
 

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

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

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

Standard_EXPORT Quantity_Length GeomAPI_ProjectPointOnCurve::LowerDistance  )  const
 

Standard_EXPORT Quantity_Parameter GeomAPI_ProjectPointOnCurve::LowerDistanceParameter  )  const
 

Standard_EXPORT Standard_Integer GeomAPI_ProjectPointOnCurve::NbPoints  )  const
 

Standard_EXPORT gp_Pnt GeomAPI_ProjectPointOnCurve::NearestPoint  )  const
 

void GeomAPI_ProjectPointOnCurve::operator delete void *  anAddress  )  [inline]
 

Standard_EXPORT GeomAPI_ProjectPointOnCurve::operator gp_Pnt  )  const
 

void* GeomAPI_ProjectPointOnCurve::operator new size_t  size  )  [inline]
 

void* GeomAPI_ProjectPointOnCurve::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_EXPORT GeomAPI_ProjectPointOnCurve::operator Standard_Integer  )  const
 

Standard_EXPORT GeomAPI_ProjectPointOnCurve::operator Standard_Real  )  const
 

Standard_EXPORT void GeomAPI_ProjectPointOnCurve::Parameter const Standard_Integer  Index,
Quantity_Parameter &  U
const
 

Standard_EXPORT Quantity_Parameter GeomAPI_ProjectPointOnCurve::Parameter const Standard_Integer  Index  )  const
 

Standard_EXPORT void GeomAPI_ProjectPointOnCurve::Perform const gp_Pnt &  P  ) 
 

Standard_EXPORT gp_Pnt GeomAPI_ProjectPointOnCurve::Point const Standard_Integer  Index  )  const
 


Field Documentation

GeomAdaptor_Curve GeomAPI_ProjectPointOnCurve::myC [private]
 

Extrema_ExtPC GeomAPI_ProjectPointOnCurve::myExtPC [private]
 

Standard_Integer GeomAPI_ProjectPointOnCurve::myIndex [private]
 

Standard_Boolean GeomAPI_ProjectPointOnCurve::myIsDone [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:41:49 2008 for OpenCASCADE by  doxygen 1.4.1