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
0031 //! this class is used to construct a BSpline curve by
0032 //! interpolation  of points  at given parameters  The
0033 //! continuity   of the curve   is degree -  1 and the
0034 //! method used when boundary  condition are not given
0035 //! is to use odd degrees  and null the derivatives on
0036 //! both sides from degree -1 down to (degree+1) / 2
0037 //! When even degree is given the returned curve is of
0038 //! degree - 1 so that the degree of the curve is odd
0039 class GeomLib_Interpolate
0040 {
0041 public:
0042
0043   DEFINE_STANDARD_ALLOC
0044
0045
0046   Standard_EXPORT GeomLib_Interpolate(const Standard_Integer Degree, const Standard_Integer NumPoints, const TColgp_Array1OfPnt& Points, const TColStd_Array1OfReal& Parameters);
0047
0048
0049   //! returns if everything went OK
0050     Standard_Boolean IsDone() const;
0051
0052   //! returns the error type if any
0053     GeomLib_InterpolationErrors Error() const;
0054
0055   //! returns the interpolated curve of the requested degree
0056   Standard_EXPORT Handle(Geom_BSplineCurve) Curve() const;
0057
0058
0059
0060
0061 protected:
0062
0063
0064
0065
0066
0067 private:
0068
0069
0070
0071   Handle(Geom_BSplineCurve) myCurve;
0072   Standard_Boolean myIsDone;
0073   GeomLib_InterpolationErrors myError;
0074
0075
0076 };
0077
0078
0079 #include <GeomLib_Interpolate.lxx>
0080
0081
0082
0083
0084
0085 #endif // _GeomLib_Interpolate_HeaderFile