0023024: Update headers of OCCT files
[occt.git] / src / Adaptor3d / Adaptor3d_HSurfaceTool.cdl
1 -- Created on: 1993-07-02
2 -- Created by: Laurent BUCHARD
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
21
22
23 class HSurfaceTool from Adaptor3d
24                                  
25 uses 
26
27    Shape          from GeomAbs,
28    SurfaceType    from GeomAbs,
29    Pln            from gp,
30    Cone           from gp,
31    Cylinder       from gp,
32    Sphere         from gp,
33    Torus          from gp, 
34    Pnt            from gp,
35    Vec            from gp,
36    Array1OfReal   from TColStd,
37    BezierSurface  from Geom,
38    BSplineSurface from Geom,
39    HSurface       from Adaptor3d,
40    HCurve         from Adaptor3d,
41    Ax1            from gp,
42    Dir            from gp
43
44 raises
45
46    NoSuchObject from Standard,
47    OutOfRange   from Standard
48
49 is 
50   
51     FirstUParameter(myclass; S: HSurface from Adaptor3d)
52         ---C++: inline
53         returns Real from Standard;
54         
55     FirstVParameter(myclass; S: HSurface from Adaptor3d)
56         ---C++: inline
57         returns Real from Standard;
58
59     LastUParameter(myclass; S: HSurface from Adaptor3d)
60         ---C++: inline
61         returns Real from Standard;
62
63     LastVParameter(myclass; S: HSurface from Adaptor3d)
64         ---C++: inline
65         returns Real from Standard;
66
67
68
69     NbUIntervals(myclass; S: HSurface from Adaptor3d;
70                           Sh : Shape from GeomAbs)
71         ---C++: inline
72         returns Integer from Standard;
73
74     NbVIntervals(myclass; S: HSurface from Adaptor3d;
75                           Sh : Shape from GeomAbs) 
76         ---C++: inline 
77         returns Integer from Standard;
78
79
80
81     UIntervals(myclass; S  : HSurface from Adaptor3d;
82                         T  : in out Array1OfReal from TColStd; 
83                         Sh : Shape from GeomAbs);
84         ---C++: inline
85
86     VIntervals(myclass; S  : HSurface from Adaptor3d;
87                         T  : in out Array1OfReal from TColStd; 
88                         Sh : Shape from GeomAbs) ;
89         ---C++: inline 
90
91
92    UTrim(myclass; S : HSurface from Adaptor3d;
93                   First, Last, Tol : Real) 
94         ---C++: inline
95     returns HSurface from Adaptor3d
96     raises
97         OutOfRange from Standard;
98         ---Purpose: If <First> >= <Last> 
99     
100    VTrim(myclass; S : HSurface from Adaptor3d;
101                   First, Last, Tol : Real) 
102         ---C++: inline
103     returns HSurface from Adaptor3d
104     raises
105         OutOfRange from Standard;
106         ---Purpose: If <First> >= <Last> 
107     
108
109     IsUClosed(myclass; S: HSurface from Adaptor3d) 
110         ---C++: inline
111         returns Boolean from Standard;
112
113     IsVClosed(myclass; S: HSurface from Adaptor3d) 
114         ---C++: inline
115         returns Boolean from Standard;
116     
117
118     IsUPeriodic(myclass; S: HSurface from Adaptor3d) 
119         ---C++: inline
120         returns Boolean from Standard;
121
122     UPeriod(myclass; S: HSurface from Adaptor3d) 
123         ---C++: inline
124         returns Real from Standard;
125         
126     IsVPeriodic(myclass; S: HSurface from Adaptor3d) 
127         ---C++: inline
128         returns Boolean from Standard;
129     
130     VPeriod(myclass; S: HSurface from Adaptor3d) 
131         ---C++: inline
132         returns Real from Standard;
133         
134
135
136     Value(myclass; S   : HSurface from Adaptor3d;
137                    u,v : Real from Standard)
138         ---C++: inline
139         returns Pnt from gp;
140
141     D0(myclass; S   : HSurface from Adaptor3d; 
142                 u,v : Real from Standard;
143                 P   : out Pnt from gp);
144         ---C++: inline 
145
146     D1(myclass; S      : HSurface from Adaptor3d; 
147                 u,v    : Real from Standard; 
148                 P      : out Pnt from gp;
149                 D1u,D1v: out Vec from gp); 
150         ---C++: inline 
151         
152     D2(myclass; S      : HSurface from Adaptor3d; 
153                 u,v    : Real from Standard; 
154                 P      : out Pnt from gp;
155                 D1U,D1V,D2U,D2V,D2UV: out Vec from gp); 
156         ---C++: inline 
157         
158     D3(myclass; S      : HSurface from Adaptor3d; 
159                 u,v    : Real from Standard; 
160                 P      : out Pnt from gp;
161                 D1U, D1V, D2U, D2V, D2UV, D3U, D3V, D3UUV, D3UVV: out Vec from gp); 
162         ---C++: inline 
163         
164     DN(myclass; S      : HSurface from Adaptor3d; 
165                 u,v    : Real from Standard; 
166                 Nu,Nv  : Integer from Standard)
167         ---C++: inline 
168     returns Vec from gp;
169         
170
171
172     UResolution(myclass; S:HSurface from Adaptor3d; R3d: Real from Standard) 
173         ---C++: inline
174         returns Real from Standard;
175
176     VResolution(myclass; S:HSurface from Adaptor3d; R3d: Real from Standard)
177         ---C++: inline
178         returns Real from Standard;
179
180     GetType(myclass; S: HSurface from Adaptor3d)
181         ---C++: inline
182         returns SurfaceType from GeomAbs;
183
184
185     Plane(myclass; S: HSurface from Adaptor3d) 
186         ---C++: inline
187         returns Pln from gp;
188         
189     Cylinder(myclass; S : HSurface from Adaptor3d) returns Cylinder from gp
190       raises NoSuchObject from Standard;
191         ---C++: inline
192
193     
194     Cone(myclass; S : HSurface from Adaptor3d) returns Cone from gp
195       raises NoSuchObject from Standard;
196         ---C++: inline
197
198     Torus(myclass; S : HSurface from Adaptor3d) returns Torus from gp    
199       raises NoSuchObject from Standard;
200         ---C++: inline
201
202
203     Sphere(myclass; S : HSurface from Adaptor3d) returns Sphere from gp
204       raises NoSuchObject from Standard;
205         ---C++: inline
206
207     Bezier(myclass; S : HSurface from Adaptor3d) returns BezierSurface from  Geom
208       raises NoSuchObject from Standard;
209         ---C++: inline
210
211     BSpline(myclass; S : HSurface from Adaptor3d) returns BSplineSurface  from  Geom
212       raises NoSuchObject from Standard;
213         ---C++: inline
214     
215     AxeOfRevolution(myclass; S: HSurface from Adaptor3d) returns Ax1 from  gp 
216       raises NoSuchObject from Standard;
217         ---C++: inline
218
219     Direction(myclass; S: HSurface from Adaptor3d) returns Dir from gp
220       raises NoSuchObject from Standard;
221         ---C++: inline
222
223     BasisCurve(myclass; S:HSurface from Adaptor3d) returns HCurve from Adaptor3d 
224       raises NoSuchObject from Standard;
225         ---C++: inline
226   
227     BasisSurface(myclass; S:HSurface from Adaptor3d) returns HSurface from Adaptor3d
228       raises NoSuchObject from Standard;
229         ---C++: inline
230
231     OffsetValue(myclass; S:HSurface from Adaptor3d) returns Real from Standard
232       raises NoSuchObject from Standard;
233         ---C++: inline
234
235
236 --------------------------------------------------------------------------------
237
238
239     NbSamplesU(myclass; S : HSurface from Adaptor3d) returns Integer from Standard; 
240
241        
242     NbSamplesV(myclass; S : HSurface from Adaptor3d) returns Integer from Standard;    
243
244
245     NbSamplesU(myclass; S : HSurface from Adaptor3d; u1,u2: Real from Standard) returns Integer from Standard; 
246
247        
248     NbSamplesV(myclass; S : HSurface from Adaptor3d; v1,v2: Real from Standard) returns Integer from Standard;    
249
250
251 end HSurfaceTool;