0024162: Eliminate CLang compiler warning
[occt.git] / src / Extrema / Extrema_Curve2dTool.cdl
1 -- Created on: 1995-07-18
2 -- Created by: Modelistation
3 -- Copyright (c) 1995-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 Curve2dTool from Extrema
24
25 uses
26      Curve2d         from Adaptor2d,
27      Array1OfReal    from TColStd,
28      Shape           from GeomAbs,
29      CurveType       from GeomAbs,
30      Vec2d           from gp,
31      Pnt2d           from gp,
32      Circ2d          from gp,
33      Elips2d         from gp,
34      Hypr2d          from gp,
35      Parab2d         from gp,
36      Lin2d           from gp,
37      BezierCurve     from Geom2d,
38      BSplineCurve    from Geom2d,
39      HCurve2d        from Adaptor2d
40
41 is
42
43     FirstParameter(myclass; C : Curve2d from Adaptor2d) returns Real
44         ---C++: inline
45     ;
46
47     LastParameter(myclass; C : Curve2d from Adaptor2d) returns Real
48         ---C++: inline
49     ;
50     
51     Continuity(myclass; C : Curve2d from Adaptor2d) returns Shape from GeomAbs
52         ---C++: inline
53     ;
54     
55     NbIntervals(myclass; C : Curve2d from Adaptor2d; S : Shape from GeomAbs) returns Integer
56         ---Purpose: If necessary,   breaks the curve  in  intervals of
57         --          continuity <S>.     And   returns  the  number  of
58         --          intervals.
59         ---C++: inline
60     ;
61     
62     Intervals(myclass; C : Curve2d               from Adaptor2d;
63                        T : in out Array1OfReal from TColStd; 
64                        S : Shape               from GeomAbs);
65         ---Purpose: Stores in <T> the  parameters bounding the intervals
66         --          of continuity <S>.
67         ---C++: inline
68
69
70     IsClosed(myclass; C : Curve2d from Adaptor2d) returns Boolean
71         ---C++: inline
72     ;
73      
74     IsPeriodic(myclass; C : Curve2d from Adaptor2d) returns Boolean
75         ---C++: inline
76     ;
77     
78     Period(myclass; C : Curve2d from Adaptor2d) returns Real
79         ---C++: inline
80     ;
81      
82     Value(myclass; C : Curve2d from Adaptor2d; U : Real) returns Pnt2d from gp
83          --- Purpose : Computes the point of parameter U on the curve.
84         ---C++: inline
85     ;
86     
87     D0 (myclass; C : Curve2d from Adaptor2d; U : Real; P : out Pnt2d from gp)
88          --- Purpose : Computes the point of parameter U on the curve.
89         ---C++: inline
90     ;
91     
92     D1 (myclass; C : Curve2d from Adaptor2d; U : Real; P : out Pnt2d from gp ; V : out Vec2d from gp)
93          --- Purpose : Computes the point of parameter U on the curve with its
94          --  first derivative.
95         ---C++: inline
96     ;
97     
98     D2 (myclass; C : Curve2d from Adaptor2d; U : Real; P : out Pnt2d from gp; V1, V2 : out Vec2d from gp)
99         --- Purpose :
100         --  Returns the point P of parameter U, the first and second
101         --  derivatives V1 and V2.
102         ---C++: inline
103     ;
104
105     D3 (myclass; C : Curve2d from Adaptor2d; U : Real; P : out Pnt2d from gp; V1, V2, V3 : out Vec2d from gp)
106         --- Purpose :
107         --  Returns the point P of parameter U, the first, the second 
108         --  and the third derivative.
109         ---C++: inline
110     ;
111         
112     DN (myclass; C : Curve2d from Adaptor2d; U : Real; N : Integer)   returns Vec2d from gp
113         --- Purpose :
114         --  The returned vector gives the value of the derivative for the 
115         --  order of derivation N.
116         ---C++: inline
117     ;
118
119     Resolution(myclass; C : Curve2d from Adaptor2d ; R3d : Real) returns Real
120          ---Purpose :  Returns the parametric  resolution corresponding
121          --         to the real space resolution <R3d>.
122         ---C++: inline
123     ;   
124         
125     GetType(myclass; C : Curve2d from Adaptor2d) returns CurveType from GeomAbs
126         ---Purpose: Returns  the  type of the   curve  in the  current
127         --          interval :   Line,   Circle,   Ellipse, Hyperbola,
128         --          Parabola, BezierCurve, BSplineCurve, OtherCurve.
129         ---C++: inline
130     ;
131
132
133      Line(myclass; C : Curve2d from Adaptor2d) returns Lin2d from gp
134         ---C++: inline
135     ;
136      
137      Circle(myclass; C : Curve2d from Adaptor2d) returns Circ2d from gp
138         ---C++: inline
139     ;
140      
141      Ellipse(myclass; C : Curve2d from Adaptor2d) returns Elips2d from gp
142         ---C++: inline
143     ;
144      
145      Hyperbola(myclass; C : Curve2d from Adaptor2d) returns  Hypr2d from gp
146         ---C++: inline
147     ;
148      
149      Parabola(myclass; C : Curve2d from Adaptor2d) returns Parab2d from gp
150         ---C++: inline
151     ;
152      
153      Degree(myclass; C : Curve2d from Adaptor2d) returns Integer
154         ---C++: inline
155     ;
156      
157      IsRational(myclass; C : Curve2d from Adaptor2d) returns Boolean
158         ---C++: inline
159     ;
160      
161      NbPoles(myclass; C : Curve2d from Adaptor2d) returns Integer
162         ---C++: inline
163     ;
164      
165      NbKnots(myclass; C : Curve2d from Adaptor2d) returns Integer
166         ---C++: inline
167     ;
168      
169      Bezier(myclass; C : Curve2d from Adaptor2d) returns BezierCurve from  Geom2d
170         ---C++: inline
171     ;
172      
173      BSpline(myclass; C : Curve2d from Adaptor2d) returns BSplineCurve from  Geom2d
174         ---C++: inline
175     ;
176
177
178 end Curve2dTool;