src/IntTools/IntTools_ShrunkRange.cdl

   1 -- Created on: 2001-03-11
   2 -- Created by: Peter KURNEV
   3 -- Copyright (c) 2001-2012 OPEN CASCADE SAS
   4 --
   5 -- The content of this file is subject to the Open CASCADE Technology Public
   6 -- License Version 6.5 (the "License"). You may not use the content of this file
   7 -- except in compliance with the License. Please obtain a copy of the License
   8 -- at http://www.opencascade.org and read it completely before using this file.
   9 --
  10 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  11 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  12 --
  13 -- The Original Code and all software distributed under the License is
  14 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  15 -- Initial Developer hereby disclaims all such warranties, including without
  16 -- limitation, any warranties of merchantability, fitness for a particular
  17 -- purpose or non-infringement. Please see the License for the specific terms
  18 -- and conditions governing the rights and limitations under the License.
  19
  20
  21
  22 class ShrunkRange from IntTools
  23
  24         ---Purpose:
  25         ---  The class provides the computation of
  26         ---  a working (shrunk) range [t1, t2] for
  27         ---  the 3D-curve of the edge.
  28
  29 uses
  30
  31     Edge from TopoDS,
  32     Vertex from TopoDS,
  33     Range from IntTools,
  34     Box from Bnd,
  35     Context from IntTools
  36
  37 --raises
  38
  39 is
  40     Create
  41         returns ShrunkRange from IntTools;
  42         ---Purpose:
  43         --- Empty constructor
  44         ---
  45
  46     Create (aE  : Edge from TopoDS;
  47             aV1 : Vertex from TopoDS;
  48             aV2 : Vertex from TopoDS;
  49             aR  : Range from IntTools;
  50             ICtx: Context from IntTools)
  51         returns ShrunkRange from IntTools;
  52         ---Purpose:
  53         ---
  54     SetContext(me:out;
  55           aContext : Context from IntTools);
  56     ---Purpose:
  57         --- Sets the intersecton context
  58         ---
  59     Context(me)
  60         returns Context from IntTools;
  61     ---C++:  return const &
  62      ---Purpose:
  63         --- Gets the intersecton context
  64         ---
  65
  66
  67     SetShrunkRange(me:out;  aR:Range from IntTools);
  68         ---Purpose:
  69         --- Sets an shrunk range
  70         ---
  71
  72     ShrunkRange(me)
  73         returns Range from IntTools;
  74         ---C++:  return  const&
  75         ---Purpose:
  76         --- Returns shrunk range
  77         ---
  78
  79     BndBox  (me)
  80         returns Box from Bnd;
  81         ---C++:  return  const&
  82         ---Purpose:
  83         --- Returns bounding box for edge restricted
  84         --- by shrunk range
  85         ---
  86
  87     Edge  (me)
  88         returns Edge from TopoDS;
  89         ---C++:  return  const&
  90         ---Purpose:
  91         --- Returns edge for which
  92         --- the shrunk range is computed
  93         ---
  94
  95     Perform(me:out);
  96         ---Purpose:
  97         --- Computes shrunk range for
  98         --- an edge given in constructor
  99         ---
 100
 101
 102     IsDone (me)
 103         returns Boolean from Standard;
 104         ---Purpose:
 105         --- Returns true if no error occured
 106         --- during shrunk range computation
 107         ---
 108
 109     ErrorStatus(me)
 110         returns Integer from Standard;
 111         ---Purpose:
 112         --- Returns code of computing shrunk range
 113         --- completion
 114         --- 0 - means successful completion
 115         --- 1 - nothing has been done
 116         --- 2 - initial range is out of edge's range
 117         --- 3 - first boundary of initial range is more than
 118         ---     last boundary
 119         --- 4 - projection of first vertex failed
 120         --- 5 - projection of second vertex failed
 121         --- 6 - shrunk range can not be computed
 122         ---     shrunk range is setted to initial range
 123         ---
 124
 125 fields
 126     myEdge        :  Edge from TopoDS;
 127     myV1          :  Vertex from TopoDS;
 128     myV2          :  Vertex from TopoDS;
 129     myRange       :  Range from IntTools;
 130     myShrunkRange :  Range from IntTools;
 131     myBndBox      :  Box from Bnd;
 132     myContext     :  Context from IntTools;
 133     myIsDone      :  Boolean from Standard;
 134     myErrorStatus :  Integer from Standard;
 135
 136 end ShrunkRange;