src/IntTools/IntTools_ShrunkRange.cdl

   1 -- Created by: Peter KURNEV
   2 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   3 --
   4 -- This file is part of Open CASCADE Technology software library.
   5 --
   6 -- This library is free software; you can redistribute it and/or modify it under
   7 -- the terms of the GNU Lesser General Public License version 2.1 as published
   8 -- by the Free Software Foundation, with special exception defined in the file
   9 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  10 -- distribution for complete text of the license and disclaimer of any warranty.
  11 --
  12 -- Alternatively, this file may be used under the terms of Open CASCADE
  13 -- commercial license or contractual agreement.
  14
  15 class ShrunkRange from IntTools
  16
  17  ---Purpose:
  18  ---  The class provides the computation of
  19  ---  a working (shrunk) range [t1, t2] for
  20      ---  the 3D-curve of the edge.
  21
  22 uses
  23     Box from Bnd,
  24     Edge from TopoDS,
  25     Vertex from TopoDS,
  26     Context  from IntTools
  27
  28 --raises
  29
  30 is
  31     Create
  32         returns ShrunkRange from IntTools;
  33     ---C++: alias "Standard_EXPORT virtual ~IntTools_ShrunkRange();"
  34
  35     SetData (me:out;
  36             aE  : Edge from TopoDS;
  37             aT1 : Real from Standard;
  38             aT2 : Real from Standard;
  39             aV1 : Vertex from TopoDS;
  40             aV2 : Vertex from TopoDS);
  41
  42     SetContext(me:out;
  43             aCtx: Context from IntTools);
  44
  45     Context(me)
  46         returns Context from IntTools;
  47     ---C++: return const &
  48
  49     SetShrunkRange(me:out;
  50          aT1 : Real from Standard;
  51          aT2 : Real from Standard);
  52
  53     ShrunkRange(me;
  54          aT1 :out Real from Standard;
  55          aT2 :out Real from Standard);
  56
  57     BndBox  (me)
  58      returns Box from Bnd;
  59     ---C++: return const &
  60
  61     Edge  (me)
  62      returns Edge from TopoDS;
  63     ---C++: return const &
  64
  65     Perform(me:out);
  66
  67     ErrorStatus(me)
  68      returns Integer from Standard;
  69  ---Purpose:
  70  --- Returns code of computing shrunk range
  71  --- completion
  72  --- 0 - means successful completion
  73  --- 1 - nothing has been done
  74  --- 2 - initial range is out of edge's range
  75  --- 3 - first boundary of initial range is more than
  76  ---     last boundary
  77  --- 4 - projection of first vertex failed
  78  --- 5 - projection of second vertex failed
  79  --- 6 - shrunk range can not be computed
  80  ---     shrunk range is setted to initial range
  81  ---
  82
  83 fields
  84     myEdge        : Edge from TopoDS is protected;
  85     myV1          : Vertex from TopoDS is protected;
  86     myV2          : Vertex from TopoDS is protected;
  87     myT1          : Real from Standard is protected;
  88     myT2          : Real from Standard is protected;
  89     myTS1         : Real from Standard is protected;
  90     myTS2         : Real from Standard is protected;
  91     myBndBox      : Box from Bnd is protected;
  92     myCtx         : Context from IntTools is protected;
  93     myErrorStatus : Integer from Standard is protected;
  94
  95 end ShrunkRange;