0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / PGeom / PGeom_BSplineSurface.cdl
1 -- Created on: 1993-03-02
2 -- Created by: Philippe DAUTRY
3 -- Copyright (c) 1993-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 BSplineSurface from PGeom inherits BoundedSurface from PGeom
18
19         ---Purpose : Definition  of  a B-spline   Surface   (it can be
20         --         rational,  periodic and   non uniform) The  maximum
21         --         degree  of  the  normalized B-spline   functions is
22         --         limited to 9 in this package.
23         --  
24         ---See Also : BSplineSurface from Geom.
25
26 uses  HArray1OfInteger from PColStd,
27       HArray1OfReal    from PColStd,
28       HArray2OfReal    from PColStd,
29       HArray2OfPnt     from PColgp
30
31
32 is
33   
34   Create returns BSplineSurface from PGeom;
35         ---Purpose: Creates a BSplineSurface with default values.
36         ---Level: Internal 
37
38
39   Create (
40             aURational : Boolean from Standard;
41             aVRational : Boolean from Standard;
42             aUPeriodic : Boolean from Standard;
43             aVPeriodic : Boolean from Standard;
44             aUSpineDegree      : Integer from Standard;
45             aVSpineDegree      : Integer from Standard;
46             aPoles     : HArray2OfPnt from PColgp;
47             aWeights   : HArray2OfReal from PColStd;
48             aUKnots    : HArray1OfReal from PColStd;
49             aVKnots    : HArray1OfReal from PColStd;
50             aUMultiplicities    : HArray1OfInteger from PColStd;
51             aVMultiplicities    : HArray1OfInteger from PColStd)
52     returns BSplineSurface from PGeom;
53         ---Purpose: Creates a BSplineSurface with these values.
54
55
56
57   URational (me: mutable; aURational: Boolean from Standard);
58         ---Purpose : Set the value of the field uRational with <aURational>.
59         ---Level: Internal 
60
61
62   URational (me) returns Boolean from Standard;
63         ---Purpose : Returns the value of the field uRational.
64         ---Level: Internal 
65
66
67   VRational (me: mutable; aVRational: Boolean from Standard);
68         ---Purpose : Set the value of the field vRational with <aVRational>.
69         ---Level: Internal 
70
71
72   VRational (me) returns Boolean from Standard;
73         ---Purpose : Returns the value of the field vRational.
74         ---Level: Internal 
75
76
77   UPeriodic (me: mutable; aUPeriodic: Boolean from Standard);
78         ---Purpose: Set the value of the field uPeriodic with <aUPeriodic>.
79         ---Level: Internal 
80
81
82   UPeriodic (me) returns Boolean from Standard;
83         ---Level: Internal 
84         ---Purpose: Returns the value of the field uPeriodic.
85
86
87   VPeriodic (me: mutable; aVPeriodic: Boolean from Standard);
88         ---Purpose: Set the value of the field vPeriodic with <aVPeriodic>.
89         ---Level: Internal 
90
91
92   VPeriodic (me) returns Boolean from Standard;
93         ---Purpose: Returns the value of the field vPeriodic.
94         ---Level: Internal 
95
96
97   USpineDegree (me: mutable; aUSpineDegree: Integer from Standard);
98         ---Purpose : Set  the value  of the  field  uSpineDegree  with
99         --         <aUSpineDegree>.
100         ---Level: Internal 
101
102
103   USpineDegree (me) returns Integer from Standard;
104         ---Purpose : Returns the value of the field uSpineDegree.
105         ---Level: Internal 
106
107
108   VSpineDegree (me: mutable; aVSpineDegree: Integer from Standard);
109         ---Purpose : Set  the value  of the  field  vSpineDegree  with
110         --         <aVSpineDegree>.
111         ---Level: Internal 
112
113
114   VSpineDegree (me) returns Integer from Standard;
115         ---Purpose : Returns the value of the field vSpineDegree.
116         ---Level: Internal 
117
118
119   Poles (me: mutable; aPoles : HArray2OfPnt from PColgp);
120         ---Purpose: Set the value of the field poles with <aPoles>.
121         ---Level: Internal 
122
123
124   Poles (me) returns HArray2OfPnt from PColgp;
125         ---Purpose: Returns the value of the field poles.
126         ---Level: Internal 
127
128
129   Weights (me: mutable; aWeights : HArray2OfReal from PColStd);
130         ---Purpose: Set the value of the field weights with <aWeights>.
131         ---Level: Internal 
132
133
134   Weights (me) returns HArray2OfReal from PColStd;
135         ---Purpose: Returns the value of the field weights.
136         ---Level: Internal 
137
138
139   UKnots (me: mutable; aUKnots : HArray1OfReal from PColStd);
140         ---Purpose: Set the value of the field uKnots with <aUKnots>.
141         ---Level: Internal 
142
143
144   UKnots (me) returns HArray1OfReal from PColStd;
145         ---Purpose: Returns the value of the field uKnots.
146         ---Level: Internal 
147
148
149   VKnots (me: mutable; aVKnots : HArray1OfReal from PColStd);
150         ---Purpose: Set the value of the field vKnots with <aVKnots>.
151         ---Level: Internal 
152
153
154   VKnots (me) returns HArray1OfReal from PColStd;
155         ---Purpose: Returns the value of the field vKnots.
156         ---Level: Internal 
157
158
159   UMultiplicities (me: mutable;
160                     aUMultiplicities : HArray1OfInteger from PColStd);
161         ---Purpose: Set the  value of the  field  uMultiplicities with
162         --          <aUMultiplicities>.
163         ---Level: Internal 
164
165
166   UMultiplicities (me) returns HArray1OfInteger from PColStd;
167         ---Purpose: Returns the value of the field uMultiplicities.
168         ---Level: Internal 
169
170
171   VMultiplicities (me: mutable;
172                     aVMultiplicities : HArray1OfInteger from PColStd);
173         ---Purpose: Set the value  of  the field vMultiplicities  with
174         --          <aVMultiplicities>.
175         ---Level: Internal 
176
177
178   VMultiplicities (me) returns HArray1OfInteger from PColStd;
179         ---Purpose: Returns the value of the field vMultiplicities.
180         ---Level: Internal 
181
182
183 fields
184              
185    uRational       : Boolean from Standard;
186    vRational       : Boolean from Standard;
187    uPeriodic       : Boolean from Standard;
188    vPeriodic       : Boolean from Standard;
189    uSpineDegree    : Integer from Standard;
190    vSpineDegree    : Integer from Standard;
191    poles           : HArray2OfPnt from PColgp;
192    weights         : HArray2OfReal from PColStd;
193    uKnots          : HArray1OfReal from PColStd;
194    vKnots          : HArray1OfReal from PColStd;
195    uMultiplicities : HArray1OfInteger from PColStd;
196    vMultiplicities : HArray1OfInteger from PColStd;
197    
198 end;