src/GeomLib/GeomLib_Interpolate.cdl

   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 class Interpolate from GeomLib
  18
  19         ---Purpose: this class is used to construct a BSpline curve by
  20         --          interpolation  of points  at given parameters  The
  21         --          continuity   of the curve   is degree -  1 and the
  22         --          method used when boundary  condition are not given
  23         --          is to use odd degrees  and null the derivatives on
  24         --          both sides from degree -1 down to (degree+1) / 2
  25         --          When even degree is given the returned curve is of
  26         --          degree - 1 so that the degree of the curve is odd
  27
  28
  29 uses
  30     Array1OfPnt         from TColgp,
  31     Array1OfReal        from TColStd,
  32     InterpolationErrors from GeomLib,
  33     BSplineCurve        from Geom
  34
  35 raises
  36
  37     NotDone    from StdFail,
  38     OutOfRange from Standard
  39
  40 is
  41
  42     Create( Degree     : Integer from Standard ;
  43             NumPoints  : Integer from Standard ;
  44             Points     : Array1OfPnt from TColgp ;
  45             Parameters : Array1OfReal from TColStd)
  46
  47     returns Interpolate from GeomLib ;
  48
  49     IsDone(me) returns Boolean from Standard
  50         ---Purpose:
  51         -- returns if everything went OK
  52         ---C++: inline
  53     is static;
  54
  55
  56     Error(me) returns InterpolationErrors from GeomLib
  57     ---Purpose: returns the error type if any
  58     ---C++: inline
  59     --
  60     is static ;
  61
  62     Curve(me)
  63     ---Purpose:  returns the interpolated curve of the requested degree
  64
  65     returns BSplineCurve from Geom
  66     raises
  67         OutOfRange from Standard,
  68         NotDone    from StdFail
  69     is static;
  70
  71
  72
  73 fields
  74
  75     myCurve : BSplineCurve from Geom ;
  76     myIsDone : Boolean from Standard ;
  77     myError  : InterpolationErrors  from GeomLib  ;
  78
  79 end Interpolate ;
  80