0024428: Implementation of LGPL license
[occt.git] / src / BRepAdaptor / BRepAdaptor_Curve2d.cdl
1 -- Created on: 1993-07-13
2 -- Created by: Remi LEQUETTE
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
9 -- under the terms of the GNU Lesser General Public 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 Curve2d from BRepAdaptor inherits Curve from Geom2dAdaptor
18
19         ---Purpose: The Curve2d from BRepAdaptor allows to use an Edge
20         --          on   a Face like   a  2d   curve. (curve  in   the
21         --          parametric space).
22         --          
23         --          It  has  the methods    of the class Curve2d  from
24         --          Adpator. 
25         --          
26         --          It  is created or  initialized with a  Face and an
27         --          Edge.  The methods are  inherited from  Curve from
28         --          Geom2dAdaptor. 
29
30 uses
31     Face from TopoDS,
32     Edge from TopoDS
33
34 raises
35     NullObject from Standard
36
37 is
38
39     Create returns Curve2d from BRepAdaptor;
40         ---Purpose: Creates an uninitialized curve2d.
41
42     Create(E : Edge from TopoDS; F : Face from TopoDS)
43     returns Curve2d from BRepAdaptor
44         ---Purpose: Creates with the pcurve of <E> on <F>.
45     raises
46         NullObject from Standard; -- if <E> has no pcurve on <F>
47         
48     Initialize(me : in out; E : Edge from TopoDS; F : Face from TopoDS)
49         ---Purpose: Initialize with the pcurve of <E> on <F>.
50     raises
51         NullObject from Standard -- if <E> has no pcurve on <F>
52     is static;
53     
54     Edge(me) returns Edge from TopoDS
55         ---Purpose: Returns the Edge.
56         --          
57         ---C++: return const &
58     is static;
59
60     Face(me) returns Face from TopoDS
61         ---Purpose: Returns the Face.
62         --          
63         ---C++: return const &
64     is static;
65
66 fields
67
68     myEdge : Edge from TopoDS;
69     myFace : Face from TopoDS;
70         
71 end Curve2d;