Provides various methods with Geom2d and Geom curves and surfaces. The methods of this class compute the parameter(s) of a given point on a curve or a surface. To get the valid result the point must be located rather close to the curve (surface) or at least to allow getting unambiguous result (do not put point at center of circle...), but choice of "trust" distance between curve/surface and point is responsibility of user (parameter MaxDist). Return FALSE if the point is beyond the MaxDist limit or if computation fails. More...

#include <GeomLib_Tool.hxx>

Static Public Member Functions
static Standard_Boolean	Parameter (const Handle< Geom_Curve > &Curve, const gp_Pnt &Point, const Standard_Real MaxDist, Standard_Real &U)
	Extracts the parameter of a 3D point lying on a 3D curve or at a distance less than the MaxDist value.

static Standard_Boolean	Parameters (const Handle< Geom_Surface > &Surface, const gp_Pnt &Point, const Standard_Real MaxDist, Standard_Real &U, Standard_Real &V)
	Extracts the parameter of a 3D point lying on a surface or at a distance less than the MaxDist value.

static Standard_Boolean	Parameter (const Handle< Geom2d_Curve > &Curve, const gp_Pnt2d &Point, const Standard_Real MaxDist, Standard_Real &U)
	Extracts the parameter of a 2D point lying on a 2D curve or at a distance less than the MaxDist value.

static Standard_Real	ComputeDeviation (const Geom2dAdaptor_Curve &theCurve, const Standard_Real theFPar, const Standard_Real theLPar, const Standard_Real theStartParameter, const Standard_Integer theNbIters=100, Standard_Real const thePrmOnCurve=NULL, gp_Pnt2d const thePtOnCurve=NULL, gp_Vec2d const theVecCurvLine=NULL, gp_Lin2d const theLine=NULL)
	Computes parameter in theCurve (*thePrmOnCurve) where maximal deviation between theCurve and the linear segment joining its points with the parameters theFPar and theLPar is obtained. Returns the (positive) value of deviation. Returns negative value if the deviation cannot be computed. The returned parameter (in case of successful) will always be in the range [theFPar, theLPar]. Iterative method is used for computation. So, theStartParameter is needed to be set. Recommend value of theStartParameter can be found with the overloaded method. Additionally, following values can be returned (optionally):

static Standard_Real	ComputeDeviation (const Geom2dAdaptor_Curve &theCurve, const Standard_Real theFPar, const Standard_Real theLPar, const Standard_Integer theNbSubIntervals, const Standard_Integer theNbIters=10, Standard_Real *const thePrmOnCurve=NULL)
	Computes parameter in theCurve (*thePrmOnCurve) where maximal deviation between theCurve and the linear segment joining its points with the parameters theFPar and theLPar is obtained. Returns the (positive) value of deviation. Returns negative value if the deviation cannot be computed. The returned parameter (in case of successful) will always be in the range [theFPar, theLPar]. theNbSubIntervals defines discretization of the given interval [theFPar, theLPar] to provide better search condition. This value should be chosen taking into account complexity of the curve in considered interval. E.g. if there are many oscillations of the curve in the interval then theNbSubIntervals mus be great number. However, the greater value of theNbSubIntervals the slower the algorithm will compute. theNbIters sets number of iterations. ATTENTION!!! This algorithm cannot compute deviation precisely (so, there is no point in setting big value of theNbIters). But it can give some start point for the overloaded method.

Detailed Description

Provides various methods with Geom2d and Geom curves and surfaces. The methods of this class compute the parameter(s) of a given point on a curve or a surface. To get the valid result the point must be located rather close to the curve (surface) or at least to allow getting unambiguous result (do not put point at center of circle...), but choice of "trust" distance between curve/surface and point is responsibility of user (parameter MaxDist). Return FALSE if the point is beyond the MaxDist limit or if computation fails.

Member Function Documentation

◆ ComputeDeviation() [1/2]

