src/GeomLib/GeomLib_Interpolate.hxx

   1 // Created on: 1996-08-30
   2 // Created by: Xavier BENVENISTE
   3 // Copyright (c) 1996-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _GeomLib_Interpolate_HeaderFile
  18 #define _GeomLib_Interpolate_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Boolean.hxx>
  25 #include <GeomLib_InterpolationErrors.hxx>
  26 #include <Standard_Integer.hxx>
  27 #include <TColgp_Array1OfPnt.hxx>
  28 #include <TColStd_Array1OfReal.hxx>
  29 class Geom_BSplineCurve;
  30 class StdFail_NotDone;
  31 class Standard_OutOfRange;
  32
  33
  34 //! this class is used to construct a BSpline curve by
  35 //! interpolation  of points  at given parameters  The
  36 //! continuity   of the curve   is degree -  1 and the
  37 //! method used when boundary  condition are not given
  38 //! is to use odd degrees  and null the derivatives on
  39 //! both sides from degree -1 down to (degree+1) / 2
  40 //! When even degree is given the returned curve is of
  41 //! degree - 1 so that the degree of the curve is odd
  42 class GeomLib_Interpolate
  43 {
  44 public:
  45
  46   DEFINE_STANDARD_ALLOC
  47
  48
  49   Standard_EXPORT GeomLib_Interpolate(const Standard_Integer Degree, const Standard_Integer NumPoints, const TColgp_Array1OfPnt& Points, const TColStd_Array1OfReal& Parameters);
  50
  51
  52   //! returns if everything went OK
  53     Standard_Boolean IsDone() const;
  54
  55   //! returns the error type if any
  56     GeomLib_InterpolationErrors Error() const;
  57
  58   //! returns the interpolated curve of the requested degree
  59   Standard_EXPORT Handle(Geom_BSplineCurve) Curve() const;
  60
  61
  62
  63
  64 protected:
  65
  66
  67
  68
  69
  70 private:
  71
  72
  73
  74   Handle(Geom_BSplineCurve) myCurve;
  75   Standard_Boolean myIsDone;
  76   GeomLib_InterpolationErrors myError;
  77
  78
  79 };
  80
  81
  82 #include <GeomLib_Interpolate.lxx>
  83
  84
  85
  86
  87
  88 #endif // _GeomLib_Interpolate_HeaderFile