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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>extInfos</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="v-sim-axes.html" title="axes">
<link rel="next" href="v-sim-scale.html" title="scale">
<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="v-sim-axes.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-scale.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-extInfos.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-extInfos.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="extInfos">
<a name="v-sim-extInfos"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-extInfos.top_of_page"></a>extInfos</span></h2>
<p>extInfos — give the capability to draw some information
near each node.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-extInfos.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-extInfos.html#initExtInfos" title="initExtInfos ()">initExtInfos</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
enum <a class="link" href="v-sim-extInfos.html#VisuGlExtInfosDrawId" title="enum VisuGlExtInfosDrawId">VisuGlExtInfosDrawId</a>;
enum <a class="link" href="v-sim-extInfos.html#VisuGlExtInfosDrawMethod" title="enum VisuGlExtInfosDrawMethod">VisuGlExtInfosDrawMethod</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-extInfos.html#visu-glExt-infos-setOn" title="visu_glExt_infos_setOn ()">visu_glExt_infos_setOn</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> status</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawIds" title="visu_glExt_infos_drawIds ()">visu_glExt_infos_drawIds</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawElements" title="visu_glExt_infos_drawElements ()">visu_glExt_infos_drawElements</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawData" title="visu_glExt_infos_drawData ()">visu_glExt_infos_drawData</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-dataNode.html#VisuDataNode"><span class="type">VisuDataNode</span></a> *dataNode</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-build" title="visu_glExt_infos_build ()">visu_glExt_infos_build</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-extInfos.description"></a><h2>Description</h2>
<p>
</p>
<p>This part is used to draw some information near the
nodes. This information can be the one of a <a class="link" href="v-sim-visu-nodes.html#VisuNodeProperty" title="VisuNodeProperty"><span class="type">VisuNodeProperty</span></a> or
something else. When read from a <a class="link" href="v-sim-visu-nodes.html#VisuNodeProperty" title="VisuNodeProperty"><span class="type">VisuNodeProperty</span></a>, just giving the
name will produce the right output. In other cases a print routine
must be given.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-extInfos.details"></a><h2>Details</h2>
<div class="refsect2" title="initExtInfos ()">
<a name="initExtInfos"></a><h3>initExtInfos ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="returnvalue">VisuExtension</span></a>* initExtInfos (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create the extension, it is called by V_Sim on startup and should not
used elsewhere.
</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 newly created <a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="type">VisuExtension</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum VisuGlExtInfosDrawId">
<a name="VisuGlExtInfosDrawId"></a><h3>enum VisuGlExtInfosDrawId</h3>
<pre class="programlisting">typedef enum
{
DRAW_NEVER,
DRAW_SELECTED,
DRAW_ALWAYS
} VisuGlExtInfosDrawId;
</pre>
<p>
This enum represents the possibilities for the information drawing.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="DRAW-NEVER:CAPS"></a><span class="term"><code class="literal">DRAW_NEVER</code></span></p></td>
<td>don't draw any information on nodes ;
</td>
</tr>
<tr>
<td><p><a name="DRAW-SELECTED:CAPS"></a><span class="term"><code class="literal">DRAW_SELECTED</code></span></p></td>
<td>draw information only on a list of nodes ;
</td>
</tr>
<tr>
<td><p><a name="DRAW-ALWAYS:CAPS"></a><span class="term"><code class="literal">DRAW_ALWAYS</code></span></p></td>
<td>draw information on all nodes.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum VisuGlExtInfosDrawMethod">
<a name="VisuGlExtInfosDrawMethod"></a><h3>enum VisuGlExtInfosDrawMethod</h3>
<pre class="programlisting">typedef enum
{
EXT_DRAW_METH_NONE,
EXT_DRAW_METH_ID,
EXT_DRAW_METH_TYPE,
EXT_DRAW_METH_OTHER
} VisuGlExtInfosDrawMethod;
</pre>
<p>
This enum represents the method for information drawing.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="EXT-DRAW-METH-NONE:CAPS"></a><span class="term"><code class="literal">EXT_DRAW_METH_NONE</code></span></p></td>
<td>draw nothing ;
</td>
</tr>
<tr>
<td><p><a name="EXT-DRAW-METH-ID:CAPS"></a><span class="term"><code class="literal">EXT_DRAW_METH_ID</code></span></p></td>
<td>draw the id of nodes ;
</td>
</tr>
<tr>
<td><p><a name="EXT-DRAW-METH-TYPE:CAPS"></a><span class="term"><code class="literal">EXT_DRAW_METH_TYPE</code></span></p></td>
<td>draw the name of node element ;
</td>
</tr>
<tr>
<td><p><a name="EXT-DRAW-METH-OTHER:CAPS"></a><span class="term"><code class="literal">EXT_DRAW_METH_OTHER</code></span></p></td>
<td>other possible draw rendering method.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_infos_setOn ()">
<a name="visu-glExt-infos-setOn"></a><h3>visu_glExt_infos_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_infos_setOn (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> status</code></em>);</pre>
<p>
Change the status of the informations extension.
</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>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</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 the calling routine should call <a class="link" href="VisuObject.html#visu-object-redraw" title="visu_object_redraw ()"><code class="function">visu_object_redraw()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_infos_drawIds ()">
<a name="visu-glExt-infos-drawIds"></a><h3>visu_glExt_infos_drawIds ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_glExt_infos_drawIds (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>);</pre>
<p>
Associate a informations extension to the given <em class="parameter"><code>data</code></em>. With this extension,
some the number of nodes will be drawn on them. Numbers can be drawn and
all nodes (set <em class="parameter"><code>nodes</code></em> to a NULL pointer), or to a restricted list of nodes
represented by their numbers. In this case, <em class="parameter"><code>nodes</code></em> can have whatever length
but must be terminated by a negative integer. This array is then owned by the
extension and should not be freed.
</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>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>an integer list, terminated with a negative number.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_infos_drawElements ()">
<a name="visu-glExt-infos-drawElements"></a><h3>visu_glExt_infos_drawElements ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_glExt_infos_drawElements (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>);</pre>
<p>
As <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawIds" title="visu_glExt_infos_drawIds ()"><code class="function">visu_glExt_infos_drawIds()</code></a>, but draw the names of elements instead of their
numbers.
</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>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>an integer list, terminated with a negative number.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_infos_drawData ()">
<a name="visu-glExt-infos-drawData"></a><h3>visu_glExt_infos_drawData ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_glExt_infos_drawData (<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-dataNode.html#VisuDataNode"><span class="type">VisuDataNode</span></a> *dataNode</code></em>,
<em class="parameter"><code><span class="type">int</span> *nodes</code></em>);</pre>
<p>
As <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawIds" title="visu_glExt_infos_drawIds ()"><code class="function">visu_glExt_infos_drawIds()</code></a>, but draw some informations instead of their
numbers. The informations are defined by the <em class="parameter"><code>dataNode</code></em> argument.
</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>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataNode</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-dataNode.html#VisuDataNode"><span class="type">VisuDataNode</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nodes</code></em> :</span></p></td>
<td>an integer list, terminated with a negative number ;
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_glExt_infos_build ()">
<a name="visu-glExt-infos-build"></a><h3>visu_glExt_infos_build ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_glExt_infos_build (<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>
Build the OpenGL list representing the informations associated to the given
<em class="parameter"><code>dataObj</code></em>. To associate some, use <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawIds" title="visu_glExt_infos_drawIds ()"><code class="function">visu_glExt_infos_drawIds()</code></a>, or <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawElements" title="visu_glExt_infos_drawElements ()"><code class="function">visu_glExt_infos_drawElements()</code></a>
or <a class="link" href="v-sim-extInfos.html#visu-glExt-infos-drawData" title="visu_glExt_infos_drawData ()"><code class="function">visu_glExt_infos_drawData()</code></a>.
</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>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
