Open CASCADE Technology  7.3.1.dev
Public Member Functions
Geom2dAPI_Interpolate Class Reference

This class is used to interpolate a BsplineCurve passing through an array of points, with a C2 Continuity if tangency is not requested at the point. If tangency is requested at the point the continuity will be C1. If Perodicity is requested the curve will be closed and the junction will be the first point given. The curve will than be only C1 The curve is defined by a table of points through which it passes, and if required by a parallel table of reals which gives the value of the parameter of each point through which the resulting BSpline curve passes, and by vectors tangential to these points. An Interpolate object provides a framework for: defining the constraints of the BSpline curve,. More...

#include <Geom2dAPI_Interpolate.hxx>

Public Member Functions

 Geom2dAPI_Interpolate (const Handle< TColgp_HArray1OfPnt2d > &Points, const Standard_Boolean PeriodicFlag, const Standard_Real Tolerance)
 Tolerance is to check if the points are not too close to one an other It is also used to check if the tangent vector is not too small. There should be at least 2 points if PeriodicFlag is True then the curve will be periodic. More...
 
 Geom2dAPI_Interpolate (const Handle< TColgp_HArray1OfPnt2d > &Points, const Handle< TColStd_HArray1OfReal > &Parameters, const Standard_Boolean PeriodicFlag, const Standard_Real Tolerance)
 if PeriodicFlag is True then the curve will be periodic Warning: There should be as many parameters as there are points except if PeriodicFlag is True : then there should be one more parameter to close the curve More...
 
void Load (const gp_Vec2d &InitialTangent, const gp_Vec2d &FinalTangent, const Standard_Boolean Scale=Standard_True)
 Assigns this constrained BSpline curve to be tangential to vectors InitialTangent and FinalTangent at its first and last points respectively (i.e. the first and last points of the table of points through which the curve passes, as defined at the time of initialization). <Scale> - boolean flag defining whether tangent vectors are to be scaled according to derivatives of lagrange interpolation. More...
 
void Load (const TColgp_Array1OfVec2d &Tangents, const Handle< TColStd_HArray1OfBoolean > &TangentFlags, const Standard_Boolean Scale=Standard_True)
 Assigns this constrained BSpline curve to be tangential to vectors defined in the table Tangents, which is parallel to the table of points through which the curve passes, as defined at the time of initialization. Vectors in the table Tangents are defined only if the flag given in the parallel table TangentFlags is true: only these vectors are set as tangency constraints. <Scale> - boolean flag defining whether tangent vectors are to be scaled according to derivatives of lagrange interpolation. More...
 
void ClearTangents ()
 Clears all tangency constraints on this constrained BSpline curve (as initialized by the function Load). More...
 
void Perform ()
 Computes the constrained BSpline curve. Use the function IsDone to verify that the computation is successful, and then the function Curve to obtain the result. More...
 
const Handle< Geom2d_BSplineCurve > & Curve () const
 Returns the computed BSpline curve. Raises StdFail_NotDone if the interpolation fails. More...
 
 operator Handle< Geom2d_BSplineCurve > () const
 
Standard_Boolean IsDone () const
 Returns true if the constrained BSpline curve is successfully constructed. Note: in this case, the result is given by the function Curve. More...
 

Detailed Description

This class is used to interpolate a BsplineCurve passing through an array of points, with a C2 Continuity if tangency is not requested at the point. If tangency is requested at the point the continuity will be C1. If Perodicity is requested the curve will be closed and the junction will be the first point given. The curve will than be only C1 The curve is defined by a table of points through which it passes, and if required by a parallel table of reals which gives the value of the parameter of each point through which the resulting BSpline curve passes, and by vectors tangential to these points. An Interpolate object provides a framework for: defining the constraints of the BSpline curve,.

Constructor & Destructor Documentation

◆ Geom2dAPI_Interpolate() [1/2]

Geom2dAPI_Interpolate::Geom2dAPI_Interpolate ( const Handle< TColgp_HArray1OfPnt2d > &  Points,
const Standard_Boolean  PeriodicFlag,
const Standard_Real  Tolerance 
)

Tolerance is to check if the points are not too close to one an other It is also used to check if the tangent vector is not too small. There should be at least 2 points if PeriodicFlag is True then the curve will be periodic.

◆ Geom2dAPI_Interpolate() [2/2]

Geom2dAPI_Interpolate::Geom2dAPI_Interpolate ( const Handle< TColgp_HArray1OfPnt2d > &  Points,
const Handle< TColStd_HArray1OfReal > &  Parameters,
const Standard_Boolean  PeriodicFlag,
const Standard_Real  Tolerance 
)

if PeriodicFlag is True then the curve will be periodic Warning: There should be as many parameters as there are points except if PeriodicFlag is True : then there should be one more parameter to close the curve

Member Function Documentation

◆ ClearTangents()

void Geom2dAPI_Interpolate::ClearTangents ( )

Clears all tangency constraints on this constrained BSpline curve (as initialized by the function Load).

◆ Curve()

const Handle< Geom2d_BSplineCurve >& Geom2dAPI_Interpolate::Curve ( ) const

Returns the computed BSpline curve. Raises StdFail_NotDone if the interpolation fails.

◆ IsDone()

Standard_Boolean Geom2dAPI_Interpolate::IsDone ( ) const

Returns true if the constrained BSpline curve is successfully constructed. Note: in this case, the result is given by the function Curve.

◆ Load() [1/2]

void Geom2dAPI_Interpolate::Load ( const gp_Vec2d InitialTangent,
const gp_Vec2d FinalTangent,
const Standard_Boolean  Scale = Standard_True 
)

Assigns this constrained BSpline curve to be tangential to vectors InitialTangent and FinalTangent at its first and last points respectively (i.e. the first and last points of the table of points through which the curve passes, as defined at the time of initialization). <Scale> - boolean flag defining whether tangent vectors are to be scaled according to derivatives of lagrange interpolation.

◆ Load() [2/2]

void Geom2dAPI_Interpolate::Load ( const TColgp_Array1OfVec2d Tangents,
const Handle< TColStd_HArray1OfBoolean > &  TangentFlags,
const Standard_Boolean  Scale = Standard_True 
)

Assigns this constrained BSpline curve to be tangential to vectors defined in the table Tangents, which is parallel to the table of points through which the curve passes, as defined at the time of initialization. Vectors in the table Tangents are defined only if the flag given in the parallel table TangentFlags is true: only these vectors are set as tangency constraints. <Scale> - boolean flag defining whether tangent vectors are to be scaled according to derivatives of lagrange interpolation.

◆ operator Handle< Geom2d_BSplineCurve >()

Geom2dAPI_Interpolate::operator Handle< Geom2d_BSplineCurve > ( ) const

◆ Perform()

void Geom2dAPI_Interpolate::Perform ( )

Computes the constrained BSpline curve. Use the function IsDone to verify that the computation is successful, and then the function Curve to obtain the result.


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