TKGeomAlgo » Package GeomAPI GeomAPI_Interpolate

Open CASCADE Technology »  Module ModelingAlgorithms »  Toolkit TKGeomAlgo  »   Package GeomAPI

GeomAPI_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 
Describes functions for building a constrained 3D BSpline curve. 
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, 
  
• implementing the interpolation algorithm, and 
  
• consulting the results. 
  

#include <GeomAPI_Interpolate.hxx>

Public Member Functions
void *	operator new (size_t, void *anAddress)
void *	operator new (size_t size)
void	operator delete (void *anAddress)
	GeomAPI_Interpolate (const Handle< TColgp_HArray1OfPnt > &Points, const Standard_Boolean PeriodicFlag, const Standard_Real Tolerance)
	Initializes an algorithm for constructing a  constrained BSpline curve passing through the points of the table Points.  Tangential vectors can then be assigned, using the function Load.  If PeriodicFlag is true, the constrained BSpline  curve will be periodic and closed. In this case,  the junction point is the first point of the table Points.  The tolerance value Tolerance is used to check that:  points are not too close to each other, or  tangential vectors (defined using the  function Load) are not too small.  The resulting BSpline curve will be "C2"  continuous, except where a tangency  constraint is defined on a point through which  the curve passes (by using the Load function).  In this case, it will be only "C1" continuous.  Once all the constraints are defined, use the  function Perform to compute the curve.  Warning  There must be at least 2 points in the table Points.  If PeriodicFlag is false, there must be as  many parameters in the array Parameters as  there are points in the array Points.  If PeriodicFlag is true, there must be one  more parameter in the table Parameters: this  is used to give the parameter on the  resulting BSpline curve of the junction point  of the curve (which is also the first point of the table Points).  Exceptions  Standard_ConstructionError if the  distance between two consecutive points in  the table Points is less than or equal to Tolerance.  Standard_OutOfRange if:  there are less than two points in the table Points, or  conditions relating to the respective  number of elements in the parallel tables  Points and Parameters are not respected.
	GeomAPI_Interpolate (const Handle< TColgp_HArray1OfPnt > &Points, const Handle< TColStd_HArray1OfReal > &Parameters, const Standard_Boolean PeriodicFlag, const Standard_RealTolerance)
	Initializes an algorithm for constructing a  constrained BSpline curve passing through the points of the table  Points, where the parameters of each of its  points are given by the parallel table Parameters.  Tangential vectors can then be assigned, using the function Load.  If PeriodicFlag is true, the constrained BSpline  curve will be periodic and closed. In this case,  the junction point is the first point of the table Points.  The tolerance value Tolerance is used to check that:  points are not too close to each other, or  tangential vectors (defined using the  function Load) are not too small.  The resulting BSpline curve will be "C2"  continuous, except where a tangency  constraint is defined on a point through which  the curve passes (by using the Load function).  In this case, it will be only "C1" continuous.  Once all the constraints are defined, use the  function Perform to compute the curve.  Warning  There must be at least 2 points in the table Points.  If PeriodicFlag is false, there must be as  many parameters in the array Parameters as  there are points in the array Points.  If PeriodicFlag is true, there must be one  more parameter in the table Parameters: this  is used to give the parameter on the  resulting BSpline curve of the junction point  of the curve (which is also the first point of the table Points).  Exceptions  Standard_ConstructionError if the  distance between two consecutive points in  the table Points is less than or equal to Tolerance.  Standard_OutOfRange if:  there are less than two points in the table Points, or  conditions relating to the respective  number of elements in the parallel tables  Points and Parameters are not respected.
void	Load (const gp_Vec &InitialTangent, const gp_Vec &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).
void	Load (const TColgp_Array1OfVec &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.
void	ClearTangents ()
	Clears all tangency constraints on this  constrained BSpline curve (as initialized by the function Load).
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.
const Handle_Geom_BSplineCurve &	Curve () const
	Returns the computed BSpline curve.  Raises StdFail_NotDone if the interpolation fails.
	operator Handle< Geom_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.

---

Constructor & Destructor Documentation

GeomAPI_Interpolate::GeomAPI_Interpolate	(	const Handle< TColgp_HArray1OfPnt > &	Points,
		const Standard_Boolean	PeriodicFlag,
		const Standard_Real	Tolerance
	)

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

---

Member Function Documentation

void GeomAPI_Interpolate::ClearTangents

(

)

const Handle_Geom_BSplineCurve& GeomAPI_Interpolate::Curve

(

)

const

Standard_Boolean GeomAPI_Interpolate::IsDone

(

)

const

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

void GeomAPI_Interpolate::Load	(	const gp_Vec &	InitialTangent,
		const gp_Vec &	FinalTangent,
		const Standard_Boolean	Scale = Standard_True
	)

void GeomAPI_Interpolate::operator delete

(

void *

anAddress

)

[inline]

GeomAPI_Interpolate::operator Handle< Geom_BSplineCurve >

(

)

const

void* GeomAPI_Interpolate::operator new

(

size_t

size

)

[inline]

void* GeomAPI_Interpolate::operator new	(	size_t	,
		void *	anAddress
	)			[inline]

void GeomAPI_Interpolate::Perform

(

)

---

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

• GeomAPI_Interpolate.hxx