0024927: Getting rid of "Persistent" functionality -- Code
[occt.git] / src / PGeom2d / PGeom2d_BSplineCurve.cdl
1 -- Created on: 1993-04-06
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 BSplineCurve from PGeom2d inherits BoundedCurve from PGeom2d
18
19         ---Purpose :  Definition of  a  B_spline   curve (it can    be
20         --         periodic, rational and non uniform : NURBS).
21         --         
22         ---See Also : BSplineCurve from Geom2d.
23
24 uses  HArray1OfInteger from PColStd,
25       HArray1OfReal    from PColStd,
26       HArray1OfPnt2d     from PColgp
27
28 is
29
30
31   Create returns BSplineCurve from PGeom2d;
32         ---Purpose: Creates a BSplineCurve with default values.
33         ---Level: Internal 
34
35
36   Create (
37             aRational       : Boolean from Standard;
38             aPeriodic       : Boolean from Standard;
39             aSpineDegree    : Integer from Standard;
40             aPoles          : HArray1OfPnt2d from PColgp;
41             aWeights        : HArray1OfReal from PColStd;
42             aKnots          : HArray1OfReal from PColStd;
43             aMultiplicities : HArray1OfInteger from PColStd)
44      returns BSplineCurve from PGeom2d;
45         ---Purpose: Creates a BSplineCurve with these field values.
46         ---Level: Internal 
47
48
49   Periodic (me: mutable; aPeriodic: Boolean from Standard);
50         ---Purpose :Set the field periodic with <aPeriodic>.
51         ---Level: Internal 
52
53
54   Periodic (me) returns Boolean from Standard;
55         ---Purpose :Returns the value of the field periodic.
56         ---Level: Internal 
57
58
59   Rational (me: mutable; aRational: Boolean from Standard);
60         ---Purpose :Set  the   value  of  the    field rational   with
61         --         <aRational>.
62         ---Level: Internal 
63     
64     
65   Rational (me) returns Boolean from Standard;
66         ---Purpose :Returns the value of the field rational.
67         ---Level: Internal 
68     
69     
70   SpineDegree (me: mutable; aSpineDegree: Integer from Standard);
71         ---Purpose: Set the value of the field spineDegree with <aSpineDegree>.
72         ---Level: Internal 
73
74
75   SpineDegree (me)  returns Integer from Standard;
76         ---Purpose: Returns the value of the field spineDegree.
77         ---Level: Internal 
78
79
80   Poles (me: mutable; aPoles: HArray1OfPnt2d from PColgp);
81         ---Purpose : Set the value of the field poles with <aPoles>.
82         ---Level: Internal 
83
84
85   Poles (me) returns HArray1OfPnt2d from PColgp;
86         ---Purpose : Returns the value of the field poles.
87         ---Level: Internal 
88
89
90   Weights (me: mutable; aWeights : HArray1OfReal from PColStd);
91         ---Purpose : Set the value of the field weights with <aWeights>.
92         ---Level: Internal 
93
94
95   Weights (me) returns HArray1OfReal from PColStd;
96         ---Purpose : Returns the the value of the field weights.
97         ---Level: Internal 
98
99
100   Knots (me: mutable; aKnots : HArray1OfReal);
101         ---Purpose :  Set the field knots with <aKnots>.
102         --  The multiplicity of the knots are not modified.
103         ---Level: Internal 
104
105
106   Knots (me) returns HArray1OfReal from PColStd;
107         ---Purpose : returns the value of the field knots.
108         ---Level: Internal 
109
110
111   Multiplicities (me: mutable; aMultiplicities : HArray1OfInteger);
112         ---Purpose :  Set the field multiplicities with <aMultiplicities>.
113         ---Level: Internal 
114
115
116   Multiplicities (me) returns HArray1OfInteger from PColStd;
117         ---Purpose : returns the value of the field multiplicities.
118         ---Level: Internal 
119
120
121 fields
122
123   rational       : Boolean from Standard;
124   periodic       : Boolean from Standard;
125   spineDegree    : Integer from Standard;
126   poles          : HArray1OfPnt2d from PColgp;
127   weights        : HArray1OfReal from PColStd;
128   knots          : HArray1OfReal from PColStd;
129   multiplicities : HArray1OfInteger from PColStd;
130
131 end;