1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
--
-- File: Visual3d_Layer.cdl
-- Created: Mardi 1 decembre 1998
-- Author: CAL
--
---Copyright: MatraDatavision 1998
--
class Layer from Visual3d inherits TShared
---Version:
---Purpose: This class allows to manage 2d graphics.
---Keywords:
---Warning:
---References:
uses
Color from Quantity,
PlaneAngle from Quantity,
CLayer2d from Aspect,
TypeOfConstraint from Aspect,
TypeOfLayer from Aspect,
TypeOfLine from Aspect,
TypeOfDisplayText from Aspect,
GraphicDriver from Graphic3d,
TextPath from Graphic3d,
HorizontalTextAlignment from Graphic3d,
VerticalTextAlignment from Graphic3d,
ViewManager from Visual3d,
LayerItem from Visual3d,
NListOfLayerItem from Visual3d,
FontAspect from OSD
raises
LayerDefinitionError from Visual3d
is
-------------------------
-- Category: Constructors
-------------------------
Create (AViewer : ViewManager from Visual3d;
AType : TypeOfLayer from Aspect = Aspect_TOL_OVERLAY;
AFlag : Boolean from Standard = Standard_False)
returns mutable Layer from Visual3d;
---Level: Public
---Purpose: Creates a layer with the type <Atype>.
-- if <AFlag> == Standard_True then the layer is
-- "size dependent".
-- The mapping of the layer is dependent of each
-- window's size.
-- if <AFlag> == Standard_False then the mapping of the
-- layer is dependent of the highest window and the largest
-- window of all the views of the viewer <AViewer>.
-- When the viewer <AViewer> have only one view, the
-- result will be the same with <AFlag> == Standard_False
-- or <AFlag> == Standard_True.
---Category: Constructors
------------------------
-- Category: Destructors
------------------------
Destroy (me : mutable);
---Level: Public
---Purpose: Suppress the layer <me>.
---Category: Destructors
---C++: alias ~
---------------------------------------------------
-- Category: Methods to modify the class definition
---------------------------------------------------
Begin (me : mutable)
---Level: Public
---Purpose: Begins the definition of the layer <me>
-- Warning: No default attributes
raises LayerDefinitionError from Visual3d;
-- if Layer is already open.
---Category: Methods to modify the class definition
End (me : mutable)
---Level: Public
---Purpose: Finishs the definition of the layer <me>.
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Methods to modify the class definition
Clear (me : mutable)
---Level: Public
---Purpose: Clear all graphics managed by the layer <me>.
raises LayerDefinitionError from Visual3d;
-- if Layer is already open.
---Category: Methods to modify the class definition
---------------------------------------
-- Category: Graphic definition methods
---------------------------------------
BeginPolyline (me : mutable)
---Level: Public
---Purpose: After this call, <me> is ready to receive
-- a definition of a polyline with AddVertex().
raises LayerDefinitionError from Visual3d;
-- if a Begin... primitive is already open,
-- or Layer is not open.
---Category: Graphic definition methods
BeginPolygon (me : mutable)
---Level: Public
---Purpose: After this call, <me> is ready to receive
-- a definition of a polygon with AddEdge().
raises LayerDefinitionError from Visual3d;
-- if a Begin... primitive is already open,
-- or Layer is not open.
---Category: Graphic definition methods
AddVertex (me : mutable;
X, Y : Real from Standard;
AFlag : Boolean from Standard = Standard_True)
---Level: Public
---Purpose: Puts <X, Y> as a new point in the current primitive.
-- If <AFlag> then it is a draw between last point and
-- this point else it is a move between last point and
-- this point.
raises LayerDefinitionError from Visual3d;
-- if a Begin... primitive is not open,
-- or Layer is not open.
---Category: Graphic definition methods
ClosePrimitive (me : mutable)
---Level: Public
---Purpose: After this call, <me> stops the reception of
-- a definition of a Begin... primitive.
raises LayerDefinitionError from Visual3d;
-- if a Begin... primitive is not open,
-- or Layer is not open.
---Category: Graphic definition methods
DrawRectangle (me : mutable;
X, Y : Real from Standard;
Width, Height : Real from Standard)
---Level: Public
---Purpose: Draws the rectangle at position <X,Y>.
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Graphic definition methods
DrawText (me : mutable;
AText : CString from Standard;
X, Y : Real from Standard;
AHeight : Real from Standard)
---Level: Public
---Purpose: Draws the string <AText> at position <X,Y>.
-- The attributes are given with respect to the plane of
-- projection.
-- <AHeight> : Height of text.
-- (Relative to the Normalized Projection
-- Coordinates (NPC) Space).
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Graphic definition methods
TextSize (me;
AText : CString from Standard;
AHeight : Real from Standard;
AWidth : in out Real from Standard;
AnAscent : in out Real from Standard;
ADescent : in out Real from Standard )
---Level: Public
---Purpose: Get the size of text.
-- The attributes are given with respect to the plane of
-- projection.
-- <AHeight> : Height of text.
-- (Relative to the Normalized Projection
-- Coordinates (NPC) Space).
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Graphic definition methods
-----------------------------------------------------
-- Category: Methods to manage the graphics attributs
-----------------------------------------------------
SetColor (me : mutable;
AColor : Color from Quantity)
---Level: Public
---Purpose: Modifies the current color.
-- Warning: No default color
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Methods to manage the graphics attributs
SetTransparency (me : mutable;
ATransparency : ShortReal from Standard)
---Level: Public
---Purpose: Modifies the current transparency.
-- Warning: No default transparency
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Methods to manage the graphics attributs
UnsetTransparency (me : mutable)
---Level: Public
---Purpose: Unsets the transparency.
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Methods to manage the graphics attributs
SetLineAttributes (me : mutable;
AType : TypeOfLine from Aspect;
AWidth : Real from Standard)
---Level: Public
---Purpose: Modifies the current lines attributes.
-- Warning: No default attributes
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
---Category: Methods to manage the graphics attributs
SetTextAttributes (me : mutable;
AFont : CString from Standard;
AType : TypeOfDisplayText from Aspect;
AColor : Color from Quantity)
---Level: Public
---Purpose: Modifies the current texts attributes.
-- Warning: No default attributes
raises LayerDefinitionError from Visual3d;
-- if Layer is not open.
-------------------------------------------------------
-- Category: Methods to manage the graphics coordinates
-------------------------------------------------------
SetOrtho (me : mutable;
Left : Real from Standard;
Right : Real from Standard;
Bottom : Real from Standard;
Top : Real from Standard;
Attach : TypeOfConstraint from Aspect = Aspect_TOC_BOTTOM_LEFT)
---Level: Public
---Purpose: Modifies the current coordinates system of the layer <me>.
raises LayerDefinitionError from Visual3d;
-- if Layer is not opened.
---Category: Methods to manage the graphics coordinates
SetViewport (me : mutable;
Width : Integer from Standard;
Height : Integer from Standard)
---Level: Public
---Purpose: Modifies the current viewport of the layer <me>.
raises LayerDefinitionError from Visual3d;
-- if Layer is not opened.
---Category: Methods to manage the graphics coordinates
----------------------------
-- Category: Inquire methods
----------------------------
CLayer (me)
returns CLayer2d from Aspect;
---Level: Public
---Purpose: Returns the associated C structure.
---Category: Inquire methods
Type (me)
returns TypeOfLayer from Aspect;
---Level: Public
---Purpose: Returns the type.
---Category: Inquire methods
AddLayerItem( me : mutable;
Item : LayerItem from Visual3d );
RemoveLayerItem( me : mutable;
Item : LayerItem from Visual3d );
RemoveAllLayerItems( me: mutable );
GetLayerItemList( me )
returns NListOfLayerItem from Visual3d;
---C++: return const &
RenderLayerItems(me);
--- Redraw all loaded layer items
fields
--
-- Classe : Visual3d_Layer
--
-- Purpose : Declaration of the variables specific to layers.
--
-- Reminder : A layer is defined by:
-- - a ViewManager
--
-- the graphic driver used
MyGraphicDriver : GraphicDriver from Graphic3d;
-- the associated C structure
MyCLayer : CLayer2d from Aspect;
-- the ViewManager associated with the view
MyPtrViewManager : Address from Standard;
-- the List of Layer Items
MyListOfLayerItems : NListOfLayerItem from Visual3d;
end Layer from Visual3d;
|
