// This file is generated by WOK (CPPExt). // Please do not edit this file; modify original file instead. // The copyright and license terms as defined for the original file apply to // this header file considered to be the "object code" form of the original source. #ifndef _GeomAPI_ExtremaCurveSurface_HeaderFile #define _GeomAPI_ExtremaCurveSurface_HeaderFile #ifndef _Standard_HeaderFile #include #endif #ifndef _Standard_Macro_HeaderFile #include #endif #ifndef _Standard_Boolean_HeaderFile #include #endif #ifndef _Standard_Integer_HeaderFile #include #endif #ifndef _Extrema_ExtCS_HeaderFile #include #endif #ifndef _Handle_Geom_Curve_HeaderFile #include #endif #ifndef _Handle_Geom_Surface_HeaderFile #include #endif #ifndef _Quantity_Parameter_HeaderFile #include #endif #ifndef _Quantity_Length_HeaderFile #include #endif class Standard_OutOfRange; class StdFail_NotDone; class Geom_Curve; class Geom_Surface; class gp_Pnt; class Extrema_ExtCS; //! Describes functions for computing all the extrema
//! between a curve and a surface.
//! An ExtremaCurveSurface algorithm minimizes or
//! maximizes the distance between a point on the curve
//! and a point on the surface. Thus, it computes start
//! and end points of perpendiculars common to the
//! curve and the surface (an intersection point is not an
//! extremum except where the curve and the surface
//! are tangential at this point).
//! Solutions consist of pairs of points, and an extremum
//! is considered to be a segment joining the two points of a solution.
//! An ExtremaCurveSurface object provides a framework for:
//! - defining the construction of the extrema,
//! - implementing the construction algorithm, and
//! - consulting the results.
//! Warning
//! In some cases, the nearest points between a curve
//! and a surface do not correspond to one of the
//! computed extrema. Instead, they may be given by:
//! - a point of a bounding curve of the surface and one of the following:
//! - its orthogonal projection on the curve,
//! - a limit point of the curve; or
//! - a limit point of the curve and its projection on the surface; or
//! - an intersection point between the curve and the surface.
class GeomAPI_ExtremaCurveSurface { public: void* operator new(size_t,void* anAddress) { return anAddress; } void* operator new(size_t size) { return Standard::Allocate(size); } void operator delete(void *anAddress) { if (anAddress) Standard::Free((Standard_Address&)anAddress); } //! Constructs an empty algorithm for computing
//! extrema between a curve and a surface. Use an
//! Init function to define the curve and the surface on
//! which it is going to work.
Standard_EXPORT GeomAPI_ExtremaCurveSurface(); //! Computes the extrema distances between the
//! curve and the surface .
Standard_EXPORT GeomAPI_ExtremaCurveSurface(const Handle(Geom_Curve)& Curve,const Handle(Geom_Surface)& Surface); //! Computes the extrema distances between the
//! curve and the surface . The solution
//! point are computed in the domain [Wmin,Wmax] of
//! the curve and in the domain [Umin,Umax]
//! [Vmin,Vmax] of the surface.
//! Warning
//! Use the function NbExtrema to obtain the number
//! of solutions. If this algorithm fails, NbExtrema returns 0.
Standard_EXPORT GeomAPI_ExtremaCurveSurface(const Handle(Geom_Curve)& Curve,const Handle(Geom_Surface)& Surface,const Quantity_Parameter Wmin,const Quantity_Parameter Wmax,const Quantity_Parameter Umin,const Quantity_Parameter Umax,const Quantity_Parameter Vmin,const Quantity_Parameter Vmax); //! Computes the extrema distances between the
//! curve and the surface .
Standard_EXPORT void Init(const Handle(Geom_Curve)& Curve,const Handle(Geom_Surface)& Surface) ; //! Computes the extrema distances between the
//! curve and the surface . The solution
//! point are computed in the domain [Wmin,Wmax] of
//! the curve and in the domain [Umin,Umax]
//! [Vmin,Vmax] of the surface.
//! Warning
//! Use the function NbExtrema to obtain the number
//! of solutions. If this algorithm fails, NbExtrema returns 0.
Standard_EXPORT void Init(const Handle(Geom_Curve)& Curve,const Handle(Geom_Surface)& Surface,const Quantity_Parameter Wmin,const Quantity_Parameter Wmax,const Quantity_Parameter Umin,const Quantity_Parameter Umax,const Quantity_Parameter Vmin,const Quantity_Parameter Vmax) ; //! Returns the number of extrema computed by this algorithm.
//! Note: if this algorithm fails, NbExtrema returns 0.
Standard_EXPORT Standard_Integer NbExtrema() const; Standard_EXPORT operator Standard_Integer() const; //! Returns the points P1 on the curve and P2 on the
//! surface, which are the ends of the extremum of index
//! Index computed by this algorithm.
//! Exceptions
//! Standard_OutOfRange if Index is not in the range [
//! 1,NbExtrema ], where NbExtrema is the
//! number of extrema computed by this algorithm.
Standard_EXPORT void Points(const Standard_Integer Index,gp_Pnt& P1,gp_Pnt& P2) const; //! Returns the parameters W of the point on the curve,
//! and (U,V) of the point on the surface, which are the
//! ends of the extremum of index Index computed by this algorithm.
//! Exceptions
//! Standard_OutOfRange if Index is not in the range [
//! 1,NbExtrema ], where NbExtrema is the
//! number of extrema computed by this algorithm.
Standard_EXPORT void Parameters(const Standard_Integer Index,Quantity_Parameter& W,Quantity_Parameter& U,Quantity_Parameter& V) const; //! Computes the distance between the end points of the
//! extremum of index Index computed by this algorithm.
//! Exceptions
//! Standard_OutOfRange if index is not in the range [
//! 1,NbExtrema ], where NbExtrema is the
//! number of extrema computed by this algorithm.
Standard_EXPORT Quantity_Length Distance(const Standard_Integer Index) const; //! Returns the points PC on the curve and PS on the
//! surface, which are the ends of the shortest extremum computed by this algorithm.
//! Exceptions - StdFail_NotDone if this algorithm fails.
Standard_EXPORT void NearestPoints(gp_Pnt& PC,gp_Pnt& PS) const; //! Returns the parameters W of the point on the curve
//! and (U,V) of the point on the surface, which are the
//! ends of the shortest extremum computed by this algorithm.
//! Exceptions - StdFail_NotDone if this algorithm fails.
Standard_EXPORT void LowerDistanceParameters(Quantity_Parameter& W,Quantity_Parameter& U,Quantity_Parameter& V) const; //! Computes the distance between the end points of the
//! shortest extremum computed by this algorithm.
//! Exceptions - StdFail_NotDone if this algorithm fails.
Standard_EXPORT Quantity_Length LowerDistance() const; Standard_EXPORT operator Standard_Real() const; //! Returns the algorithmic object from Extrema
const Extrema_ExtCS& Extrema() const; protected: private: Standard_Boolean myIsDone; Standard_Integer myIndex; Extrema_ExtCS myExtCS; }; #include // other Inline functions and methods (like "C++: function call" methods) #endif