OCC Main Page | ModelingData | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

ModelingData
TKGeomBase
GCPnts


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.
The distribution is defined:
- either by the curvilinear distance between two consecutive points
- or by a number of points.
.

#include <GCPnts_QuasiUniformAbscissa.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT GCPnts_QuasiUniformAbscissa ()
 Constructs an empty algorithm. To define the problem
to be solved, use the function Initialize.
.
Standard_EXPORT GCPnts_QuasiUniformAbscissa (Adaptor3d_Curve &C, const Standard_Integer NbPoints)
 Computes a uniform abscissa distribution of points
- on the curve C where Abscissa is the curvilinear distance between
two consecutive points of the distribution.
.
Standard_EXPORT GCPnts_QuasiUniformAbscissa (Adaptor3d_Curve &C, const Standard_Integer NbPoints, const Standard_Real U1, const Standard_Real U2)
 Computes a uniform abscissa distribution of points
on the part of curve C limited by the two parameter values U1 and U2,
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 C or the point of parameter U1. 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 C or the point of parameter U2.
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 U1 and U2 are inverted if U1 > U2 .
Warning
C 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.
.
Standard_EXPORT void Initialize (Adaptor3d_Curve &C, const Standard_Integer NbPoints)
 Initialize the algoritms with <c>, <nbpoints> and
.
Standard_EXPORT void Initialize (Adaptor3d_Curve &C, const Standard_Integer NbPoints, const Standard_Real U1, const Standard_Real U2)
 Initialize the algoritms with <c>, <abscissa>, <u1>,
<u2>.
.
Standard_EXPORT GCPnts_QuasiUniformAbscissa (Adaptor2d_Curve2d &C, const Standard_Integer NbPoints)
 Computes a uniform abscissa distribution of points on
the Curve2d <c>.
<nbpoints> defines the nomber of desired points.
.
Standard_EXPORT GCPnts_QuasiUniformAbscissa (Adaptor2d_Curve2d &C, const Standard_Integer NbPoints, const Standard_Real U1, const Standard_Real U2)
 Computes a Uniform abscissa distribution of points
on a part of the Curve2d <c>.
.
Standard_EXPORT void Initialize (Adaptor2d_Curve2d &C, const Standard_Integer NbPoints)
 Initialize the algoritms with <c>, <nbpoints> and
.
Standard_EXPORT void Initialize (Adaptor2d_Curve2d &C, const Standard_Integer NbPoints, const Standard_Real U1, const Standard_Real U2)
 Initialize the algoritms with <c>, <abscissa>, <u1>,
<u2>.
.
Standard_Boolean IsDone () const
 Returns true if the computation was successful.
IsDone is a protection against:
- non-convergence of the algorithm
- querying the results before computation.
.
Standard_Integer NbPoints () const
 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.
.
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.
.

Private Attributes

Standard_Boolean myDone
Standard_Integer myNbPoints
Standard_Real myAbscissa
Handle_TColStd_HArray1OfReal myParams


Constructor & Destructor Documentation

Standard_EXPORT GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa  ) 
 

Standard_EXPORT GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa Adaptor3d_Curve C,
const Standard_Integer  NbPoints
 

Standard_EXPORT GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa Adaptor3d_Curve C,
const Standard_Integer  NbPoints,
const Standard_Real  U1,
const Standard_Real  U2
 

Standard_EXPORT GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa Adaptor2d_Curve2d C,
const Standard_Integer  NbPoints
 

Standard_EXPORT GCPnts_QuasiUniformAbscissa::GCPnts_QuasiUniformAbscissa Adaptor2d_Curve2d C,
const Standard_Integer  NbPoints,
const Standard_Real  U1,
const Standard_Real  U2
 


Member Function Documentation

Standard_EXPORT void GCPnts_QuasiUniformAbscissa::Initialize Adaptor2d_Curve2d C,
const Standard_Integer  NbPoints,
const Standard_Real  U1,
const Standard_Real  U2
 

Standard_EXPORT void GCPnts_QuasiUniformAbscissa::Initialize Adaptor2d_Curve2d C,
const Standard_Integer  NbPoints
 

Standard_EXPORT void GCPnts_QuasiUniformAbscissa::Initialize Adaptor3d_Curve C,
const Standard_Integer  NbPoints,
const Standard_Real  U1,
const Standard_Real  U2
 

Standard_EXPORT void GCPnts_QuasiUniformAbscissa::Initialize Adaptor3d_Curve C,
const Standard_Integer  NbPoints
 

Standard_Boolean GCPnts_QuasiUniformAbscissa::IsDone  )  const [inline]
 

Standard_Integer GCPnts_QuasiUniformAbscissa::NbPoints  )  const [inline]
 

void GCPnts_QuasiUniformAbscissa::operator delete void *  anAddress  )  [inline]
 

void* GCPnts_QuasiUniformAbscissa::operator new size_t  size  )  [inline]
 

void* GCPnts_QuasiUniformAbscissa::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_Real GCPnts_QuasiUniformAbscissa::Parameter const Standard_Integer  Index  )  const [inline]
 


Field Documentation

Standard_Real GCPnts_QuasiUniformAbscissa::myAbscissa [private]
 

Standard_Boolean GCPnts_QuasiUniformAbscissa::myDone [private]
 

Standard_Integer GCPnts_QuasiUniformAbscissa::myNbPoints [private]
 

Handle_TColStd_HArray1OfReal GCPnts_QuasiUniformAbscissa::myParams [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:22:45 2008 for OpenCASCADE by  doxygen 1.4.1