static Standard_Real GeomLib_Tool::ComputeDeviation	(	const Geom2dAdaptor_Curve &	theCurve,
		const Standard_Real	theFPar,
		const Standard_Real	theLPar,
		const Standard_Integer	theNbSubIntervals,
		const Standard_Integer	theNbIters = 10,
		Standard_Real *const	thePrmOnCurve = NULL )

static

Computes parameter in theCurve (*thePrmOnCurve) where maximal deviation between theCurve and the linear segment joining its points with the parameters theFPar and theLPar is obtained. Returns the (positive) value of deviation. Returns negative value if the deviation cannot be computed. The returned parameter (in case of successful) will always be in the range [theFPar, theLPar]. theNbSubIntervals defines discretization of the given interval [theFPar, theLPar] to provide better search condition. This value should be chosen taking into account complexity of the curve in considered interval. E.g. if there are many oscillations of the curve in the interval then theNbSubIntervals mus be great number. However, the greater value of theNbSubIntervals the slower the algorithm will compute. theNbIters sets number of iterations. ATTENTION!!! This algorithm cannot compute deviation precisely (so, there is no point in setting big value of theNbIters). But it can give some start point for the overloaded method.

◆ ComputeDeviation() [2/2]

static Standard_Real GeomLib_Tool::ComputeDeviation	(	const Geom2dAdaptor_Curve &	theCurve,
		const Standard_Real	theFPar,
		const Standard_Real	theLPar,
		const Standard_Real	theStartParameter,
		const Standard_Integer	theNbIters = 100,
		Standard_Real *const	thePrmOnCurve = NULL,
		gp_Pnt2d *const	thePtOnCurve = NULL,
		gp_Vec2d *const	theVecCurvLine = NULL,
		gp_Lin2d *const	theLine = NULL )

static

Computes parameter in theCurve (*thePrmOnCurve) where maximal deviation between theCurve and the linear segment joining its points with the parameters theFPar and theLPar is obtained. Returns the (positive) value of deviation. Returns negative value if the deviation cannot be computed. The returned parameter (in case of successful) will always be in the range [theFPar, theLPar]. Iterative method is used for computation. So, theStartParameter is needed to be set. Recommend value of theStartParameter can be found with the overloaded method. Additionally, following values can be returned (optionally):

Parameters

thePtOnCurve	- the point on curve where maximal deviation is achieved;
thePrmOnCurve	- the parameter of thePtOnCurve;
theVecCurvLine	- the vector along which is computed (this vector is always perpendicular theLine);
theLine	- the linear segment joining the point of theCurve having parameters theFPar and theLPar.

◆ Parameter() [1/2]

static Standard_Boolean GeomLib_Tool::Parameter	(	const Handle< Geom2d_Curve > &	Curve,
		const gp_Pnt2d &	Point,
		const Standard_Real	MaxDist,
		Standard_Real &	U )

static

Extracts the parameter of a 2D point lying on a 2D curve or at a distance less than the MaxDist value.

◆ Parameter() [2/2]

static Standard_Boolean GeomLib_Tool::Parameter	(	const Handle< Geom_Curve > &	Curve,
		const gp_Pnt &	Point,
		const Standard_Real	MaxDist,
		Standard_Real &	U )

static

Extracts the parameter of a 3D point lying on a 3D curve or at a distance less than the MaxDist value.

◆ Parameters()

static Standard_Boolean GeomLib_Tool::Parameters	(	const Handle< Geom_Surface > &	Surface,
		const gp_Pnt &	Point,
		const Standard_Real	MaxDist,
		Standard_Real &	U,
		Standard_Real &	V )

static

Extracts the parameter of a 3D point lying on a surface or at a distance less than the MaxDist value.

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

GeomLib_Tool.hxx

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ComputeDeviation() [1/2]

◆ ComputeDeviation() [2/2]

◆ Parameter() [1/2]

◆ Parameter() [2/2]

◆ Parameters()