BRepLib_ValidateEdge Class Reference

Computes the max distance between 3D-curve and curve on surface. This class uses 2 methods: approximate using finite number of points (default) and exact. More...

#include <BRepLib_ValidateEdge.hxx>

Public Member Functions
	BRepLib_ValidateEdge (const occ::handle< Adaptor3d_Curve > theReferenceCurve, const occ::handle< Adaptor3d_CurveOnSurface > theOtherCurve, bool theSameParameter)
	Initialization constructor.
void	SetExactMethod (bool theIsExact)
	Sets method to calculate distance: Calculating in finite number of points (if theIsExact is false, faster, but possible not correct result) or exact calculating by using BRepLib_CheckCurveOnSurface class (if theIsExact is true, slowly, but more correctly). Exact method is used only when edge is SameParameter. Default method is calculating in finite number of points.
bool	IsExactMethod ()
	Returns true if exact method selected.
void	SetParallel (bool theIsMultiThread)
	Sets parallel flag.
bool	IsParallel ()
	Returns true if parallel flag is set.
void	SetControlPointsNumber (int theControlPointsNumber)
	Set control points number (if you need a value other than 22)
void	SetExitIfToleranceExceeded (double theToleranceForChecking)
	Sets limit to compute a distance in the Process() function. If the distance greater than theToleranceForChecking the Process() function stopped. Use this in case checking of tolerance for best performcnce. Has no effect in case using exact method.
void	Process ()
	Computes the max distance for the 3d curve <myReferenceCurve> and curve on surface <myOtherCurve>. If the SetExitIfToleranceExceeded() function was called before <myCalculatedDistance> contains first greater than SetExitIfToleranceExceeded() parameter value. In case using exact method always computes real max distance.
bool	IsDone () const
	Returns true if the distance has been found for all points.
bool	CheckTolerance (double theToleranceToCheck)
	Returns true if computed distance is less than <theToleranceToCheck>
double	GetMaxDistance ()
	Returns max distance.
void	UpdateTolerance (double &theToleranceToUpdate)
	Increase <theToleranceToUpdate> if max distance is greater than <theToleranceToUpdate>

Detailed Description

Computes the max distance between 3D-curve and curve on surface. This class uses 2 methods: approximate using finite number of points (default) and exact.

Constructor & Destructor Documentation

BRepLib_ValidateEdge()

BRepLib_ValidateEdge::BRepLib_ValidateEdge	(	const occ::handle< Adaptor3d_Curve >	theReferenceCurve,
		const occ::handle< Adaptor3d_CurveOnSurface >	theOtherCurve,
		bool	theSameParameter )

Initialization constructor.

Member Function Documentation

CheckTolerance()

bool BRepLib_ValidateEdge::CheckTolerance

(

double

theToleranceToCheck

)

Returns true if computed distance is less than <theToleranceToCheck>

GetMaxDistance()

double BRepLib_ValidateEdge::GetMaxDistance

(

)

Returns max distance.

IsDone()

bool BRepLib_ValidateEdge::IsDone ( ) const

inline

Returns true if the distance has been found for all points.

IsExactMethod()

bool BRepLib_ValidateEdge::IsExactMethod ( )

inline

Returns true if exact method selected.

IsParallel()

bool BRepLib_ValidateEdge::IsParallel ( )

inline

Returns true if parallel flag is set.

Process()

void BRepLib_ValidateEdge::Process

(

)

Computes the max distance for the 3d curve <myReferenceCurve> and curve on surface <myOtherCurve>. If the SetExitIfToleranceExceeded() function was called before <myCalculatedDistance> contains first greater than SetExitIfToleranceExceeded() parameter value. In case using exact method always computes real max distance.

SetControlPointsNumber()

void BRepLib_ValidateEdge::SetControlPointsNumber ( int theControlPointsNumber )

inline

Set control points number (if you need a value other than 22)

SetExactMethod()

void BRepLib_ValidateEdge::SetExactMethod ( bool theIsExact )

inline

Sets method to calculate distance: Calculating in finite number of points (if theIsExact is false, faster, but possible not correct result) or exact calculating by using BRepLib_CheckCurveOnSurface class (if theIsExact is true, slowly, but more correctly). Exact method is used only when edge is SameParameter. Default method is calculating in finite number of points.

SetExitIfToleranceExceeded()

void BRepLib_ValidateEdge::SetExitIfToleranceExceeded

(

double

theToleranceForChecking

)

Sets limit to compute a distance in the Process() function. If the distance greater than theToleranceForChecking the Process() function stopped. Use this in case checking of tolerance for best performcnce. Has no effect in case using exact method.

SetParallel()

void BRepLib_ValidateEdge::SetParallel ( bool theIsMultiThread )

inline

Sets parallel flag.

UpdateTolerance()

void BRepLib_ValidateEdge::UpdateTolerance

(

double &

theToleranceToUpdate

)

Increase <theToleranceToUpdate> if max distance is greater than <theToleranceToUpdate>

---

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

• BRepLib_ValidateEdge.hxx