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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>legend</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-fogAndBGColor.html" title="fogAndBGColor">
<link rel="next" href="v-sim-marks.html" title="marks">
<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-fogAndBGColor.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-marks.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-legend.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-legend.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="legend">
<a name="v-sim-legend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-legend.top_of_page"></a>legend</span></h2>
<p>legend — Draw a frame with the representation of each
atom species, its name and the number of elements.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-legend.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="v-sim-legend.html#VISU-GLEXT-LEGEND-ID:CAPS" title="VISU_GLEXT_LEGEND_ID">VISU_GLEXT_LEGEND_ID</a>
<a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="returnvalue">VisuExtension</span></a>* <a class="link" href="v-sim-legend.html#initExtLegend" title="initExtLegend ()">initExtLegend</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-legend.html#visu-glExt-legend-setOn" title="visu_glExt_legend_setOn ()">visu_glExt_legend_setOn</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>);
<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-legend.html#visu-glExt-legend-getOn" title="visu_glExt_legend_getOn ()">visu_glExt_legend_getOn</a> ();
<span class="returnvalue">void</span> <a class="link" href="v-sim-legend.html#visu-glExt-legend-draw" title="visu_glExt_legend_draw ()">visu_glExt_legend_draw</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-legend.description"></a><h2>Description</h2>
<p>
</p>
<p>This extension draws a frame on top of the rendering area with an
item per <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a> currently rendered. For each <a class="link" href="v-sim-visu-elements.html#VisuElement"><span class="type">VisuElement</span></a>, a
small representation of its OpenGL shape is drawn, its label is
printed and the number of <a class="link" href="v-sim-visu-nodes.html#VisuNode" title="VisuNode"><span class="type">VisuNode</span></a> associated to this
element.</p>
<p>
</p>
<p>This extension defines one resource entry labeled
"legend_is_on" to control if the legend is printed or not.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-legend.details"></a><h2>Details</h2>
<div class="refsect2" title="VISU_GLEXT_LEGEND_ID">
<a name="VISU-GLEXT-LEGEND-ID:CAPS"></a><h3>VISU_GLEXT_LEGEND_ID</h3>
<pre class="programlisting">#define VISU_GLEXT_LEGEND_ID "Legend"
</pre>
<p>
The id of the legend extension.
</p>
</div>
<hr>
<div class="refsect2" title="initExtLegend ()">
<a name="initExtLegend"></a><h3>initExtLegend ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="returnvalue">VisuExtension</span></a>* initExtLegend ();</pre>
<p>
Internal use only.
</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 legend extension.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="visu_glExt_legend_setOn ()">
<a name="visu-glExt-legend-setOn"></a><h3>visu_glExt_legend_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_legend_setOn (<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>
Set or not the status of the legend extension.
</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 the status is changed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="visu_glExt_legend_getOn ()">
<a name="visu-glExt-legend-getOn"></a><h3>visu_glExt_legend_getOn ()</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_legend_getOn ();</pre>
<p>
Legend extension draw a frame with the name and the number of
elements of the current rendered data.
</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 legend is used.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="visu_glExt_legend_draw ()">
<a name="visu-glExt-legend-draw"></a><h3>visu_glExt_legend_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_glExt_legend_draw (<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 the legend corresponding to the given <em class="parameter"><code>dataObj</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>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>
<p class="since">Since 3.5</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
