GCPnts_QuasiUniformAbscissa Class Reference

This class provides an algorithm to compute a uniform abscissa distribution of points on a curve, i.e. a sequence of equidistant points. The distance between two consecutive points is measured along the curve. More...

#include <GCPnts_QuasiUniformAbscissa.hxx>

Public Member Functions
	GCPnts_QuasiUniformAbscissa ()
	Constructs an empty algorithm. To define the problem to be solved, use the function Initialize.
	GCPnts_QuasiUniformAbscissa (const Adaptor3d_Curve &theC, const Standard_Integer theNbPoints)
	Computes a uniform abscissa distribution of points.
	GCPnts_QuasiUniformAbscissa (const Adaptor3d_Curve &theC, const Standard_Integer theNbPoints, const Standard_Real theU1, const Standard_Real theU2)
	Computes a uniform abscissa distribution of points on the part of curve limited by the two parameter values theU1 and theU2, where Abscissa is the curvilinear distance between two consecutive points of the distribution. The first point of the distribution is either the origin of curve or the point of parameter theU1. The following points are computed such that the curvilinear distance between two consecutive points is equal to Abscissa. The last point of the distribution is either the end point of curve or the point of parameter theU2. However the curvilinear distance between this last point and the point just preceding it in the distribution is, of course, generally not equal to Abscissa. Use the function IsDone() to verify that the computation was successful, the function NbPoints() to obtain the number of points of the computed distribution, and the function Parameter() to read the parameter of each point.
void	Initialize (const Adaptor3d_Curve &theC, const Standard_Integer theNbPoints)
	Initialize the algorithms with 3D curve and target number of points.
void	Initialize (const Adaptor3d_Curve &theC, const Standard_Integer theNbPoints, const Standard_Real theU1, const Standard_Real theU2)
	Initialize the algorithms with 3D curve, target number of points and curve parameter range.
	GCPnts_QuasiUniformAbscissa (const Adaptor2d_Curve2d &theC, const Standard_Integer theNbPoints)
	Computes a uniform abscissa distribution of points on the 2D curve.
	GCPnts_QuasiUniformAbscissa (const Adaptor2d_Curve2d &theC, const Standard_Integer theNbPoints, const Standard_Real theU1, const Standard_Real theU2)
	Computes a Uniform abscissa distribution of points on a part of the 2D curve.
void	Initialize (const Adaptor2d_Curve2d &theC, const Standard_Integer theNbPoints)
	Initialize the algorithms with 2D curve and target number of points.
void	Initialize (const Adaptor2d_Curve2d &theC, const Standard_Integer theNbPoints, const Standard_Real theU1, const Standard_Real theU2)
	Initialize the algorithms with 2D curve, target number of points and curve parameter range.
Standard_Boolean	IsDone () const
	Returns true if the computation was successful. IsDone is a protection against:
Standard_Integer	NbPoints () const
	Returns the number of points of the distribution computed by this algorithm. This value is either:
Standard_Real	Parameter (const Standard_Integer Index) const
	Returns the parameter of the point of index Index in the distribution computed by this algorithm. Warning Index must be greater than or equal to 1, and less than or equal to the number of points of the distribution. However, pay particular attention as this condition is not checked by this function. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.

Detailed Description

This class provides an algorithm to compute a uniform abscissa distribution of points on a curve, i.e. a sequence of equidistant points. The distance between two consecutive points is measured along the curve.

The distribution is defined by a number of points.

Constructor & Destructor Documentation

GCPnts_QuasiUniformAbscissa() [1/5]

GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa

(

)

Constructs an empty algorithm. To define the problem to be solved, use the function Initialize.

GCPnts_QuasiUniformAbscissa() [2/5]

GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa	(	const Adaptor3d_Curve &	theC,
		const Standard_Integer	theNbPoints )

Computes a uniform abscissa distribution of points.

• on the curve where Abscissa is the curvilinear distance between two consecutive points of the distribution.

GCPnts_QuasiUniformAbscissa() [3/5]

GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa	(	const Adaptor3d_Curve &	theC,
		const Standard_Integer	theNbPoints,
		const Standard_Real	theU1,
		const Standard_Real	theU2 )

