Open CASCADE Technology  7.3.0
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 ()
 
 GCPnts_AbscissaPoint (const Adaptor3d_Curve &C, const Standard_Real Abscissa, const Standard_Real U0)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. More...
 
 GCPnts_AbscissaPoint (const Standard_Real Tol, const Adaptor3d_Curve &C, const Standard_Real Abscissa, const Standard_Real U0)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0> with the given tolerance. More...
 
 GCPnts_AbscissaPoint (const Standard_Real Tol, const Adaptor2d_Curve2d &C, const Standard_Real Abscissa, const Standard_Real U0)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0> with the given tolerance. More...
 
 GCPnts_AbscissaPoint (const Adaptor2d_Curve2d &C, const Standard_Real Abscissa, const Standard_Real U0)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. More...
 
 GCPnts_AbscissaPoint (const Adaptor3d_Curve &C, const Standard_Real Abscissa, const Standard_Real U0, const Standard_Real Ui)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 &C, const Standard_Real Abscissa, const Standard_Real U0, const Standard_Real Ui)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 &C, const Standard_Real Abscissa, const Standard_Real U0, const Standard_Real Ui, const Standard_Real Tol)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 &C, const Standard_Real Abscissa, const Standard_Real U0, const Standard_Real Ui, const Standard_Real Tol)
 the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 &C)
 Computes the length of the Curve . More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &C)
 Computes the length of the Curve . More...
 
static Standard_Real Length (const Adaptor3d_Curve &C, const Standard_Real Tol)
 Computes the length of the Curve with the given tolerance. More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &C, const Standard_Real Tol)
 Computes the length of the Curve with the given tolerance. More...
 
static Standard_Real Length (const Adaptor3d_Curve &C, const Standard_Real U1, const Standard_Real U2)
 Computes the length of the Curve . More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &C, const Standard_Real U1, const Standard_Real U2)
 Computes the length of the Curve . More...
 
static Standard_Real Length (const Adaptor3d_Curve &C, const Standard_Real U1, const Standard_Real U2, const Standard_Real Tol)
 Computes the length of the Curve with the given tolerance. More...
 
static Standard_Real Length (const Adaptor2d_Curve2d &C, const Standard_Real U1, const Standard_Real U2, const Standard_Real Tol)
 Computes the length of the Curve with the given tolerance. Constructs an empty algorithm. This function is used only for initializing a framework to compute the length of a curve (or a series of curves). Warning The function IsDone will return the value false after the use of this function. 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 ( )

◆ GCPnts_AbscissaPoint() [2/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor3d_Curve C,
const Standard_Real  Abscissa,
const Standard_Real  U0 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>.

◆ GCPnts_AbscissaPoint() [3/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Standard_Real  Tol,
const Adaptor3d_Curve C,
const Standard_Real  Abscissa,
const Standard_Real  U0 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0> with the given tolerance.

◆ GCPnts_AbscissaPoint() [4/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Standard_Real  Tol,
const Adaptor2d_Curve2d C,
const Standard_Real  Abscissa,
const Standard_Real  U0 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0> with the given tolerance.

◆ GCPnts_AbscissaPoint() [5/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor2d_Curve2d C,
const Standard_Real  Abscissa,
const Standard_Real  U0 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>.

◆ GCPnts_AbscissaPoint() [6/9]

GCPnts_AbscissaPoint::GCPnts_AbscissaPoint ( const Adaptor3d_Curve C,
const Standard_Real  Abscissa,
const Standard_Real  U0,
const Standard_Real  Ui 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 C,
const Standard_Real  Abscissa,
const Standard_Real  U0,
const Standard_Real  Ui 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 C,
const Standard_Real  Abscissa,
const Standard_Real  U0,
const Standard_Real  Ui,
const Standard_Real  Tol 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 C,
const Standard_Real  Abscissa,
const Standard_Real  U0,
const Standard_Real  Ui,
const Standard_Real  Tol 
)

the algorithm computes a point on a curve <Curve> at the distance <Abscissa> from the point of parameter <U0>. <Ui> 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 Adaptor3d_Curve C)
static

Computes the length of the Curve .

◆ Length() [2/8]

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

Computes the length of the Curve .

◆ Length() [3/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor3d_Curve C,
const Standard_Real  Tol 
)
static

Computes the length of the Curve with the given tolerance.

◆ Length() [4/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor2d_Curve2d C,
const Standard_Real  Tol 
)
static

Computes the length of the Curve with the given tolerance.

◆ Length() [5/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor3d_Curve C,
const Standard_Real  U1,
const Standard_Real  U2 
)
static

Computes the length of the Curve .

◆ Length() [6/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor2d_Curve2d C,
const Standard_Real  U1,
const Standard_Real  U2 
)
static

Computes the length of the Curve .

◆ Length() [7/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor3d_Curve C,
const Standard_Real  U1,
const Standard_Real  U2,
const Standard_Real  Tol 
)
static

Computes the length of the Curve with the given tolerance.

◆ Length() [8/8]

static Standard_Real GCPnts_AbscissaPoint::Length ( const Adaptor2d_Curve2d C,
const Standard_Real  U1,
const Standard_Real  U2,
const Standard_Real  Tol 
)
static

Computes the length of the Curve with the given tolerance. Constructs an empty algorithm. This function is used only for initializing a framework to compute the length of a curve (or a series of curves). Warning The function IsDone will return the value false after the use of this function.

◆ 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: