0024023: Revamp the OCCT Handle -- ambiguity
[occt.git] / src / BRepClass3d / BRepClass3d_Intersector3d.cdl
1 -- Created on: 1994-04-01
2 -- Created by: Laurent BUCHARD
3 -- Copyright (c) 1994-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 Intersector3d from BRepClass3d 
18     
19     
20 uses 
21     Lin               from gp,
22     Pnt               from gp,
23     Face              from TopoDS,
24     Shape             from TopoDS,
25     State             from TopAbs,
26     TransitionOnCurve from IntCurveSurface
27     
28 is
29
30     Create returns Intersector3d from BRepClass3d;
31         ---Purpose: Empty constructor.
32                   
33     Perform(me: in out;  L    : Lin     from gp;
34                          Prm  : Real    from Standard;
35                          Tol  : Real    from Standard;
36                          F    : Face    from TopoDS) 
37         ---Purpose: Perform the intersection between the 
38         --          segment L(0) ... L(Prm) and the Shape <Sh>.
39         --          
40         --          Only the point with the smallest parameter on the 
41         --          line is returned. 
42         --          
43         --          The Tolerance <Tol> is used to determine if the 
44         --          first point of the segment is near the face. In 
45         --          that case, the parameter of the intersection point 
46         --          on the line can be a negative value (greater than -Tol).
47     is static;
48     
49     
50     IsDone(me)  
51         ---Purpose: True is returned when the intersection have been computed.
52         ---C++: inline
53     returns Boolean from Standard
54     is static;
55     
56     
57     HasAPoint(me) 
58         ---Purpose: True is returned if a point has been found.
59         ---C++: inline
60     returns Boolean from Standard
61     is static;
62     
63          
64     UParameter(me) 
65         ---Purpose: Returns the U parameter of the intersection point 
66         --          on the surface.
67         ---C++: inline
68     returns Real from Standard
69     is static;
70
71     VParameter(me) 
72         ---Purpose: Returns the V parameter of the intersection point 
73         --          on the surface.
74         ---C++: inline
75     returns Real from Standard
76     is static;
77
78     WParameter(me) 
79         ---Purpose: Returns the parameter of the intersection point 
80         --          on the line.
81         ---C++: inline
82     returns Real from Standard
83     is static;
84
85
86     Pnt(me)
87         ---Purpose: Returns the geometric point of the intersection 
88         --          between the line and the surface.
89         ---C++: inline
90         ---C++: return const &
91     returns Pnt from gp
92     is static;
93     
94     
95     Transition(me) 
96         ---Purpose: Returns the transition of the line on the surface.
97         ---C++: inline
98     returns TransitionOnCurve from IntCurveSurface
99     is static;
100     
101
102     State(me) 
103         ---Purpose: Returns the state of the point on the face.
104         --          The values can be either TopAbs_IN 
105         --             ( the point is in the face)
106         --           or TopAbs_ON
107         --             ( the point is on a boudary of the face).
108         ---C++: inline
109        
110     returns State from TopAbs
111     is static;
112     
113     Face(me) 
114         ---Purpose: Returns the significant face used to determine
115         --          the intersection. 
116         --          
117         ---C++: inline
118         ---C++: return const &
119     returns Face from TopoDS
120     is static;
121     
122     
123         ---------------------- Local Geometry avec courbureS dans une 
124         --                     direction et la direction normale     
125
126 fields
127
128     pnt                :  Pnt                 from gp;
129     U                  :  Real                from Standard;
130     V                  :  Real                from Standard;
131     W                  :  Real                from Standard;
132     transition         :  TransitionOnCurve   from IntCurveSurface;
133     done               :  Boolean             from Standard;
134     hasapoint          :  Boolean             from Standard;
135     state              :  State               from TopAbs;
136     face               :  Face                from TopoDS;
137
138 end Intersector3d;
139
140    
141
142
143
144
145
146