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

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

#include <GeomAPI_ProjectPointOnSurf.hxx>

Public Member Functions

 GeomAPI_ProjectPointOnSurf ()
 Creates an empty object. Use the Init function for further initialization. More...
 
 GeomAPI_ProjectPointOnSurf (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 Create the projection of a point. More...
 
 GeomAPI_ProjectPointOnSurf (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Standard_Real Tolerance, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 Create the projection of a point. More...
 
 GeomAPI_ProjectPointOnSurf (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real Vmin, const Standard_Real Vsup, const Standard_Real Tolerance, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 
 GeomAPI_ProjectPointOnSurf (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real Vmin, const Standard_Real Vsup, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 Init the projection of a point. More...
 
void Init (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Standard_Real Tolerance, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 
void Init (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 Init the projection of a point. More...
 
void Init (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real Vmin, const Standard_Real Vsup, const Standard_Real Tolerance, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 
void Init (const gp_Pnt &P, const Handle< Geom_Surface > &Surface, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real Vmin, const Standard_Real Vsup, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 Init the projection for many points on a surface <Surface>. The solutions will be computed in the domain [Umin,Usup] [Vmin,Vsup] of the surface. More...
 
void Init (const Handle< Geom_Surface > &Surface, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real Vmin, const Standard_Real Vsup, const Standard_Real Tolerance, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 
void Init (const Handle< Geom_Surface > &Surface, const Standard_Real Umin, const Standard_Real Usup, const Standard_Real Vmin, const Standard_Real Vsup, const Extrema_ExtAlgo Algo=Extrema_ExtAlgo_Grad)
 
void SetExtremaAlgo (const Extrema_ExtAlgo theAlgo)
 Sets the Extrema search algorithm - Grad or Tree.
By default the Extrema is initialized with Grad algorithm. More...
 
void SetExtremaFlag (const Extrema_ExtFlag theExtFlag)
 Sets the Extrema search flag - MIN or MAX or MINMAX.
By default the Extrema is set to search the MinMax solutions. More...
 
void Perform (const gp_Pnt &P)
 Performs the projection of a point on the current surface. More...
 
Standard_Boolean IsDone () const
 
Standard_Integer NbPoints () const
 Returns the number of computed orthogonal projection points. Note: if projection fails, NbPoints returns 0. More...
 
 operator Standard_Integer () const
 
gp_Pnt Point (const Standard_Integer Index) const
 Returns the orthogonal projection on the surface. 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 Parameters (const Standard_Integer Index, Standard_Real &U, Standard_Real &V) const
 Returns the parameters (U,V) on the surface of 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 surface. 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 surface. Exceptions StdFail_NotDone if projection fails. More...
 
 operator gp_Pnt () const
 
void LowerDistanceParameters (Standard_Real &U, Standard_Real &V) const
 Returns the parameters (U,V) on the surface of the nearest computed orthogonal projection of the point. Exceptions StdFail_NotDone if projection fails. More...
 
Standard_Real LowerDistance () const
 Computes the distance between the point and its nearest orthogonal projection on the surface. Exceptions StdFail_NotDone if projection fails. More...
 
 operator Standard_Real () const
 
const Extrema_ExtPSExtrema () const
 return the algorithmic object from Extrema More...
 

Detailed Description

This class implements methods for computing all the orthogonal projections of a point onto a surface.

Constructor & Destructor Documentation

◆ GeomAPI_ProjectPointOnSurf() [1/5]

GeomAPI_ProjectPointOnSurf::GeomAPI_ProjectPointOnSurf ( )

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

◆ GeomAPI_ProjectPointOnSurf() [2/5]

GeomAPI_ProjectPointOnSurf::GeomAPI_ProjectPointOnSurf ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

Create the projection of a point.

on a surface <Surface>

◆ GeomAPI_ProjectPointOnSurf() [3/5]

GeomAPI_ProjectPointOnSurf::GeomAPI_ProjectPointOnSurf ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Standard_Real  Tolerance,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

Create the projection of a point.

on a surface <Surface> Create the projection of a point

on a surface <Surface>. The solution are computed in the domain [Umin,Usup] [Vmin,Vsup] of the surface.

◆ GeomAPI_ProjectPointOnSurf() [4/5]

GeomAPI_ProjectPointOnSurf::GeomAPI_ProjectPointOnSurf ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Standard_Real  Umin,
const Standard_Real  Usup,
const Standard_Real  Vmin,
const Standard_Real  Vsup,
const Standard_Real  Tolerance,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

◆ GeomAPI_ProjectPointOnSurf() [5/5]

GeomAPI_ProjectPointOnSurf::GeomAPI_ProjectPointOnSurf ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Standard_Real  Umin,
const Standard_Real  Usup,
const Standard_Real  Vmin,
const Standard_Real  Vsup,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

Init the projection of a point.

on a surface <Surface>

Member Function Documentation

◆ Distance()

Standard_Real GeomAPI_ProjectPointOnSurf::Distance ( const Standard_Integer  Index) const

Computes the distance between the point and its orthogonal projection on the surface. 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_ExtPS& GeomAPI_ProjectPointOnSurf::Extrema ( ) const

return the algorithmic object from Extrema

◆ Init() [1/6]

void GeomAPI_ProjectPointOnSurf::Init ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Standard_Real  Tolerance,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

◆ Init() [2/6]

void GeomAPI_ProjectPointOnSurf::Init ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

Init the projection of a point.

on a surface <Surface>. The solution are computed in the domain [Umin,Usup] [Vmin,Vsup] of the surface.

◆ Init() [3/6]

void GeomAPI_ProjectPointOnSurf::Init ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Standard_Real  Umin,
const Standard_Real  Usup,
const Standard_Real  Vmin,
const Standard_Real  Vsup,
const Standard_Real  Tolerance,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

◆ Init() [4/6]

void GeomAPI_ProjectPointOnSurf::Init ( const gp_Pnt P,
const Handle< Geom_Surface > &  Surface,
const Standard_Real  Umin,
const Standard_Real  Usup,
const Standard_Real  Vmin,
const Standard_Real  Vsup,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

Init the projection for many points on a surface <Surface>. The solutions will be computed in the domain [Umin,Usup] [Vmin,Vsup] of the surface.

◆ Init() [5/6]

void GeomAPI_ProjectPointOnSurf::Init ( const Handle< Geom_Surface > &  Surface,
const Standard_Real  Umin,
const Standard_Real  Usup,
const Standard_Real  Vmin,
const Standard_Real  Vsup,
const Standard_Real  Tolerance,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

◆ Init() [6/6]

void GeomAPI_ProjectPointOnSurf::Init ( const Handle< Geom_Surface > &  Surface,
const Standard_Real  Umin,
const Standard_Real  Usup,
const Standard_Real  Vmin,
const Standard_Real  Vsup,
const Extrema_ExtAlgo  Algo = Extrema_ExtAlgo_Grad 
)

◆ IsDone()

Standard_Boolean GeomAPI_ProjectPointOnSurf::IsDone ( ) const

◆ LowerDistance()

Standard_Real GeomAPI_ProjectPointOnSurf::LowerDistance ( ) const

Computes the distance between the point and its nearest orthogonal projection on the surface. Exceptions StdFail_NotDone if projection fails.

◆ LowerDistanceParameters()

void GeomAPI_ProjectPointOnSurf::LowerDistanceParameters ( Standard_Real U,
Standard_Real V 
) const

Returns the parameters (U,V) on the surface of the nearest computed orthogonal projection of the point. Exceptions StdFail_NotDone if projection fails.

◆ NbPoints()

Standard_Integer GeomAPI_ProjectPointOnSurf::NbPoints ( ) const

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

◆ NearestPoint()

gp_Pnt GeomAPI_ProjectPointOnSurf::NearestPoint ( ) const

Returns the nearest orthogonal projection of the point on the surface. Exceptions StdFail_NotDone if projection fails.

◆ operator gp_Pnt()

GeomAPI_ProjectPointOnSurf::operator gp_Pnt ( ) const

◆ operator Standard_Integer()

GeomAPI_ProjectPointOnSurf::operator Standard_Integer ( ) const

◆ operator Standard_Real()

GeomAPI_ProjectPointOnSurf::operator Standard_Real ( ) const

◆ Parameters()

void GeomAPI_ProjectPointOnSurf::Parameters ( const Standard_Integer  Index,
Standard_Real U,
Standard_Real V 
) const

Returns the parameters (U,V) on the surface of 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_ProjectPointOnSurf::Perform ( const gp_Pnt P)

Performs the projection of a point on the current surface.

◆ Point()

gp_Pnt GeomAPI_ProjectPointOnSurf::Point ( const Standard_Integer  Index) const

Returns the orthogonal projection on the surface. 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.

◆ SetExtremaAlgo()

void GeomAPI_ProjectPointOnSurf::SetExtremaAlgo ( const Extrema_ExtAlgo  theAlgo)
inline

Sets the Extrema search algorithm - Grad or Tree.
By default the Extrema is initialized with Grad algorithm.

◆ SetExtremaFlag()

void GeomAPI_ProjectPointOnSurf::SetExtremaFlag ( const Extrema_ExtFlag  theExtFlag)
inline

Sets the Extrema search flag - MIN or MAX or MINMAX.
By default the Extrema is set to search the MinMax solutions.


The documentation for this class was generated from the following file: