0023024: Update headers of OCCT files
[occt.git] / src / Adaptor2d / Adaptor2d_Line2d.cdl
1 -- Created on: 1995-05-02
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
24 class Line2d from Adaptor2d inherits Curve2d from Adaptor2d
25
26 uses 
27      Array1OfReal from TColStd,
28      Pnt2d        from gp,
29      Dir2d        from gp,
30      Vec2d        from gp,
31      Lin2d        from gp,
32      Ax2d         from gp,
33      Circ2d       from gp,
34      Elips2d      from gp,
35      Hypr2d       from gp,
36      Parab2d      from gp,
37      Shape        from GeomAbs,
38      CurveType    from GeomAbs,
39      BezierCurve     from Geom2d,
40      BSplineCurve    from Geom2d,
41      HCurve2d        from Adaptor2d
42
43 raises
44     
45     OutOfRange          from Standard,
46     NoSuchObject        from Standard,
47     DomainError         from Standard
48     
49 is
50
51     Create returns  Line2d from Adaptor2d;
52
53     Create(P: Pnt2d from gp; 
54            D: Dir2d from gp;
55            UFirst,ULast: Real from Standard)
56     returns  Line2d from Adaptor2d;
57
58     Load(me : in out; L : Lin2d from gp)
59     is static;
60
61     Load(me : in out; L : Lin2d from gp;
62          UFirst,ULast: Real from Standard)
63     is static;
64
65     FirstParameter(me)
66         returns Real from Standard
67         is redefined static;
68
69     LastParameter(me)
70         returns Real from Standard
71         is redefined static;
72     
73     Continuity(me)
74         returns Shape from GeomAbs
75         is redefined static;
76     
77     NbIntervals(me; S : Shape from GeomAbs) returns Integer
78         ---Purpose: If necessary,  breaks the  curve in  intervals  of
79         --          continuity  <S>.    And  returns   the number   of
80         --          intervals.
81     is redefined static;
82     
83     Intervals(me; T : in out Array1OfReal from TColStd; 
84                   S : Shape from GeomAbs)
85         ---Purpose: Stores in <T> the  parameters bounding the intervals
86         --          of continuity <S>.
87         --          
88         --          The array must provide  enough room to  accomodate
89         --          for the parameters. i.e. T.Length() > NbIntervals()
90     raises
91         OutOfRange from Standard 
92     is redefined static;
93     
94     Trim(me; First, Last, Tol : Real) returns HCurve2d from Adaptor2d
95         ---Purpose: Returns    a  curve equivalent   of  <me>  between
96         --          parameters <First>  and <Last>. <Tol>  is used  to
97         --          test for 3d points confusion.
98     raises
99         OutOfRange from Standard
100         ---Purpose: If <First> >= <Last> 
101     is redefined static;
102
103     IsClosed(me)
104         returns Boolean from Standard
105         is redefined static;
106      
107     IsPeriodic(me)
108         returns Boolean from Standard
109         is redefined static;
110
111     Period(me) returns Real
112     raises
113         DomainError from Standard -- if the curve is not periodic
114     is redefined static;
115      
116     Value(me; X: Real from Standard)
117         returns Pnt2d from gp
118         is redefined static;
119
120     D0(me; X: Real from Standard; P: out Pnt2d from gp)
121         is redefined static;
122
123     D1(me; X: Real from Standard;
124                     P: out Pnt2d from gp; V: out Vec2d from gp)
125         is redefined static;
126
127     D2(me; X: Real from Standard;
128                     P: out Pnt2d from gp; V1,V2: out Vec2d from gp)
129         is redefined static;
130
131     D3(me; X: Real from Standard;
132                     P: out Pnt2d from gp; V1,V2,V3: out Vec2d from gp)
133         is redefined static;
134
135     DN (me; U : Real; N : Integer)
136         returns Vec2d from gp
137         is redefined static;
138
139
140     Resolution(me; R3d : Real)
141         returns Real from Standard
142         is redefined static;
143
144         
145     GetType(me)
146         returns CurveType from GeomAbs
147         is redefined static;
148
149
150      Line(me)
151         returns Lin2d from gp
152         is redefined static;
153
154      Circle(me) returns Circ2d from gp
155      raises 
156         NoSuchObject from Standard
157      is redefined static;
158      
159      Ellipse(me) returns Elips2d from gp
160      raises 
161         NoSuchObject from Standard
162      is redefined static;
163      
164      Hyperbola(me) returns  Hypr2d from gp
165      raises 
166         NoSuchObject from Standard
167      is redefined static;
168      
169      Parabola(me) returns Parab2d from gp
170      raises 
171         NoSuchObject from Standard
172      is redefined static;
173      
174      
175      Degree(me) returns Integer
176      raises 
177         NoSuchObject from Standard
178      is redefined static;
179      
180      IsRational(me) returns Boolean
181      raises 
182         NoSuchObject from Standard
183      is redefined static;
184      
185      NbPoles(me) returns Integer
186      raises 
187         NoSuchObject from Standard
188      is redefined static;
189
190   
191      NbKnots(me) returns Integer
192      raises 
193         NoSuchObject from Standard
194      is redefined static;     
195           
196
197      
198      Bezier(me) returns BezierCurve from Geom2d
199      raises 
200         NoSuchObject from Standard
201      is redefined static;
202     
203      BSpline(me) returns BSplineCurve from Geom2d
204      raises 
205         NoSuchObject from Standard
206      is redefined static;
207
208 fields
209
210     myUfirst : Real from Standard;
211     myUlast  : Real from Standard;
212     myAx2d   : Ax2d from gp;
213
214 end Line2d;