include/opencascade/GeomLib_Interpolate.hxx

0001 // Created on: 1996-08-30
0002 // Created by: Xavier BENVENISTE
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _GeomLib_Interpolate_HeaderFile
0018 #define _GeomLib_Interpolate_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <GeomLib_InterpolationErrors.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <TColgp_Array1OfPnt.hxx>
0027 #include <TColStd_Array1OfReal.hxx>
0028 class Geom_BSplineCurve;
0029
0030 //! this class is used to construct a BSpline curve by
0031 //! interpolation  of points  at given parameters  The
0032 //! continuity   of the curve   is degree -  1 and the
0033 //! method used when boundary  condition are not given
0034 //! is to use odd degrees  and null the derivatives on
0035 //! both sides from degree -1 down to (degree+1) / 2
0036 //! When even degree is given the returned curve is of
0037 //! degree - 1 so that the degree of the curve is odd
0038 class GeomLib_Interpolate
0039 {
0040 public:
0041   DEFINE_STANDARD_ALLOC
0042
0043   Standard_EXPORT GeomLib_Interpolate(const Standard_Integer      Degree,
0044                                       const Standard_Integer      NumPoints,
0045                                       const TColgp_Array1OfPnt&   Points,
0046                                       const TColStd_Array1OfReal& Parameters);
0047
0048   //! returns if everything went OK
0049   Standard_Boolean IsDone() const;
0050
0051   //! returns the error type if any
0052   GeomLib_InterpolationErrors Error() const;
0053
0054   //! returns the interpolated curve of the requested degree
0055   Standard_EXPORT Handle(Geom_BSplineCurve) Curve() const;
0056
0057 protected:
0058 private:
0059   Handle(Geom_BSplineCurve)   myCurve;
0060   Standard_Boolean            myIsDone;
0061   GeomLib_InterpolationErrors myError;
0062 };
0063
0064 #include <GeomLib_Interpolate.lxx>
0065
0066 #endif // _GeomLib_Interpolate_HeaderFile