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
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>box</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="ch05.html" title="OpenGL specific extensions">
<link rel="prev" href="ch05.html" title="OpenGL specific extensions">
<link rel="next" href="v-sim-axes.html" title="axes">
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch05.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-axes.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-box.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-box.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="box">
<a name="v-sim-box"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-box.top_of_page"></a>box</span></h2>
<p>box — Draw a bounding box around nodes.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-box.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="returnvalue">VisuExtension</span></a>* <a class="link" href="v-sim-box.html#initExtensionBox" title="initExtensionBox ()">initExtensionBox</a> ();
#define <a class="link" href="v-sim-box.html#VISU-GLEXT-BOX-ID:CAPS" title="VISU_GLEXT_BOX_ID">VISU_GLEXT_BOX_ID</a>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-setRGBValues" title="visu_glExt_box_setRGBValues ()">visu_glExt_box_setRGBValues</a> (<em class="parameter"><code><span class="type">float</span> rgb[3]</code></em>,
<em class="parameter"><code><span class="type">int</span> mask</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-setLineWidth" title="visu_glExt_box_setLineWidth ()">visu_glExt_box_setLineWidth</a> (<em class="parameter"><code><span class="type">float</span> width</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-setOn" title="visu_glExt_box_setOn ()">visu_glExt_box_setOn</a> (<em class="parameter"><code><span class="type">int</span> value</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-setLineStipple" title="visu_glExt_box_setLineStipple ()">visu_glExt_box_setLineStipple</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> stipple</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-setExpandStipple" title="visu_glExt_box_setExpandStipple ()">visu_glExt_box_setExpandStipple</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> stipple</code></em>);
<span class="returnvalue">float</span>* <a class="link" href="v-sim-box.html#visu-glExt-box-getRGBValues" title="visu_glExt_box_getRGBValues ()">visu_glExt_box_getRGBValues</a> ();
<span class="returnvalue">int</span> <a class="link" href="v-sim-box.html#visu-glExt-box-getOn" title="visu_glExt_box_getOn ()">visu_glExt_box_getOn</a> ();
<span class="returnvalue">float</span> <a class="link" href="v-sim-box.html#visu-glExt-box-getLineWidth" title="visu_glExt_box_getLineWidth ()">visu_glExt_box_getLineWidth</a> ();
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-getLineStipple" title="visu_glExt_box_getLineStipple ()">visu_glExt_box_getLineStipple</a> ();
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-getExpandStipple" title="visu_glExt_box_getExpandStipple ()">visu_glExt_box_getExpandStipple</a> ();
<span class="returnvalue">void</span> <a class="link" href="v-sim-box.html#visu-glExt-box-draw" title="visu_glExt_box_draw ()">visu_glExt_box_draw</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-box.html#visu-glExt-box-draw-legend" title="visu_glExt_box_draw_legend ()">visu_glExt_box_draw_legend</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-getShowLegend" title="visu_glExt_box_getShowLegend ()">visu_glExt_box_getShowLegend</a> ();
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-box.html#visu-glExt-box-setShowLegend" title="visu_glExt_box_setShowLegend ()">visu_glExt_box_setShowLegend</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-box.description"></a><h2>Description</h2>
<p>
</p>
<p>This extension allows V_Sim to draw a box around the
nodes. The box is defined in the <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> structure and can be
retrieved with <a class="link" href="v-sim-visu-data.html#visu-data-getBoxGeometry" title="visu_data_getBoxGeometry ()"><code class="function">visu_data_getBoxGeometry()</code></a>. This box is not necessary
orthogonal.</p>
<p>
</p>
<p>It has several properties, namely, its colour, its line width
and its line pattern. It is represented in OpenGL with simple lines
and is affected by the antialiasing property. Defined resources:</p>
<p>
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem"><p><span class="emphasis"><em>box_is_on</em></span> (boolean): controls if a box
is drawn around the rendering area (since 3.0).</p></li>
<li class="listitem"><p><span class="emphasis"><em>box_color</em></span> (RGB in [0;1]): defines the
color of the box(since 3.0).</p></li>
<li class="listitem"><p><span class="emphasis"><em>box_line_width</em></span> (integer in [1;10]):
defines the width of the lines of the box (since 3.0).</p></li>
<li class="listitem"><p><span class="emphasis"><em>box_line_stipple</em></span> (2 integers in
]0;65535]): dot scheme detail for the lines of the box. The first
value is the pattern for the line of the main box and the second
is the pattern for the lines of the expanded areas (since 3.4).</p></li>
</ul></div>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-box.details"></a><h2>Details</h2>
<div class="refsect2" title="initExtensionBox ()">
<a name="initExtensionBox"></a><h3>initExtensionBox ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="returnvalue">VisuExtension</span></a>* initExtensionBox ();</pre>
<p>
It initialises all variables of the OpenGL extension.
It creates all resources and parameters introduced by
this extension.
This method should be added in the <code class="literal">listInitExtensionFunc</code> to
be called automatically by the <a class="link" href="v-sim-visu-extension.html#initVisuExtensions" title="initVisuExtensions ()"><code class="function">initVisuExtensions()</code></a> at V_Sim
startup.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to the VisuExtension it created or
NULL otherwise.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="VISU_GLEXT_BOX_ID">
<a name="VISU-GLEXT-BOX-ID:CAPS"></a><h3>VISU_GLEXT_BOX_ID</h3>
<pre class="programlisting">#define VISU_GLEXT_BOX_ID "Box"
</pre>
<p>
The id used to identify this extension, see
<a class="link" href="v-sim-visu-extension.html#visuExtensions-rebuildList" title="visuExtensions_rebuildList ()"><code class="function">visuExtensions_rebuildList()</code></a> for instance.
</p>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_setRGBValues ()">
<a name="visu-glExt-box-setRGBValues"></a><h3>visu_glExt_box_setRGBValues ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_glExt_box_setRGBValues (<em class="parameter"><code><span class="type">float</span> rgb[3]</code></em>,
<em class="parameter"><code><span class="type">int</span> mask</code></em>);</pre>
<p>
Method used to change the value of the parameter box_color.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>rgb</code></em> :</span></p></td>
<td>a three floats array with values (0 <= values <= 1) for the
red, the green and the blue color. Only values specified by the mask
are really relevant.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
<td>use <a class="link" href="v-sim-toolColor.html#TOOL-COLOR-MASK-R:CAPS" title="TOOL_COLOR_MASK_R"><span class="type">TOOL_COLOR_MASK_R</span></a>, <a class="link" href="v-sim-toolColor.html#TOOL-COLOR-MASK-G:CAPS" title="TOOL_COLOR_MASK_G"><span class="type">TOOL_COLOR_MASK_G</span></a>, <a class="link" href="v-sim-toolColor.html#TOOL-COLOR-MASK-B:CAPS" title="TOOL_COLOR_MASK_B"><span class="type">TOOL_COLOR_MASK_B</span></a>, <a class="link" href="v-sim-toolColor.html#TOOL-COLOR-MASK-RGBA:CAPS" title="TOOL_COLOR_MASK_RGBA"><span class="type">TOOL_COLOR_MASK_RGBA</span></a> or a
combinaison to indicate what values in the rgb array must be taken
into account.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if <a class="link" href="v-sim-box.html#visu-glExt-box-draw" title="visu_glExt_box_draw ()"><code class="function">visu_glExt_box_draw()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_setLineWidth ()">
<a name="visu-glExt-box-setLineWidth"></a><h3>visu_glExt_box_setLineWidth ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_glExt_box_setLineWidth (<em class="parameter"><code><span class="type">float</span> width</code></em>);</pre>
<p>
Method used to change the value of the parameter box_line_width.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
<td>value of the desired box line width.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if <a class="link" href="v-sim-box.html#visu-glExt-box-draw" title="visu_glExt_box_draw ()"><code class="function">visu_glExt_box_draw()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_setOn ()">
<a name="visu-glExt-box-setOn"></a><h3>visu_glExt_box_setOn ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_glExt_box_setOn (<em class="parameter"><code><span class="type">int</span> value</code></em>);</pre>
<p>
Method used to change the value of the parameter box_is_on.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>1 if box must be drawn, 0 otherwise.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if <a class="link" href="v-sim-box.html#visu-glExt-box-draw" title="visu_glExt_box_draw ()"><code class="function">visu_glExt_box_draw()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_setLineStipple ()">
<a name="visu-glExt-box-setLineStipple"></a><h3>visu_glExt_box_setLineStipple ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_glExt_box_setLineStipple (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> stipple</code></em>);</pre>
<p>
Method used to change the value of the parameter box_line_stipple
(main part).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stipple</code></em> :</span></p></td>
<td>a pattern for line stipple in OpenGL.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if <a class="link" href="v-sim-box.html#visu-glExt-box-draw" title="visu_glExt_box_draw ()"><code class="function">visu_glExt_box_draw()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_setExpandStipple ()">
<a name="visu-glExt-box-setExpandStipple"></a><h3>visu_glExt_box_setExpandStipple ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_glExt_box_setExpandStipple (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="type">guint16</span></a> stipple</code></em>);</pre>
<p>
Method used to change the value of the parameter box_line_stipple
(expanded part).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stipple</code></em> :</span></p></td>
<td>a pattern for line stipple in OpenGL.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if <a class="link" href="v-sim-box.html#visu-glExt-box-draw" title="visu_glExt_box_draw ()"><code class="function">visu_glExt_box_draw()</code></a> should be called.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_getRGBValues ()">
<a name="visu-glExt-box-getRGBValues"></a><h3>visu_glExt_box_getRGBValues ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>* visu_glExt_box_getRGBValues ();</pre>
<p>
Read the colour components of box (in [0;1]).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> all the colour values of the current box line.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_getOn ()">
<a name="visu-glExt-box-getOn"></a><h3>visu_glExt_box_getOn ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span> visu_glExt_box_getOn ();</pre>
<p>
Read if the box is drawn or not.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> 1 if a box is drawn, 0 otherwise.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_getLineWidth ()">
<a name="visu-glExt-box-getLineWidth"></a><h3>visu_glExt_box_getLineWidth ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span> visu_glExt_box_getLineWidth ();</pre>
<p>
Read the line width used for box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of current box line width.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_getLineStipple ()">
<a name="visu-glExt-box-getLineStipple"></a><h3>visu_glExt_box_getLineStipple ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> visu_glExt_box_getLineStipple ();</pre>
<p>
Read the line stipple pattern used for box (main part).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of current box line pattern.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_getExpandStipple ()">
<a name="visu-glExt-box-getExpandStipple"></a><h3>visu_glExt_box_getExpandStipple ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint16"><span class="returnvalue">guint16</span></a> visu_glExt_box_getExpandStipple ();</pre>
<p>
Read the line stipple pattern used for box (expanded part).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value of current box line pattern.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_draw ()">
<a name="visu-glExt-box-draw"></a><h3>visu_glExt_box_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_glExt_box_draw (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>);</pre>
<p>
This method create a compile list that draw a box for the given <em class="parameter"><code>data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_draw_legend ()">
<a name="visu-glExt-box-draw-legend"></a><h3>visu_glExt_box_draw_legend ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_glExt_box_draw_legend (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>);</pre>
<p>
Draw a legend giving the different box lengths.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>the <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> defining the box.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_getShowLegend ()">
<a name="visu-glExt-box-getShowLegend"></a><h3>visu_glExt_box_getShowLegend ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_glExt_box_getShowLegend ();</pre>
<p>
The box extension can draw a frame showing the lengths of the box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the frame is displayed.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_glExt_box_setShowLegend ()">
<a name="visu-glExt-box-setShowLegend"></a><h3>visu_glExt_box_setShowLegend ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_glExt_box_setShowLegend (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> value</code></em>);</pre>
<p>
Draw or not the lengths near the axis.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a boolean.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if status changed.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
