0023024: Update headers of OCCT files
[occt.git] / src / BRepIntCurveSurface / BRepIntCurveSurface_Inter.cdl
CommitLineData
b311480e 1-- Created on: 1994-02-07
2-- Created by: Modelistation
3-- Copyright (c) 1994-1999 Matra Datavision
4-- Copyright (c) 1999-2012 OPEN CASCADE SAS
5--
6-- The content of this file is subject to the Open CASCADE Technology Public
7-- License Version 6.5 (the "License"). You may not use the content of this file
8-- except in compliance with the License. Please obtain a copy of the License
9-- at http://www.opencascade.org and read it completely before using this file.
10--
11-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
12-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
13--
14-- The Original Code and all software distributed under the License is
15-- distributed on an "AS IS" basis, without warranty of any kind, and the
16-- Initial Developer hereby disclaims all such warranties, including without
17-- limitation, any warranties of merchantability, fitness for a particular
18-- purpose or non-infringement. Please see the License for the specific terms
19-- and conditions governing the rights and limitations under the License.
20
7fd59977 21
22
23class Inter from BRepIntCurveSurface
24
25 ---Purpose: Computes the intersection between a face and a curve
26 --
27
28uses
29--modified by NIZNHY-PKV Sun Dec 15 16:52:33 2002 f
30 TopolTool from BRepTopAdaptor,
31 HSurface from BRepAdaptor,
32--modified by NIZNHY-PKV Sun Dec 15 16:52:34 2002 t
33 Shape from TopoDS,
34 FaceClassifier from BRepClass,
35 State from TopAbs,
36 Explorer from TopExp,
37 IntersectionPoint from IntCurveSurface,
38 HInter from IntCurveSurface,
39 Curve from GeomAdaptor,
40 Lin from gp,
41 Pnt from gp,
42 TransitionOnCurve from IntCurveSurface,
43 Face from TopoDS
44
45
46raises
47 NotDone from StdFail
48
49
50is
51
52 Create returns Inter from BRepIntCurveSurface;
53 --- Purpose: Empty constructor;
54
55 Init(me : in out;
56 Sh : Shape from TopoDS;
57 Cu : Curve from GeomAdaptor;
58 Tol: Real from Standard)
59
60 --- Purpose: Load the Shape, the curve and initialize the
61 -- tolerance used for the classification.
62 is static;
63
64 Init(me : in out;
65 Sh : Shape from TopoDS;
66 L : Lin from gp;
67 Tol: Real from Standard)
68
69 --- Purpose: Load the Shape, the curve and initialize the
70 -- tolerance used for the classification.
71 is static;
72
73 More(me)
74
75 --- Purpose: returns True if there is a current face.
76 returns Boolean from Standard
77 is static;
78
79
80 Next(me: in out)
81
82 --- Purpose: Sets the explorer to the next face.
83 is static;
84
85 Find(me: in out)
86 ---Purpose: Internal function
87 is static protected;
88
89 Point(me)
90
91 ---Purpose: returns the current Intersection point.
92
93 returns IntersectionPoint from IntCurveSurface
94 raises NotDone from StdFail
95 is static;
96
97 Pnt(me)
98 ---Purpose: returns the current geometric Point
99 ---C++: return const &
100 returns Pnt from gp
101 raises NotDone from StdFail
102 is static;
103
104
105 U(me)
106 ---Purpose: returns the U parameter of the current point
107 -- on the current face.
108 returns Real from Standard
109 raises NotDone from StdFail
110 is static;
111
112 V(me)
113 ---Purpose: returns the V parameter of the current point
114 -- on the current face.
115 returns Real from Standard
116 raises NotDone from StdFail
117 is static;
118
119 W(me)
120 ---Purpose: returns the parameter of the current point
121 -- on the curve.
122 returns Real from Standard
123 raises NotDone from StdFail
124 is static;
125
126 State(me)
127
128 ---Purpose: returns the current state (IN or ON)
129 returns State from TopAbs
130 raises NotDone from StdFail
131 is static;
132
133 Transition(me)
134
135 ---Purpose: returns the transition of the line on the surface (IN or OUT or UNKNOWN)
136 returns TransitionOnCurve from IntCurveSurface
137 raises NotDone from StdFail
138 is static;
139
140 Face(me)
141
142 ---Purpose: returns the current face.
143 ---C++: return const &
144 returns Face from TopoDS
145 is static;
146
147
148fields
149
150 empty : Boolean from Standard;
151 curveisaline : Boolean from Standard;
152 tolerance : Real from Standard;
153 line : Lin from gp;
154 curve : Curve from GeomAdaptor;
155
156 explorer : Explorer from TopExp;
157 classifier : FaceClassifier from BRepClass;
158 --intcs : ICSInter from BRepIntCurveSurface;
159 intcs : HInter from IntCurveSurface;
160
161 currentindex : Integer from Standard;
162 currentnbpoints: Integer from Standard;
163--modified by NIZNHY-PKV Sun Dec 15 16:51:34 2002 f
164 FastClass : TopolTool from BRepTopAdaptor;
165 SurfForFastClass: HSurface from BRepAdaptor;
166 currentstate : State from TopAbs;
167 currentU : Real from Standard;
168 currentV : Real from Standard;
169--modified by NIZNHY-PKV Sun Dec 15 16:52:15 2002 t
170end Inter from BRepIntCurveSurface;