0024784: Move documentation in CDL files to proper location
[occt.git] / src / DBRep / DBRep_Face.cdl
1 -- Created on: 1993-07-15
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 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 Face from DBRep inherits TShared from MMgt
18         ---Purpose: Display of a face. Face + Array of iso + color.
19 uses
20     Face            from TopoDS,
21     IsoType         from GeomAbs,
22     Array1OfInteger from TColStd,
23     Array1OfReal    from TColStd,
24     Color           from Draw
25
26 is
27     Create (F : Face from TopoDS; 
28             N : Integer;
29             C : Color from Draw)
30     returns Face from DBRep;
31         ---Purpose: N is the number of iso intervals.
32     
33     Face(me) returns Face from TopoDS
34         ---C++: return const &
35         ---C++: inline
36     is static;
37
38     Face(me : mutable; F : Face from TopoDS)
39         ---C++: inline
40     is static;
41     
42     NbIsos(me) returns Integer
43         ---C++: inline
44     is static;
45
46     Iso(me : mutable; 
47         I           : Integer; 
48         T           : IsoType from GeomAbs; 
49         Par, T1, T2 : Real)
50         ---C++: inline
51     is static;
52
53     GetIso(me;
54            I           : Integer; 
55            T           : out IsoType from GeomAbs; 
56            Par, T1, T2 : out Real)
57         ---C++: inline
58     is static;
59
60     Color(me) returns Color from Draw
61         ---C++: return const &
62         ---C++: inline
63     is static;
64
65     Color(me : mutable; C : Color from Draw)
66         ---C++: inline
67     is static;
68     
69 fields
70     myFace   : Face            from TopoDS;
71     myColor  : Color           from Draw;
72     myTypes  : Array1OfInteger from TColStd;
73     myParams : Array1OfReal    from TColStd;
74
75 end Face;