GCPnts_UniformDeflection Class Reference

Provides an algorithm to compute a distribution of
points on a 'C2' continuous curve. The algorithm
respects a criterion of maximum deflection between
the curve and the polygon that results from the computed points.
Note: This algorithm is relatively time consuming. A
GCPnts_QuasiUniformDeflection algorithm is
quicker; it can also work with non-'C2' continuous
curves, but it generates more points in the distribution.
More...

#include <GCPnts_UniformDeflection.hxx>

Public Member Functions
	GCPnts_UniformDeflection ()
	Constructs an empty algorithm. To define the problem <br> to be solved, use the function Initialize. More...
	GCPnts_UniformDeflection (Adaptor3d_Curve &C, const Standard_Real Deflection, const Standard_Boolean WithControl=Standard_True)
	Computes a uniform Deflection distribution of points on <br> the Curve . if <WithControl> is True,the algorithm controls the estimate deflection More...
	GCPnts_UniformDeflection (Adaptor2d_Curve2d &C, const Standard_Real Deflection, const Standard_Boolean WithControl=Standard_True)
	Computes a uniform Deflection distribution of points on <br> the Curve . if <WithControl> is True,the algorithm controls the estimate deflection More...
	GCPnts_UniformDeflection (Adaptor3d_Curve &C, const Standard_Real Deflection, const Standard_Real U1, const Standard_Real U2, const Standard_Boolean WithControl=Standard_True)
	Computes a Uniform Deflection distribution of points <br> on a part of the Curve . if <WithControl> is True,the algorithm controls the estimate deflection More...
	GCPnts_UniformDeflection (Adaptor2d_Curve2d &C, const Standard_Real Deflection, const Standard_Real U1, const Standard_Real U2, const Standard_Boolean WithControl=Standard_True)
	Computes a Uniform Deflection distribution of points <br> on a part of the Curve . if <WithControl> is True,the algorithm controls the estimate deflection More...
void	Initialize (Adaptor3d_Curve &C, const Standard_Real Deflection, const Standard_Boolean WithControl=Standard_True)
	Initialize the algoritms with , <Deflection> More...
void	Initialize (Adaptor2d_Curve2d &C, const Standard_Real Deflection, const Standard_Boolean WithControl=Standard_True)
	Initialize the algoritms with , <Deflection> More...
void	Initialize (Adaptor3d_Curve &C, const Standard_Real Deflection, const Standard_Real U1, const Standard_Real U2, const Standard_Boolean WithControl=Standard_True)
	Initialize the algoritms with , <Deflection>, <U1>,<U2> More...
void	Initialize (Adaptor2d_Curve2d &C, const Standard_Real Deflection, const Standard_Real U1, const Standard_Real U2, const Standard_Boolean WithControl=Standard_True)
	Initialize the algoritms with <C>, <Deflection>, <br> <U1>,<U2> <br> This and the above methods initialize (or reinitialize) this algorithm and compute a distribution of points: More...
Standard_Boolean	IsDone () const
	Returns true if the computation was successful. <br> IsDone is a protection against: More...
Standard_Integer	NbPoints () const
	Returns the number of points of the distribution <br> computed by this algorithm. Exceptions StdFail_NotDone if this algorithm has not been initialized, or if the computation was not successful. More...
Standard_Real	Parameter (const Standard_Integer Index) const
	Returns the parameter of the point of index Index in <br> 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. More...
gp_Pnt	Value (const Standard_Integer Index) const
	Returns the point of index Index in the distribution <br> 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. More...
Standard_Real	Deflection () const
	Returns the deflection between the curve and the <br> polygon resulting from the points of the distribution computed by this algorithm. This value is the one given to 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. More...

Detailed Description

Provides an algorithm to compute a distribution of
points on a 'C2' continuous curve. The algorithm
respects a criterion of maximum deflection between
the curve and the polygon that results from the computed points.
Note: This algorithm is relatively time consuming. A
GCPnts_QuasiUniformDeflection algorithm is
quicker; it can also work with non-'C2' continuous
curves, but it generates more points in the distribution.

Constructor & Destructor Documentation

GCPnts_UniformDeflection::GCPnts_UniformDeflection

(

)

 Constructs an empty algorithm. To define the problem <br>

to be solved, use the function Initialize.

GCPnts_UniformDeflection::GCPnts_UniformDeflection	(	Adaptor3d_Curve &	C,
		const Standard_Real	Deflection,
		const Standard_Boolean	WithControl = Standard_True
	)

Computes a uniform Deflection distribution of points on <br>

the Curve .
if <WithControl> is True,the algorithm controls the estimate
deflection


