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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>rings</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-marks.html" title="marks">
<link rel="next" href="ch06.html" title="Extra functionalities">
<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-marks.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="ch06.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-rings.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-rings.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="rings">
<a name="v-sim-rings"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-rings.top_of_page"></a>rings</span></h2>
<p>rings — an extension to highlight closed rings in a structure.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-rings.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="v-sim-rings.html#EXT-RINGS-ID:CAPS" title="EXT_RINGS_ID">EXT_RINGS_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-rings.html#initExtRings" title="initExtRings ()">initExtRings</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-rings.html#extRingsSet-isOn" title="extRingsSet_isOn ()">extRingsSet_isOn</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-rings.html#extRingsGet-isOn" title="extRingsGet_isOn ()">extRingsGet_isOn</a> ();
<span class="returnvalue">void</span> <a class="link" href="v-sim-rings.html#extRingsDraw" title="extRingsDraw ()">extRingsDraw</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-rings.description"></a><h2>Description</h2>
<p>
</p>
<p>TODO</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-rings.details"></a><h2>Details</h2>
<div class="refsect2" title="EXT_RINGS_ID">
<a name="EXT-RINGS-ID:CAPS"></a><h3>EXT_RINGS_ID</h3>
<pre class="programlisting">#define EXT_RINGS_ID "Rings"
</pre>
<p>
The id of the ring extension.
</p>
</div>
<hr>
<div class="refsect2" title="initExtRings ()">
<a name="initExtRings"></a><h3>initExtRings ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-visu-extension.html#VisuExtension" title="VisuExtension"><span class="returnvalue">VisuExtension</span></a>* initExtRings ();</pre>
</div>
<hr>
<div class="refsect2" title="extRingsSet_isOn ()">
<a name="extRingsSet-isOn"></a><h3>extRingsSet_isOn ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> extRingsSet_isOn (<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 if rings are drawn or not.
</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 is status is changed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="extRingsGet_isOn ()">
<a name="extRingsGet-isOn"></a><h3>extRingsGet_isOn ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> extRingsGet_isOn ();</pre>
<p>
Retrieves if the ring extension is used.
</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 ring extension is used.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="extRingsDraw ()">
<a name="extRingsDraw"></a><h3>extRingsDraw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> extRingsDraw (<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 rings (if any).
</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>
|
