0023024: Update headers of OCCT files
[occt.git] / src / DrawTrSurf / DrawTrSurf_BSplineSurface.cdl
1 -- Created on: 1992-05-22
2 -- Created by: Jean Claude VAUTHIER
3 -- Copyright (c) 1992-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 class BSplineSurface  from DrawTrSurf 
24
25 inherits Surface from DrawTrSurf
26
27         --- Purpose :
28         --  This class defines a drawable BSplineSurface. 
29         --  With this class you can draw the control points and the knots 
30         --  of the surface.
31         --  You can use the general class Surface from DrawTrSurf too,
32         --  if you just want to sea boundaries and isoparametric curves.
33
34 uses BSplineSurface from Geom,
35      Color from Draw,
36      MarkerShape from Draw,
37      Display from Draw,
38      Drawable3D from Draw
39
40 is
41
42
43
44   Create (S : BSplineSurface from Geom)
45      returns mutable BSplineSurface from DrawTrSurf;
46         --- Purpose : default drawing mode.
47         --  The isoparametric curves corresponding to the knots values are 
48         --  drawn.
49         --  The control points and the knots points are drawn.
50         --  The boundaries are yellow, the isoparametric curves are blues.
51         --  For the discretisation 50 points are computed in each parametric
52         --  direction.
53
54
55   Create (S : BSplineSurface from Geom;
56           BoundsColor, IsosColor, PolesColor, KnotsColor : Color from Draw;
57           KnotsShape : MarkerShape from Draw; KnotsSize : Integer;
58           ShowPoles, ShowKnots : Boolean; Discret : Integer; Deflection : Real;
59           DrawMode : Integer)
60      returns mutable BSplineSurface from DrawTrSurf;
61         --- Purpose :
62         --  The isoparametric curves corresponding to the knots values are 
63         --  drawn.
64
65
66
67   Create (S : BSplineSurface from Geom;
68           NbUIsos, NbVIsos : Integer;
69           BoundsColor, IsosColor, PolesColor, KnotsColor : Color from Draw;
70           KnotsShape : MarkerShape from Draw; KnotsSize : Integer;
71           ShowPoles, ShowKnots : Boolean; Discret : Integer; Deflection : Real;
72           DrawMode : Integer)
73      returns mutable BSplineSurface from DrawTrSurf;
74         --- Purpose : Parametric equidistant iso curves are drawn.
75
76
77   DrawOn (me; dis : in out Display from Draw)
78      is redefined static;
79
80
81   ShowPoles  (me : mutable)
82      is static;
83
84
85   ShowKnots  (me : mutable)
86      is static;
87
88
89   ShowIsos (me : mutable; Nu, Nv : Integer)
90         --- Purpose : change the number of isoparametric curves to be drawn.
91      is redefined;
92
93
94   ShowKnotsIsos (me : mutable)
95         --- Purpose : change the number of isoparametric curves to be drawn.
96      is static;
97
98
99   ClearIsos (me : mutable)
100         --- Purpose : rub out all the isoparametric curves.
101      is redefined;
102      
103
104   ClearPoles (me : mutable)
105      is static;
106   
107
108   ClearKnots (me : mutable)
109      is static;
110
111
112   FindPole(me; X,Y : Real; D : Display from Draw; Prec : Real; 
113             UIndex, VIndex : in out Integer)
114   is static;
115   
116
117   FindUKnot(me; X,Y : Real; D : Display from Draw; Prec : Real; 
118             UIndex : in out Integer)
119   is static;
120
121
122   FindVKnot(me; X,Y : Real; D : Display from Draw; Prec : Real; 
123             VIndex : in out Integer)
124   is static;
125
126
127   SetPolesColor (me : mutable; aColor : Color from Draw)
128         ---C++: inline
129      is static;
130
131
132   SetKnotsColor (me : mutable; aColor : Color from Draw)
133         ---C++: inline
134      is static;
135
136
137   SetKnotsShape (me : mutable; Shape : MarkerShape from Draw)
138         ---C++: inline
139      is static;
140
141
142   KnotsShape (me)  returns MarkerShape from Draw
143         ---C++: inline
144      is static;
145   
146
147   KnotsColor (me)  returns Color from Draw
148         ---C++: inline
149      is static;
150   
151
152   PolesColor (me)  returns Color from Draw
153         ---C++: inline
154      is static;
155     
156   Copy(me) returns mutable Drawable3D from Draw
157         ---Purpose: For variable copy.
158   is redefined;
159         
160
161 fields
162
163   drawPoles   : Boolean;
164   drawKnots   : Boolean;
165   knotsIsos   : Boolean;
166   knotsForm   : MarkerShape from Draw;
167   knotsLook   : Color from Draw;
168   knotsDim    : Integer;
169   polesLook   : Color from Draw;
170
171 end BSplineSurface;