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-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22 class  Curve3d  from  Approx
  23
  24 uses
  25     HCurve         from  Adaptor3d,
  26     BSplineCurve   from  Geom,
  27     Shape          from  GeomAbs,
  28     OutOfRange     from  Standard
  29
  30 raises  OutOfRange   from Standard,
  31         ConstructionError  from  Standard
  32
  33 is
  34
  35     Create(Curve:  HCurve  from Adaptor3d;
  36             Tol3d:  Real;
  37             Order:  Shape  from  GeomAbs;
  38             MaxSegments:  Integer;
  39             MaxDegree:  Integer)  returns  Curve3d  from  Approx;
  40         ---Purpose: Approximation  of  a  curve  with respect of the
  41     --          requiered tolerance Tol3D.
  42
  43     Curve(me)  returns  BSplineCurve  from  Geom;
  44
  45     IsDone(me)  returns  Boolean  from  Standard;
  46     ---Purpose:  returns  Standard_True  if  the  approximation  has
  47     -- been  done  within  requiered tolerance
  48
  49     HasResult(me) returns Boolean;
  50     ---Purpose: returns  Standard_True if the approximation did come out
  51     -- with a result that  is not NECESSARELY within the required
  52     -- tolerance
  53
  54     MaxError(me)  returns  Real  from  Standard;
  55     ---Purpose:  returns  the  Maximum  Error  (>0 when an approximation
  56     --  has  been  done, 0  if  no  approximation)
  57
  58     Dump(me;  o:  in  out  OStream);
  59     ---Purpose:  Print on the stream  o  information about the object
  60
  61 fields
  62     myIsDone    : Boolean         from  Standard;
  63     myHasResult : Boolean         from  Standard;
  64     myBSplCurve : BSplineCurve    from  Geom;
  65     myMaxError  : Real            from  Standard;
  66
  67 end Curve3d;