0023024: Update headers of OCCT files
[occt.git] / src / AppBlend / AppBlend_AppSurf.cdl
CommitLineData
b311480e 1-- Created on: 1993-12-13
2-- Created by: Jacques GOUSSARD
3-- Copyright (c) 1993-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-- Modified: Fri Jul 10 11:23:35 1998
22-- JCT : Add SpApprox in Perform
7fd59977 23
24
25
26generic class AppSurf from AppBlend
27 (TheSectionGenerator as any;
28 TheLine as Transient)
29 inherits Approx from AppBlend
30
31 ---Purpose: Bspline approximation of a surface.
32
33uses Array2OfPnt from TColgp,
34 HArray2OfPnt from TColgp,
35 Array2OfReal from TColStd,
36 HArray2OfReal from TColStd,
37 Array1OfReal from TColStd,
38 HArray1OfReal from TColStd,
39 Array1OfInteger from TColStd,
40 HArray1OfInteger from TColStd,
41 Array1OfPnt2d from TColgp,
42 SequenceOfArray1OfPnt2d from TColgp,
43 ParametrizationType from Approx,
44 Shape from GeomAbs
45
46
47raises NotDone from StdFail,
48 DomainError from Standard,
49 OutOfRange from Standard
50
51is
52
53
54 Create
55
56 returns AppSurf from AppBlend;
57
58
59 Create(Degmin,Degmax: Integer from Standard;
60 Tol3d,Tol2d : Real from Standard;
61 NbIt: Integer from Standard;
62 KnownParameters : Boolean from Standard = Standard_False)
63
64 returns AppSurf from AppBlend;
65
66
67 Init(me: in out; Degmin,Degmax: Integer from Standard;
68 Tol3d,Tol2d : Real from Standard;
69 NbIt: Integer from Standard;
70 KnownParameters : Boolean from Standard = Standard_False)
71
72 is static;
73
74 SetParType(me: in out; ParType : ParametrizationType from Approx)
75 ---Purpose: Define the type of parametrization used in the approximation
76 is static;
77
78
79 SetContinuity(me: in out; C : Shape from GeomAbs)
80 ---Purpose: Define the Continuity used in the approximation
81 is static;
82
83
84 SetCriteriumWeight(me : in out;
85 W1, W2, W3 : Real)
86 ---Purpose: define the Weights associed to the criterium used in
87 -- the optimization.
88 --
89 raises DomainError -- if Wi <= 0
90 is static;
91
92
93 ParType(me)
94 ---Purpose: returns the type of parametrization used in the approximation
95 returns ParametrizationType from Approx
96 is static;
97
98
99 Continuity(me)
100 ---Purpose: returns the Continuity used in the approximation
101 returns Shape from GeomAbs
102 is static;
103
104
105 CriteriumWeight(me ;
106 W1, W2, W3 : out Real)
107 ---Purpose: returns the Weights (as percent) associed to the criterium used in
108 -- the optimization.
109 is static;
110
111 Perform(me: in out; Lin: TheLine;
112 SecGen: in out TheSectionGenerator;
113 SpApprox : Boolean from Standard = Standard_False)
114
115 is static;
116
117 PerformSmoothing(me: in out; Lin: TheLine;
118 SecGen: in out TheSectionGenerator)
119
120 is static;
121
122
123 Perform(me: in out; Lin: TheLine;
124 SecGen: in out TheSectionGenerator;
125 NbMaxP: Integer from Standard)
126
127 is static;
128
129
130 InternalPerform(me: in out; Lin: TheLine;
131 SecGen: in out TheSectionGenerator;
132 SpApprox : Boolean from Standard;
133 UseVariational: Boolean from Standard)
134
135 is static private;
136
137 IsDone(me)
138
139 returns Boolean from Standard
140 ---C++: inline
141
142 is static;
143
144
145 SurfShape(me; UDegree,VDegree : out Integer from Standard;
146 NbUPoles,NbVPoles: out Integer from Standard;
147 NbUKnots,NbVKnots: out Integer from Standard)
148 raises NotDone from StdFail
149 is static;
150
151
152 Surface(me; TPoles : out Array2OfPnt from TColgp;
153 TWeights : out Array2OfReal from TColStd;
154 TUKnots,TVKnots : out Array1OfReal from TColStd;
155 TUMults,TVMults : out Array1OfInteger from TColStd)
156 raises NotDone from StdFail
157 is static;
158
159
160 UDegree(me)
161
162 returns Integer from Standard
163 ---C++: inline
164
165 raises NotDone from StdFail
166 is static;
167
168
169 VDegree(me)
170
171 returns Integer from Standard
172 ---C++: inline
173
174 raises NotDone from StdFail
175 is static;
176
177
178 SurfPoles(me)
179
180 returns Array2OfPnt from TColgp
181 ---C++: inline
182 ---C++: return const&
183
184 raises NotDone from StdFail
185 is static;
186
187
188 SurfWeights(me)
189
190 returns Array2OfReal from TColStd
191 ---C++: inline
192 ---C++: return const&
193
194 raises NotDone from StdFail
195 is static;
196
197
198 SurfUKnots(me)
199
200 returns Array1OfReal from TColStd
201 ---C++: inline
202 ---C++: return const&
203
204 raises NotDone from StdFail
205 is static;
206
207
208 SurfVKnots(me)
209
210 returns Array1OfReal from TColStd
211 ---C++: inline
212 ---C++: return const&
213
214 raises NotDone from StdFail
215 is static;
216
217
218 SurfUMults(me)
219
220 returns Array1OfInteger from TColStd
221 ---C++: inline
222 ---C++: return const&
223
224 raises NotDone from StdFail
225 is static;
226
227
228 SurfVMults(me)
229
230 returns Array1OfInteger from TColStd
231 ---C++: inline
232 ---C++: return const&
233
234 raises NotDone from StdFail
235 is static;
236
237
238 NbCurves2d(me)
239
240 returns Integer from Standard
241 ---C++: inline
242
243 raises NotDone from StdFail
244 is static;
245
246
247 Curves2dShape(me; Degree,NbPoles,NbKnots: out Integer from Standard)
248
249 raises NotDone from StdFail,
250 DomainError from Standard
251
252 is static;
253
254
255 Curve2d(me; Index: Integer from Standard;
256 TPoles : out Array1OfPnt2d from TColgp;
257 TKnots : out Array1OfReal from TColStd;
258 TMults : out Array1OfInteger from TColStd)
259
260 raises NotDone from StdFail,
261 OutOfRange from Standard,
262 DomainError from Standard
263
264 is static;
265
266
267 Curves2dDegree(me)
268
269 returns Integer from Standard
270 ---C++: inline
271
272 raises NotDone from StdFail,
273 DomainError from Standard
274 is static;
275
276
277 Curve2dPoles(me; Index: Integer from Standard)
278
279 returns Array1OfPnt2d from TColgp
280 ---C++: inline
281 ---C++: return const&
282
283 raises NotDone from StdFail,
284 OutOfRange from Standard,
285 DomainError from Standard
286 is static;
287
288
289 Curves2dKnots(me)
290
291 returns Array1OfReal from TColStd
292 ---C++: inline
293 ---C++: return const&
294
295 raises NotDone from StdFail,
296 DomainError from Standard
297 is static;
298
299
300 Curves2dMults(me)
301
302 returns Array1OfInteger from TColStd
303 ---C++: inline
304 ---C++: return const&
305
306 raises NotDone from StdFail,
307 DomainError from Standard
308 is static;
309
310
311 TolReached(me; Tol3d, Tol2d : out Real from Standard)
312 ---C++: inline
313 raises NotDone from StdFail
314 is static;
315
316 TolCurveOnSurf(me; Index : Integer from Standard)
317 returns Real from Standard
318 raises NotDone from StdFail
319 is static;
320
321
322fields
323
324 done : Boolean from Standard;
325 dmin : Integer from Standard;
326 dmax : Integer from Standard;
327 tol3d : Real from Standard;
328 tol2d : Real from Standard;
329 nbit : Integer from Standard;
330 udeg : Integer from Standard;
331 vdeg : Integer from Standard;
332 knownp : Boolean from Standard;
333 tabPoles : HArray2OfPnt from TColgp;
334 tabWeights : HArray2OfReal from TColStd;
335 tabUKnots : HArray1OfReal from TColStd;
336 tabVKnots : HArray1OfReal from TColStd;
337 tabUMults : HArray1OfInteger from TColStd;
338 tabVMults : HArray1OfInteger from TColStd;
339 seqPoles2d : SequenceOfArray1OfPnt2d from TColgp;
340 tol3dreached : Real from Standard;
341 tol2dreached : Real from Standard;
342 paramtype : ParametrizationType from Approx;
343 continuity : Shape from GeomAbs;
344 critweights : Real[3];
345
346end AppSurf;