GCPnts_UniformDeflection::GCPnts_UniformDeflection	(	Adaptor2d_Curve2d &	C,
		const Standard_Real	Deflection,
		const Standard_Boolean	WithControl = Standard_True
	)

Computes a uniform Deflection distribution of points on <br>

the Curve .
if <WithControl> is True,the algorithm controls the estimate
deflection


GCPnts_UniformDeflection::GCPnts_UniformDeflection	(	Adaptor3d_Curve &	C,
		const Standard_Real	Deflection,
		const Standard_Real	U1,
		const Standard_Real	U2,
		const Standard_Boolean	WithControl = Standard_True
	)

Computes a Uniform Deflection distribution of points <br>

on a part of the Curve .
if <WithControl> is True,the algorithm controls the estimate
deflection


GCPnts_UniformDeflection::GCPnts_UniformDeflection	(	Adaptor2d_Curve2d &	C,
		const Standard_Real	Deflection,
		const Standard_Real	U1,
		const Standard_Real	U2,
		const Standard_Boolean	WithControl = Standard_True
	)

Computes a Uniform Deflection distribution of points <br>

on a part of the Curve .
if <WithControl> is True,the algorithm controls the estimate
deflection


Member Function Documentation

Standard_Real GCPnts_UniformDeflection::Deflection

(

)

const

 Returns the deflection between the curve and the <br>

polygon resulting from the points of the distribution
computed by this algorithm.
This value is the one given to 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.

void GCPnts_UniformDeflection::Initialize	(	Adaptor3d_Curve &	C,
		const Standard_Real	Deflection,
		const Standard_Boolean	WithControl = Standard_True
	)

Initialize the algoritms with , <Deflection>


void GCPnts_UniformDeflection::Initialize	(	Adaptor2d_Curve2d &	C,
		const Standard_Real	Deflection,
		const Standard_Boolean	WithControl = Standard_True
	)

Initialize the algoritms with , <Deflection>


void GCPnts_UniformDeflection::Initialize	(	Adaptor3d_Curve &	C,
		const Standard_Real	Deflection,
		const Standard_Real	U1,
		const Standard_Real	U2,
		const Standard_Boolean	WithControl = Standard_True
	)

Initialize the algoritms with , <Deflection>,
<U1>,<U2>


void GCPnts_UniformDeflection::Initialize	(	Adaptor2d_Curve2d &	C,
		const Standard_Real	Deflection,
		const Standard_Real	U1,
		const Standard_Real	U2,
		const Standard_Boolean	WithControl = Standard_True
	)

 Initialize the algoritms with <C>, <Deflection>, <br>
     <U1>,<U2> <br>

This and the above methods initialize (or reinitialize) this algorithm and
compute a distribution of points:

• on the curve C, or
  
• on the part of curve C limited by the two
  parameter values U1 and U2,
  where the maximum distance between C and the
  polygon that results from the points of the
  distribution is not greater than Deflection.
  The first point of the distribution is either the origin
  of curve C or the point of parameter U1. The last
  point of the distribution is either the end point of
  curve C or the point of parameter U2. Intermediate
  points of the distribution are built using
  interpolations of segments of the curve limited at
  the 2nd degree. The construction ensures, in a first
  step, that the chordal deviation for this
  interpolation of the curve is less than or equal to
  Deflection. However, it does not ensure that the
  chordal deviation for the curve itself is less than or
  equal to Deflection. To do this a check is
  necessary, which may generate (second step)
  additional intermediate points. This check is time
  consuming, and can be avoided by setting
  WithControl to false. Note that by default
  WithControl is true and check is performed.
  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
  
• C is necessary, 'C2' continuous. This property is
  not checked at construction time.
  
• The roles of U1 and U2 are inverted if U1 > U2.
  Warning
  C is an adapted curve, i.e. 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.
  

Standard_Boolean GCPnts_UniformDeflection::IsDone

(

)

const

 Returns true if the computation was successful. <br>

IsDone is a protection against:

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

Standard_Integer GCPnts_UniformDeflection::NbPoints

(

)

const

 Returns the number of points of the distribution <br>

computed by this algorithm.
Exceptions
StdFail_NotDone if this algorithm has not been
initialized, or if the computation was not successful.

Standard_Real GCPnts_UniformDeflection::Parameter

(

const Standard_Integer

Index

)

const

 Returns the parameter of the point of index Index in <br>

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.

gp_Pnt GCPnts_UniformDeflection::Value

(

const Standard_Integer

Index

)

const

 Returns the point of index Index in the distribution <br>

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_UniformDeflection.hxx