Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

GCPnts_AbscissaPoint Class Reference

Provides an algorithm to compute a point on a curve situated at a given distance from another point on the curve, the distance being measured along the curve (curvilinear abscissa on the curve). This algorithm is also used to compute the length of a curve. An AbscissaPoint object provides a framework for: More...

#include <GCPnts_AbscissaPoint.hxx>

Public Member Functions

 GCPnts_AbscissaPoint ()
 Empty constructor. More...
 
 GCPnts_AbscissaPoint (const Adaptor3d_Curve &theC, const Standard_Real theAbscissa, const Standard_Real theU0)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. More...
 
 GCPnts_AbscissaPoint (const Standard_Real theTol, const Adaptor3d_Curve &theC, const Standard_Real theAbscissa, const Standard_Real theU0)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0 with the given tolerance. More...
 
 GCPnts_AbscissaPoint (const Standard_Real theTol, const Adaptor2d_Curve2d &theC, const Standard_Real theAbscissa, const Standard_Real theU0)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0 with the given tolerance. More...
 
 GCPnts_AbscissaPoint (const Adaptor2d_Curve2d &theC, const Standard_Real theAbscissa, const Standard_Real theU0)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. More...
 
 GCPnts_AbscissaPoint (const Adaptor3d_Curve &theC, const Standard_Real theAbscissa, const Standard_Real theU0, const Standard_Real theUi)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be close to the final solution. More...
 
 GCPnts_AbscissaPoint (const Adaptor2d_Curve2d &theC, const Standard_Real theAbscissa, const Standard_Real theU0, const Standard_Real theUi)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be closed to the final solution. More...
 
 GCPnts_AbscissaPoint (const Adaptor3d_Curve &theC, const Standard_Real theAbscissa, const Standard_Real theU0, const Standard_Real theUi, const Standard_Real theTol)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be close to the final solution. More...
 
 GCPnts_AbscissaPoint (const Adaptor2d_Curve2d &theC, const Standard_Real theAbscissa, const Standard_Real theU0, const Standard_Real theUi, const Standard_Real theTol)
 The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be close to the final solution. More...
 
Standard_Boolean IsDone () const
 True if the computation was successful, False otherwise. IsDone is a protection against: More...
 
Standard_Real Parameter () const
 Returns the parameter on the curve of the point solution of this algorithm. Exceptions StdFail_NotDone if the computation was not successful, or was not done. More...
 

Static Public Member Functions

static Standard_Real Length (const Adaptor3d_Curve &theC)
 Computes the length of the 3D Curve. More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &theC)
 Computes the length of the 2D Curve. More...
 
static Standard_Real Length (const Adaptor3d_Curve &theC, const Standard_Real theTol)
 Computes the length of the 3D Curve with the given tolerance. More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &theC, const Standard_Real theTol)
 Computes the length of the 2D Curve with the given tolerance. More...
 
static Standard_Real Length (const Adaptor3d_Curve &theC, const Standard_Real theU1, const Standard_Real theU2)
 Computes the length of the 3D Curve. More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &theC, const Standard_Real theU1, const Standard_Real theU2)
 Computes the length of the 2D Curve. More...
 
static Standard_Real Length (const Adaptor3d_Curve &theC, const Standard_Real theU1, const Standard_Real theU2, const Standard_Real theTol)
 Computes the length of the 3D Curve with the given tolerance. More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &theC, const Standard_Real theU1, const Standard_Real theU2, const Standard_Real theTol)
 Computes the length of the Curve with the given tolerance. More...
 

Detailed Description

Provides an algorithm to compute a point on a curve situated at a given distance from another point on the curve, the distance being measured along the curve (curvilinear abscissa on the curve). This algorithm is also used to compute the length of a curve. An AbscissaPoint object provides a framework for:

Constructor & Destructor Documentation

◆ GCPnts_AbscissaPoint() [1/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( )

Empty constructor.

◆ GCPnts_AbscissaPoint() [2/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor3d_Curve theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0.

◆ GCPnts_AbscissaPoint() [3/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Standard_Real  theTol,
const Adaptor3d_Curve theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0 with the given tolerance.

◆ GCPnts_AbscissaPoint() [4/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Standard_Real  theTol,
const Adaptor2d_Curve2d theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0 with the given tolerance.

◆ GCPnts_AbscissaPoint() [5/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor2d_Curve2d theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0.

◆ GCPnts_AbscissaPoint() [6/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor3d_Curve theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0,
const Standard_Real  theUi 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be close to the final solution.

◆ GCPnts_AbscissaPoint() [7/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor2d_Curve2d theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0,
const Standard_Real  theUi 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be closed to the final solution.

◆ GCPnts_AbscissaPoint() [8/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor3d_Curve theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0,
const Standard_Real  theUi,
const Standard_Real  theTol 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be close to the final solution.

◆ GCPnts_AbscissaPoint() [9/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor2d_Curve2d theC,
const Standard_Real  theAbscissa,
const Standard_Real  theU0,
const Standard_Real  theUi,
const Standard_Real  theTol 
)

The algorithm computes a point on a curve at the distance theAbscissa from the point of parameter theU0. theUi is the starting value used in the iterative process which find the solution, it must be close to the final solution.

Member Function Documentation

◆ IsDone()

Standard_Boolean GCPnts_AbscissaPoint::IsDone ( ) const
inline

True if the computation was successful, False otherwise. IsDone is a protection against:

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

◆ Length() [1/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor2d_Curve2d theC)
static

Computes the length of the 2D Curve.

◆ Length() [2/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor2d_Curve2d theC,
const Standard_Real  theTol 
)
static

Computes the length of the 2D Curve with the given tolerance.

◆ Length() [3/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor2d_Curve2d theC,
const Standard_Real  theU1,
const Standard_Real  theU2 
)
static

Computes the length of the 2D Curve.

◆ Length() [4/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor2d_Curve2d theC,
const Standard_Real  theU1,
const Standard_Real  theU2,
const Standard_Real  theTol 
)
static

Computes the length of the Curve with the given tolerance.

◆ Length() [5/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor3d_Curve theC)
static

Computes the length of the 3D Curve.

◆ Length() [6/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor3d_Curve theC,
const Standard_Real  theTol 
)
static

Computes the length of the 3D Curve with the given tolerance.

◆ Length() [7/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor3d_Curve theC,
const Standard_Real  theU1,
const Standard_Real  theU2 
)
static

Computes the length of the 3D Curve.

◆ Length() [8/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor3d_Curve theC,
const Standard_Real  theU1,
const Standard_Real  theU2,
const Standard_Real  theTol 
)
static

Computes the length of the 3D Curve with the given tolerance.

◆ Parameter()

Standard_Real GCPnts_AbscissaPoint::Parameter ( ) const
inline

Returns the parameter on the curve of the point solution of this algorithm. Exceptions StdFail_NotDone if the computation was not successful, or was not done.


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