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
|
--
-- File: Graphic3d_AspectText3d.cdl
-- Created: Jeudi 22 Aout 1991
-- Author: NW,JPB,CAL
-- Modified FMN: 30-11-98 : S4069. Textes always visible.
---Copyright: MatraDatavision 1991,1992,1993,1994
--
class AspectText3d from Graphic3d inherits TShared
---Version:
---Purpose: Creates and updates a group of attributes for
-- text primitives. This group contains the colour,
-- font, expansion factor (height/width ratio), and
-- inter-character space.
--
-- NOTE: The font name is stored in the aspect instance
-- so it is safe to pass it as const char* to OpenGl package
-- without copying the string. However, the aspect should not
-- be deleted until the text drawn using this aspect is no longer
-- visible. The best practice is to keep the aspect in the object's drawer.
uses
Color from Quantity,
TypeOfStyleText from Aspect,
TypeOfDisplayText from Aspect,
AsciiString from TCollection,
FontAspect from OSD
raises
AspectTextDefinitionError from Graphic3d
is
Create
returns mutable AspectText3d from Graphic3d;
---Level: Public
---Purpose: Creates a context table for text primitives
-- defined with the following default values:
--
-- Colour : NOC_YELLOW
-- Font : NOF_ASCII_MONO
-- Expansion factor : 1.
-- Space between characters : 0.
-- The style : TOST_NORMAL
-- The display type : TODT_NORMAL
Create ( AColor : Color from Quantity;
AFont : CString from Standard;
AExpansionFactor : Real from Standard;
ASpace : Real from Standard;
AStyle : TypeOfStyleText from Aspect = Aspect_TOST_NORMAL;
ADisplayType : TypeOfDisplayText from Aspect = Aspect_TODT_NORMAL )
returns mutable AspectText3d from Graphic3d
---Level: Public
---Purpose: Creates a context table for text primitives
-- defined with the specified values.
-- AFont may be to take means from User(example "Courier New")
-- or Font described in OpenGl_FontName(example Graphic3d_NOF_ASCII_MONO)
-- or use default font("Courier")
--
raises AspectTextDefinitionError from Graphic3d;
-- if <AExpansionFactor> is a negative value
---------------------------------------------------
-- Category: Methods to modify the class definition
---------------------------------------------------
SetColor ( me : mutable;
AColor : Color from Quantity )
is static;
---Purpose: Modifies the colour of <me>.
SetExpansionFactor ( me : mutable;
AFactor : Real from Standard )
---Purpose: Modifies the expansion factor (height/width ratio)
-- If the factor is less than 1, the characters will
-- be higher than they are wide.
---Category: Methods to modify the class definition
-- Warning: Raises AspectTextDefinitionError if <AFactor> is a
-- negative value .
raises AspectTextDefinitionError from Graphic3d is static;
SetFont ( me : mutable;
AFont : CString from Standard )
is static;
---Level: Public
---Purpose: Modifies the font of <me>.
---Category: Methods to modify the class definition
---AFont may be to take means from User(example "Courier New")
---or Font described in OpenGl_FontName(example Graphic3d_NOF_ASCII_MONO)
---or use default font("Courier")
SetSpace ( me : mutable;
ASpace : Real from Standard )
is static;
---Level: Public
---Purpose: Modifies the space between the characters.
---Category: Methods to modify the class definition
SetStyle ( me : mutable;
AStyle : TypeOfStyleText from Aspect )
is static;
---Level: Public
---Purpose: Modifies the style of the text.
-- TOST_NORMAL Default text. The text is displayed like any other graphic object.
-- This text can be hidden by another object that is nearest from the
-- point of view.
-- TOST_ANNOTATION The text is always visible. The texte is displayed
-- over the other object according to the priority.
---Category: Methods to modify the class definition
SetDisplayType ( me : mutable;
ADisplayType : TypeOfDisplayText from Aspect )
is static;
---Level: Public
---Purpose: Define the display type of the text.
--
-- TODT_NORMAL Default display. Text only.
-- TODT_SUBTITLE There is a subtitle under the text.
-- TODT_DEKALE The text is displayed with a 3D style.
-- TODT_BLEND The text is displayed in XOR.
---Category: Methods to modify the class definition
SetColorSubTitle ( me : mutable;
AColor : Color from Quantity )
is static;
---Level: Public
---Purpose: Modifies the colour of the subtitle for the TODT_SUBTITLE TextDisplayType
--- and the colour of backgroubd for the TODT_DEKALE TextDisplayType.
---Category: Methods to modify the class definition
SetTextZoomable ( me : mutable;
AFlag : Boolean from Standard );
---Level: Public
---Purpose: Turns usage of text zoomable on/off
---Category: Methods to modify the class definition
GetTextZoomable( me ) returns Boolean from Standard;
---Level: Public
---Purpose: Returns TRUE when the Text Zoomable is on.
SetTextAngle ( me : mutable;
AAngle : Real from Standard );
---Level: Public
---Purpose: Turns usage of text rotated
---Category: Methods to modify the class definition
GetTextAngle( me ) returns Real from Standard;
---Level: Public
---Purpose: Returns Angle of degree
SetTextFontAspect ( me : mutable;
AFontAspect : FontAspect from OSD );
---Level: Public
---Purpose: Turns usage of Aspect text
---Category: Methods to modify the class definition
GetTextFontAspect( me ) returns FontAspect from OSD;
---Level: Public
---Purpose: Returns text FontAspect
----------------------------
-- Category: Inquire methods
----------------------------
Values ( me;
AColor : out Color from Quantity;
AFont : out CString from Standard;
AnExpansionFactor : out Real from Standard;
ASpace : out Real from Standard)
is static;
---Level: Public
---Purpose: Returns the current values of the group <me>.
---Category: Inquire methods
Values ( me;
AColor : out Color from Quantity;
AFont : out CString from Standard;
AnExpansionFactor : out Real from Standard;
ASpace : out Real from Standard;
AStyle : out TypeOfStyleText from Aspect;
ADisplayType : out TypeOfDisplayText from Aspect;
AColorSubTitle : out Color from Quantity
)
is static;
---Level: Public
---Purpose: Returns the current values of the group <me>.
---Category: Inquire methods
Values ( me;
AColor : out Color from Quantity;
AFont : out CString from Standard;
AnExpansionFactor : out Real from Standard;
ASpace : out Real from Standard;
AStyle : out TypeOfStyleText from Aspect;
ADisplayType : out TypeOfDisplayText from Aspect;
AColorSubTitle : out Color from Quantity;
ATextZoomable : out Boolean from Standard;
ATextAngle : out Real from Standard)
is static;
---Level: Public
---Purpose: Returns the current values of the group <me>.
---Category: Inquire methods
Values ( me;
AColor : out Color from Quantity;
AFont : out CString from Standard;
AnExpansionFactor : out Real from Standard;
ASpace : out Real from Standard;
AStyle : out TypeOfStyleText from Aspect;
ADisplayType : out TypeOfDisplayText from Aspect;
AColorSubTitle : out Color from Quantity;
ATextZoomable : out Boolean from Standard;
ATextAngle : out Real from Standard;
ATextFontAspect : out FontAspect from OSD)
is static;
---Level: Public
---Purpose: Returns the current values of the group <me>.
---Category: Inquire methods
--
fields
--
-- Class : Graphic3d_AspectText3d
--
-- Purpose : Declaration of variables specific to a context for
-- writing 3d text
--
-- Reminder : A text writing context is defined by:
-- - the font
-- - the colour
-- - the scale
-- - the space between characters
--
-- the font utilised
MyFont : AsciiString from TCollection;
-- the colour
MyColor : Color from Quantity;
-- the scale
MyFactor : Real from Standard;
-- the space between characters
MySpace : Real from Standard;
-- the style of the text
MyStyle : TypeOfStyleText from Aspect;
-- the display type of the text
MyDisplayType : TypeOfDisplayText from Aspect;
-- the colour of the sub-title and background for the dekale.
MyColorSubTitle : Color from Quantity;
-- the flag turning text zoomable on/off
MyTextZoomable : Boolean from Standard;
-- the variable turning angle of the text
MyTextAngle : Real from Standard;
-- the variable turning FontAspect of the text
MyTextFontAspect : FontAspect from OSD;
end AspectText3d;
|
