0023024: Update headers of OCCT files
[occt.git] / src / Adaptor2d / Adaptor2d_HCurve2d.cdl
1 -- Created on: 1994-02-23
2 -- Created by: model
3 -- Copyright (c) 1994-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 deferred class HCurve2d from Adaptor2d inherits TShared from MMgt
24
25         ---Purpose: Root class for 2D curves manipulated by handles, on
26         -- which geometric algorithms work.
27         -- An adapted curve is an interface between the
28         -- services provided by a curve, and those required of
29         -- the curve by algorithms, which use it.
30         -- A derived specific class is provided:
31         -- Geom2dAdaptor_HCurve for a curve from the Geom2d package. 
32
33
34
35 uses
36
37      Array1OfReal from TColStd,
38      Shape        from GeomAbs,
39      CurveType    from GeomAbs,
40      Vec2d        from gp,
41      Pnt2d        from gp,
42      Circ2d       from gp,
43      Elips2d      from gp,
44      Hypr2d       from gp,
45      Parab2d      from gp,
46      Lin2d        from gp,
47      BezierCurve  from Geom2d,
48      BSplineCurve from Geom2d,
49      Curve2d      from Adaptor2d
50      
51 raises
52     
53     OutOfRange          from Standard,
54     NoSuchObject        from Standard,
55     DomainError         from Standard,
56     NotImplemented      from Standard
57  
58 is
59
60     --
61     --  Access to the curve
62     --  
63     
64     Curve2d(me) returns Curve2d from Adaptor2d
65         ---Purpose: Returns a reference to the Curve2d inside the HCurve2d.
66         --          
67         ---C++: return const &
68     is deferred;
69    
70       
71     --     Curve  methods,  they are  provided  for convenience.  Each
72     --     method M() is defined inline as :
73     --     
74     --     Adaptor_HCurve::M() { Curve().M(); }
75     --     
76     --     See the class Curve for comments on the methods.
77     --     
78     --
79     --     Global methods - Apply to the whole curve.
80     --     
81     
82     FirstParameter(me) returns Real ;
83     ---C++: inline  
84     LastParameter(me) returns Real ;
85     ---C++: inline
86             
87     Continuity(me) returns Shape from GeomAbs ;
88     ---C++: inline
89     --      
90     
91     NbIntervals(me ; S : Shape from GeomAbs) returns Integer ; 
92     ---C++: inline
93     --      
94     
95     Intervals(me; T : in out Array1OfReal from TColStd; 
96                   S : Shape from GeomAbs)
97     ---C++: inline
98     raises
99         OutOfRange from Standard 
100     is static;
101     
102     Trim(me; First, Last, Tol : Real) returns HCurve2d from Adaptor2d
103     ---C++: inline
104     raises
105         OutOfRange from Standard
106         ---Purpose: If <First> >= <Last> 
107     is static;
108
109     --
110     --     Local methods - Apply to the current interval.
111     --     By default the current interval is the first.
112     --     
113     
114     IsClosed(me) returns Boolean ;
115     ---C++: inline
116     --      
117      
118     IsPeriodic(me) returns Boolean ;
119     ---C++: inline
120     --      
121     
122     Period(me) returns Real ;
123     ---C++: inline
124     --      
125      
126     Value(me; U : Real) returns Pnt2d from gp ;
127     ---C++: inline
128     --      
129     
130     D0 (me; U : Real; P : out Pnt2d from gp) ;
131     ---C++: inline
132     --      
133     
134     D1 (me; U : Real; P : out Pnt2d from gp ; V : out Vec2d from gp)  ; 
135     ---C++: inline
136     --      
137     
138     D2 (me; U : Real; P : out Pnt2d from gp;
139                                V1, V2 : out Vec2d from gp) ;
140        ---C++: inline
141        --      
142
143     D3 (me; U : Real; P : out Pnt2d from gp;  
144                             V1, V2, V3 : out Vec2d from gp) ;
145     ---C++: inline
146     --      
147         
148     DN (me; U : Real; N : Integer)   returns Vec2d from gp ;
149     ---C++: inline
150     --      
151
152     Resolution(me; R3d : Real) returns Real ;
153     ---C++: inline
154     --      
155
156     GetType(me) returns CurveType from GeomAbs ;
157     ---C++: inline
158     --      
159
160     --
161     --     The following methods must  be called when GetType returned
162     --     the corresponding type.
163     --     
164
165      Line(me) returns Lin2d from gp ;
166      ---C++: inline
167      --      
168      
169      Circle(me) returns Circ2d from gp ;
170      ---C++: inline
171      --      
172      
173      Ellipse(me) returns Elips2d from gp ;
174      ---C++: inline
175      --      
176      
177      Hyperbola(me) returns  Hypr2d from gp ;
178      ---C++: inline
179      --      
180      
181      Parabola(me) returns Parab2d from gp ;
182      ---C++: inline
183      --  
184
185      Degree(me) returns Integer
186             ---C++: inline
187      raises 
188         NoSuchObject from Standard ;
189         
190      IsRational(me) returns Boolean
191             ---C++: inline
192      raises 
193         NoSuchObject from Standard ;
194
195      
196      NbPoles(me) returns Integer
197             ---C++: inline
198      raises 
199         NoSuchObject from Standard ;
200
201     
202      NbKnots(me) returns Integer
203             ---C++: inline
204      raises 
205         NoSuchObject from Standard ;
206      
207
208      Bezier(me) returns BezierCurve from Geom2d
209             ---C++: inline
210      raises 
211         NoSuchObject from Standard;
212     
213      BSpline(me) returns BSplineCurve from Geom2d
214             ---C++: inline
215      raises 
216         NoSuchObject from Standard,
217         OutOfRange   from Standard -- if TK has not length NbKnots
218      is virtual;
219     
220
221 end HCurve2d;