File: v-sim-isoline.html

package info (click to toggle)
v-sim 3.6.0-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 15,860 kB
  • sloc: ansic: 75,222; sh: 10,239; makefile: 580; python: 572; cpp: 353; xml: 130
file content (219 lines) | stat: -rw-r--r-- 11,972 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>isoline</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="ch06.html" title="Extra functionalities">
<link rel="prev" href="v-sim-scalarFields.html" title="scalarFields">
<link rel="next" href="v-sim-surfaces.html" title="surfaces">
<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-scalarFields.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.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-surfaces.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-isoline.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-isoline.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="isoline">
<a name="v-sim-isoline"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-isoline.top_of_page"></a>isoline</span></h2>
<p>isoline — handle the drawing and the computation of
isolines.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-isoline.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">                    <a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine">VisuLine</a>;
<span class="returnvalue">void</span>                <a class="link" href="v-sim-isoline.html#visu-line-draw" title="visu_line_draw ()">visu_line_draw</a>                      (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>,
                                                         <em class="parameter"><code><span class="type">float</span> rgb[3]</code></em>);
<span class="returnvalue">float</span>*              <a class="link" href="v-sim-isoline.html#visu-line-project" title="visu_line_project ()">visu_line_project</a>                   (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>,
                                                         <em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *nSeg</code></em>);
<a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="returnvalue">VisuLine</span></a>*           <a class="link" href="v-sim-isoline.html#visu-line-newFromTriangles" title="visu_line_newFromTriangles ()">visu_line_newFromTriangles</a>          (<em class="parameter"><code><span class="type">float</span> **data</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nTriangles</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> isoValue</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-isoline.html#visu-line-free" title="visu_line_free ()">visu_line_free</a>                      (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>);
<span class="returnvalue">double</span>              <a class="link" href="v-sim-isoline.html#visu-line-getValue" title="visu_line_getValue ()">visu_line_getValue</a>                  (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-isoline.description"></a><h2>Description</h2>
<p>
</p>
<p>TODO</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-isoline.details"></a><h2>Details</h2>
<div class="refsect2" title="VisuLine">
<a name="VisuLine"></a><h3>VisuLine</h3>
<pre class="programlisting">typedef struct _VisuLine VisuLine;</pre>
<p>
Structure representing a curved line in 3D, opaque structure.
</p>
</div>
<hr>
<div class="refsect2" title="visu_line_draw ()">
<a name="visu-line-draw"></a><h3>visu_line_draw ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                visu_line_draw                      (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>,
                                                         <em class="parameter"><code><span class="type">float</span> rgb[3]</code></em>);</pre>
<p>
Call the OpenGL routine that will draw this line.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
<td>a set of points forming a line.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rgb</code></em> :</span></p></td>
<td>a colour.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_line_project ()">
<a name="visu-line-project"></a><h3>visu_line_project ()</h3>
<pre class="programlisting"><span class="returnvalue">float</span>*              visu_line_project                   (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>,
                                                         <em class="parameter"><code><a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> *plane</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> *nSeg</code></em>);</pre>
<p>
Calculate the projection of each <em class="parameter"><code>line</code></em> vertex on <em class="parameter"><code>plane</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>line</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>plane</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-plane.html#Plane"><span class="type">Plane</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nSeg</code></em> :</span></p></td>
<td>a location to store the size of projection.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated array of line segments. The size of this
array is 4 * <em class="parameter"><code>nSeg</code></em>, holding the two plane coordiantes of the two
vertices of a line.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_line_newFromTriangles ()">
<a name="visu-line-newFromTriangles"></a><h3>visu_line_newFromTriangles ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="returnvalue">VisuLine</span></a>*           visu_line_newFromTriangles          (<em class="parameter"><code><span class="type">float</span> **data</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nTriangles</code></em>,
                                                         <em class="parameter"><code><span class="type">double</span> isoValue</code></em>);</pre>
<p>
Create on the fly an isoline from a given set of triangles. If the
lines are created, <em class="parameter"><code>isoline</code></em> will be allocated and should be freed
with <a class="link" href="v-sim-isoline.html#visu-line-free" title="visu_line_free ()"><code class="function">visu_line_free()</code></a> after use.
</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>the lines to be computed ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nTriangles</code></em> :</span></p></td>
<td>the surface to compute isoline from ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>isoValue</code></em> :</span></p></td>
<td>the value of the computed isoline.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly allocated <a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> or NULL.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="visu_line_free ()">
<a name="visu-line-free"></a><h3>visu_line_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                visu_line_free                      (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>);</pre>
<p>
Free the line object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
<td>a set of lines.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="visu_line_getValue ()">
<a name="visu-line-getValue"></a><h3>visu_line_getValue ()</h3>
<pre class="programlisting"><span class="returnvalue">double</span>              visu_line_getValue                  (<em class="parameter"><code><a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> *line</code></em>);</pre>
<p>
Lines are usually created as iso-values line in a mesh.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>line</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-isoline.html#VisuLine" title="VisuLine"><span class="type">VisuLine</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the value associated to the line.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>