File: v-sim-panelMap.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 (193 lines) | stat: -rw-r--r-- 11,027 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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>panelMap</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="ch11.html" title="Panel add-ons">
<link rel="prev" href="v-sim-panelDataFile.html" title="panelDataFile">
<link rel="next" href="v-sim-panelFogBgColor.html" title="panelFogBgColor">
<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-panelDataFile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch11.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-panelFogBgColor.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-panelMap.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#v-sim-panelMap.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="panelMap">
<a name="v-sim-panelMap"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-panelMap.top_of_page"></a>panelMap</span></h2>
<p>panelMap — The widget to create coloured map.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-panelMap.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="returnvalue">ToolPanel</span></a>*          <a class="link" href="v-sim-panelMap.html#panelMapInit" title="panelMapInit ()">panelMapInit</a>                        ();
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelMap.html#panelMapSet" title="panelMapSet ()">panelMapSet</a>                         (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> planeId</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> scalarFieldId</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> shadeId</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelMap.html#panelMapSet-scale" title="panelMapSet_scale ()">panelMapSet_scale</a>                   (<em class="parameter"><code><a class="link" href="v-sim-toolMatrix.html#ToolMatrixScalingFlag" title="enum ToolMatrixScalingFlag"><span class="type">ToolMatrixScalingFlag</span></a> scale</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelMap.html#panelMapSet-nIsoLines" title="panelMapSet_nIsoLines ()">panelMapSet_nIsoLines</a>               (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nIsoLines</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelMap.html#panelMapSet-isoLinesColor" title="panelMapSet_isoLinesColor ()">panelMapSet_isoLinesColor</a>           (<em class="parameter"><code><span class="type">float</span> *color</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelMap.html#panelMapSet-precision" title="panelMapSet_precision ()">panelMapSet_precision</a>               (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> prec</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="v-sim-panelMap.html#panelMapSet-inputMinMax" title="panelMapSet_inputMinMax ()">panelMapSet_inputMinMax</a>             (<em class="parameter"><code><span class="type">float</span> *minMax</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-panelMap.description"></a><h2>Description</h2>
<p>
</p>
<p>This is the user interface for the coloured maps. For a
plane, a scalar field and a shade, it is possible to draw one
coloured plane. The available planes are taken from the <span class="type">panelPlane</span>
subpanel and the scalar field for the <span class="type">panelSurfaces</span>.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-panelMap.details"></a><h2>Details</h2>
<div class="refsect2" title="panelMapInit ()">
<a name="panelMapInit"></a><h3>panelMapInit ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-gtk-toolPanelWidget.html#ToolPanel"><span class="returnvalue">ToolPanel</span></a>*          panelMapInit                        ();</pre>
</div>
<hr>
<div class="refsect2" title="panelMapSet ()">
<a name="panelMapSet"></a><h3>panelMapSet ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelMapSet                         (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> planeId</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> scalarFieldId</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> shadeId</code></em>);</pre>
<p>
Change the values of the three combobox of this panel.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>planeId</code></em> :</span></p></td>
<td>a entry for the plane combobox ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scalarFieldId</code></em> :</span></p></td>
<td>a entry for the scalar field combobox ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>shadeId</code></em> :</span></p></td>
<td>a entry for the shade combobox.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="panelMapSet_scale ()">
<a name="panelMapSet-scale"></a><h3>panelMapSet_scale ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelMapSet_scale                   (<em class="parameter"><code><a class="link" href="v-sim-toolMatrix.html#ToolMatrixScalingFlag" title="enum ToolMatrixScalingFlag"><span class="type">ToolMatrixScalingFlag</span></a> scale</code></em>);</pre>
<p>
Set the scaling method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>scale</code></em> :</span></p></td>
<td>the status.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="panelMapSet_nIsoLines ()">
<a name="panelMapSet-nIsoLines"></a><h3>panelMapSet_nIsoLines ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelMapSet_nIsoLines               (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> nIsoLines</code></em>);</pre>
<p>
Change the number of drawn isolines.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>nIsoLines</code></em> :</span></p></td>
<td>a value.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.4</p>
</div>
<hr>
<div class="refsect2" title="panelMapSet_isoLinesColor ()">
<a name="panelMapSet-isoLinesColor"></a><h3>panelMapSet_isoLinesColor ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelMapSet_isoLinesColor           (<em class="parameter"><code><span class="type">float</span> *color</code></em>);</pre>
<p>
Change the colour of drawn isolines. If <em class="parameter"><code>color</code></em> is NULL, then the
specific colour is unchecked and inversed colours are used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>an RGB value (can be NULL).
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.5</p>
</div>
<hr>
<div class="refsect2" title="panelMapSet_precision ()">
<a name="panelMapSet-precision"></a><h3>panelMapSet_precision ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelMapSet_precision               (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> prec</code></em>);</pre>
<p>
Set the precision used to render the maps. At 200, there is no
adaptive mesh.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>prec</code></em> :</span></p></td>
<td>a pourcentage.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2" title="panelMapSet_inputMinMax ()">
<a name="panelMapSet-inputMinMax"></a><h3>panelMapSet_inputMinMax ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                panelMapSet_inputMinMax             (<em class="parameter"><code><span class="type">float</span> *minMax</code></em>);</pre>
<p>
Set-up the  minimum and maximum scaling values. In case <em class="parameter"><code>minMax</code></em> is
NULL, then the automatic normalisation is chosen.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>minMax</code></em> :</span></p></td>
<td>two floats containing min and max values. Can be NULL.
</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>