0024624: Lost word in license statement in source files
[occt.git] / src / DrawTrSurf / DrawTrSurf_Surface.cdl
1 -- Created on: 1992-05-21
2 -- Created by: Jean Claude VAUTHIER
3 -- Copyright (c) 1992-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 Surface from DrawTrSurf
18      
19 inherits Drawable 
20
21         ---Purpose:  This class defines a drawable surface.
22         -- With this class you can draw a general surface from 
23         -- package Geom.
24
25 uses Surface     from Geom,
26      Display     from Draw,
27      Color       from Draw,
28      Drawable3D  from Draw,
29      Interpretor from Draw 
30
31 is
32
33   Create (S : Surface from Geom)
34         --- Purpose : default drawing mode
35         --  Just the middle isoparametric curves are drawn.
36         --  The boundaries are yellow, the isoparametric curves are blues.
37         --  For the discretisation 50 points are computed in each parametric
38         --  direction.
39      returns mutable Surface from DrawTrSurf;
40
41
42
43   Create (S : Surface from Geom;
44           Nu, Nv : Integer;
45           BoundsColor, IsosColor : Color from Draw;
46           Discret : Integer;
47           Deflection : Real;
48           DrawMode  : Integer)
49      returns mutable Surface from DrawTrSurf;
50
51
52   BoundsColor (me) returns Color from Draw
53         ---C++: inline
54      is static;
55
56
57   ClearIsos (me : mutable) is virtual;
58         --- Purpose : rub out all the isoparametric curves.
59      
60
61   DrawOn (me; dis : in out Display from Draw);
62
63
64   DrawOn (me; dis : in out Display from Draw;
65               Iso : Boolean from Standard)
66        ---Purpose: Iso = True : Draw the isos, the boundaries, the UVMarker.
67        --          Iso = False: Only Draw the boundary and the UVMarker.
68   is static;
69   
70   
71   GetSurface (me) returns any Surface from Geom
72         ---C++: inline
73      is static;
74
75
76   IsosColor (me) returns Color from Draw
77         ---C++: inline
78      is static;
79
80
81   NbIsos (me; Nu, Nb : in out Integer)
82         ---C++: inline
83      is static;
84      
85
86   SetBoundsColor (me : mutable; aColor : Color from Draw)
87         ---C++: inline
88      is static;
89
90
91   SetIsosColor (me : mutable; aColor : Color from Draw)
92         ---C++: inline
93      is static;
94
95
96   ShowIsos (me : mutable; Nu, Nv : Integer) is virtual;
97         --- Purpose : change the number of isoparametric curves to be drawn.
98
99   Copy(me) returns mutable Drawable3D from Draw
100         ---Purpose: For variable copy.
101   is redefined;
102   
103   Dump(me; S : in out OStream)
104         ---Purpose: For variable dump.
105   is redefined;
106   
107   Whatis(me; I : in out Interpretor from Draw)
108         ---Purpose: For variable whatis command.
109   is redefined;
110
111 fields
112
113   surf        : Surface from Geom is protected;
114   boundsLook  : Color from Draw   is protected;
115   isosLook    : Color from Draw   is protected;
116   nbUIsos     : Integer           is protected;
117   nbVIsos     : Integer           is protected;
118
119 end Surface;