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