0024428: Implementation of LGPL license
[occt.git] / src / BOPInt / BOPInt_ShrunkRange.cdl
CommitLineData
b311480e 1-- Created by: Peter KURNEV
973c2be1 2-- Copyright (c) 1999-2014 OPEN CASCADE SAS
b311480e 3--
973c2be1 4-- This file is part of Open CASCADE Technology software library.
b311480e 5--
973c2be1 6-- This library is free software; you can redistribute it and / or modify it
7-- under the terms of the GNU Lesser General Public 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.
b311480e 11--
973c2be1 12-- Alternatively, this file may be used under the terms of Open CASCADE
13-- commercial license or contractual agreement.
7fd59977 14
4e57c75e 15class ShrunkRange from BOPInt
7fd59977 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
22uses
4e57c75e 23 Box from Bnd,
7fd59977 24 Edge from TopoDS,
25 Vertex from TopoDS,
4e57c75e 26 Context from BOPInt
7fd59977 27
28--raises
29
30is
31 Create
4e57c75e 32 returns ShrunkRange from BOPInt;
33
34 SetData (me:out;
35 aE : Edge from TopoDS;
36 aT1 : Real from Standard;
37 aT2 : Real from Standard;
7fd59977 38 aV1 : Vertex from TopoDS;
4e57c75e 39 aV2 : Vertex from TopoDS;
40 ICtx: Context from BOPInt);
7fd59977 41
4e57c75e 42 SetShrunkRange(me:out;
43 aT1 : Real from Standard;
44 aT2 : Real from Standard);
45
46 ShrunkRange(me;
47 aT1 :out Real from Standard;
48 aT2 :out Real from Standard);
7fd59977 49
50 BndBox (me)
51 returns Box from Bnd;
4e57c75e 52 ---C++: return const &
7fd59977 53
54 Edge (me)
55 returns Edge from TopoDS;
4e57c75e 56 ---C++: return const &
7fd59977 57
58 Perform(me:out);
7fd59977 59
60 ErrorStatus(me)
61 returns Integer from Standard;
62 ---Purpose:
63 --- Returns code of computing shrunk range
64 --- completion
65 --- 0 - means successful completion
66 --- 1 - nothing has been done
67 --- 2 - initial range is out of edge's range
68 --- 3 - first boundary of initial range is more than
69 --- last boundary
70 --- 4 - projection of first vertex failed
71 --- 5 - projection of second vertex failed
72 --- 6 - shrunk range can not be computed
73 --- shrunk range is setted to initial range
74 ---
75
76fields
4e57c75e 77 myEdge : Edge from TopoDS is protected;
78 myV1 : Vertex from TopoDS is protected;
79 myV2 : Vertex from TopoDS is protected;
80 myT1 : Real from Standard is protected;
81 myT2 : Real from Standard is protected;
82 myTS1 : Real from Standard is protected;
83 myTS2 : Real from Standard is protected;
84 myBndBox : Box from Bnd is protected;
85 myCtx : Context from BOPInt is protected;
86 myErrorStatus : Integer from Standard is protected;
7fd59977 87
88end ShrunkRange;