Computes a uniform abscissa distribution of points on the part of curve limited by the two parameter values theU1 and theU2, where Abscissa is the curvilinear distance between two consecutive points of the distribution. The first point of the distribution is either the origin of curve or the point of parameter theU1. The following points are computed such that the curvilinear distance between two consecutive points is equal to Abscissa. The last point of the distribution is either the end point of curve or the point of parameter theU2. However the curvilinear distance between this last point and the point just preceding it in the distribution is, of course, generally not equal to Abscissa. Use the function IsDone() to verify that the computation was successful, the function NbPoints() to obtain the number of points of the computed distribution, and the function Parameter() to read the parameter of each point.

Warning The roles of theU1 and theU2 are inverted if theU1 > theU2. Warning theC is an adapted curve, that is, an object which is an interface between:

• the services provided by either a 2D curve from the package Geom2d (in the case of an Adaptor2d_Curve2d curve) or a 3D curve from the package Geom (in the case of an Adaptor3d_Curve curve),
• and those required on the curve by the computation algorithm.

  Parameters

  theC	[in] input 3D curve
  theNbPoints	[in] defines the number of desired points
  theU1	[in] first parameter on curve
  theU2	[in] last parameter on curve

GCPnts_QuasiUniformAbscissa() [4/5]

GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa	(	const Adaptor2d_Curve2d &	theC,
		const Standard_Integer	theNbPoints )

Computes a uniform abscissa distribution of points on the 2D curve.

Parameters

theC	[in] input 2D curve
theNbPoints	[in] defines the number of desired points

GCPnts_QuasiUniformAbscissa() [5/5]

GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa	(	const Adaptor2d_Curve2d &	theC,
		const Standard_Integer	theNbPoints,
		const Standard_Real	theU1,
		const Standard_Real	theU2 )

Computes a Uniform abscissa distribution of points on a part of the 2D curve.

Parameters

theC	[in] input 2D curve
theNbPoints	[in] defines the number of desired points
theU1	[in] first parameter on curve
theU2	[in] last parameter on curve

Member Function Documentation

Initialize() [1/4]

void GCPnts_QuasiUniformAbscissa::Initialize	(	const Adaptor2d_Curve2d &	theC,
		const Standard_Integer	theNbPoints )

Initialize the algorithms with 2D curve and target number of points.

Parameters

theC	[in] input 2D curve
theNbPoints	[in] defines the number of desired points

Initialize() [2/4]

void GCPnts_QuasiUniformAbscissa::Initialize	(	const Adaptor2d_Curve2d &	theC,
		const Standard_Integer	theNbPoints,
		const Standard_Real	theU1,
		const Standard_Real	theU2 )

Initialize the algorithms with 2D curve, target number of points and curve parameter range.

Parameters

theC	[in] input 2D curve
theNbPoints	[in] defines the number of desired points
theU1	[in] first parameter on curve
theU2	[in] last parameter on curve

Initialize() [3/4]

void GCPnts_QuasiUniformAbscissa::Initialize	(	const Adaptor3d_Curve &	theC,
		const Standard_Integer	theNbPoints )

Initialize the algorithms with 3D curve and target number of points.

Parameters

theC	[in] input 3D curve
theNbPoints	[in] defines the number of desired points

Initialize() [4/4]

void GCPnts_QuasiUniformAbscissa::Initialize	(	const Adaptor3d_Curve &	theC,
		const Standard_Integer	theNbPoints,
		const Standard_Real	theU1,
		const Standard_Real	theU2 )

Initialize the algorithms with 3D curve, target number of points and curve parameter range.

Parameters

theC	[in] input 3D curve
theNbPoints	[in] defines the number of desired points
theU1	[in] first parameter on curve
theU2	[in] last parameter on curve

IsDone()

Standard_Boolean GCPnts_QuasiUniformAbscissa::IsDone ( ) const

inline

Returns true if the computation was successful. IsDone is a protection against:

• non-convergence of the algorithm
• querying the results before computation.

NbPoints()

Standard_Integer GCPnts_QuasiUniformAbscissa::NbPoints ( ) const

inline

Returns the number of points of the distribution computed by this algorithm. This value is either:

• the one imposed on the algorithm at the time of construction (or initialization), or
• the one computed by the algorithm when the curvilinear distance between two consecutive points of the distribution is imposed on the algorithm at the time of construction (or initialization). Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.

Parameter()

Standard_Real GCPnts_QuasiUniformAbscissa::Parameter ( const Standard_Integer Index ) const

inline

Returns the parameter of the point of index Index in the distribution computed by this algorithm. Warning Index must be greater than or equal to 1, and less than or equal to the number of points of the distribution. However, pay particular attention as this condition is not checked by this function. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful.

---

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

• GCPnts_QuasiUniformAbscissa.hxx