src/Approx/Approx_Curve3d.cdl

   1 -- Created on: 1998-08-20
   2 -- Created by: Philippe MANGIN
   3 -- Copyright (c) 1998-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  Curve3d  from  Approx
  18
  19 uses
  20     HCurve         from  Adaptor3d,
  21     BSplineCurve   from  Geom,
  22     Shape          from  GeomAbs,
  23     OutOfRange     from  Standard
  24
  25 raises  OutOfRange   from Standard,
  26         ConstructionError  from  Standard
  27
  28 is
  29
  30     Create(Curve:  HCurve  from Adaptor3d;
  31             Tol3d:  Real;
  32             Order:  Shape  from  GeomAbs;
  33             MaxSegments:  Integer;
  34             MaxDegree:  Integer)  returns  Curve3d  from  Approx;
  35         ---Purpose: Approximation  of  a  curve  with respect of the
  36     --          requiered tolerance Tol3D.
  37
  38     Curve(me)  returns  BSplineCurve  from  Geom;
  39
  40     IsDone(me)  returns  Boolean  from  Standard;
  41     ---Purpose:  returns  Standard_True  if  the  approximation  has
  42     -- been  done  within  requiered tolerance
  43
  44     HasResult(me) returns Boolean;
  45     ---Purpose: returns  Standard_True if the approximation did come out
  46     -- with a result that  is not NECESSARELY within the required
  47     -- tolerance
  48
  49     MaxError(me)  returns  Real  from  Standard;
  50     ---Purpose:  returns  the  Maximum  Error  (>0 when an approximation
  51     --  has  been  done, 0  if  no  approximation)
  52
  53     Dump(me;  o:  in  out  OStream);
  54     ---Purpose:  Print on the stream  o  information about the object
  55
  56 fields
  57     myIsDone    : Boolean         from  Standard;
  58     myHasResult : Boolean         from  Standard;
  59     myBSplCurve : BSplineCurve    from  Geom;
  60     myMaxError  : Real            from  Standard;
  61
  62 end Curve3d;