source: GTP/trunk/App/Demos/Illum/EnvMap/doxygen/class_parameters.html @ 1488

Revision 1488, 49.6 KB checked in by szirmay, 18 years ago (diff)
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>Indirect Environment Mapping: Parameters Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5</head><body>
6<!-- Generated by Doxygen 1.4.2 -->
7<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a></div>
8<h1>Parameters Class Reference</h1>Manages application parameters. Creates GUI controls (sliders, checkboxes) and hotkeys. 
9<a href="#_details">More...</a>
10<p>
11<code>#include &lt;Parameters.h&gt;</code>
12<p>
13<a href="class_parameters-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
14<tr><td></td></tr>
15<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
16<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a0">Setup</a> (CDXUTDialog *<a class="el" href="class_parameters.html#r10">g_HUD</a>)</td></tr>
17
18<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">You can set the dialog that manages input and rendering for the GUI controls.  <a href="#a0"></a><br></td></tr>
19<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a1">Setup</a> (CDXUTDialog *<a class="el" href="class_parameters.html#r10">g_HUD</a>, <a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> OnReset, <a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> OnSave=OnChange, <a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> OnLoad=OnChange)</td></tr>
20
21<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">You can set the dialog that manages input and rendering for the GUI controls.  <a href="#a1"></a><br></td></tr>
22<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a2">Get</a> (<a class="el" href="_parameters_8h.html#a26">bool_t</a> i)</td></tr>
23
24<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns value of the specified boolean parameter, e.g. Get( <a class="el" href="_parameters_8h.html#a26a3">bShowHelp</a> ).  <a href="#a2"></a><br></td></tr>
25<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a3">Get</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> i)</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns float value of the specified numeric parameter, in range 0..1.  <a href="#a3"></a><br></td></tr>
28<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a4">GetInt</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> i)</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns integer value of the specified numeric parameter, in range 0...number-of-steps.  <a href="#a4"></a><br></td></tr>
31<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a5">SetBool</a> (<a class="el" href="_parameters_8h.html#a26">bool_t</a> ID, bool b)</td></tr>
32
33<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a6">SetFloat</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> ID, float v)</td></tr>
34
35<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a7">SetInt</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> ID, int v)</td></tr>
36
37<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a8">Add</a> (<a class="el" href="_parameters_8h.html#a26">bool_t</a> ID, char *label, char cHotKey=0, <a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> bchf=OnChange)</td></tr>
38
39<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a boolean parameter represented by a GUI <b>checkbox</b>. Specifies hotkey and callback function.  <a href="#a8"></a><br></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a9">Add</a> (int radiogroupID, <a class="el" href="_parameters_8h.html#a26">bool_t</a> ID, char *label, char cHotKey=0, <a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> bchf=OnChange)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a boolean parameter represented by a GUI <b>radio button</b>. Specifies hotkey and callback function.  <a href="#a9"></a><br></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a10">Add</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> ID, char *label, int num_steps)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a numeric parameter represented by a GUI <b>slider</b>.  <a href="#a10"></a><br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a11">Add</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> ID, char *label, int num_steps, <a class="el" href="_parameters_8h.html#a1">CONVERTER</a> ff, <a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> chf=OnChange)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a numeric parameter represented by a GUI <b>slider</b>. Specifies callback functions.  <a href="#a11"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a12">Add</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> ID, char *label, int num_steps, char cKeyDecr, char cKeyIncr=0, <a class="el" href="_parameters_8h.html#a1">CONVERTER</a> ff=noconvert, <a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> chf=OnChange)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a numeric parameter represented by a GUI <b>slider</b>. Specifies hotkeys and callback functions.  <a href="#a12"></a><br></td></tr>
52<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a13">SetEnabled</a> (<a class="el" href="_parameters_8h.html#a26">bool_t</a> ID, bool bEnabled)</td></tr>
53
54<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a14">SetEnabled</a> (<a class="el" href="_parameters_8h.html#a27">number_t</a> ID, bool bEnabled)</td></tr>
55
56<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a15">UpdateFromHUD</a> (int controlID)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the specified parameter from the GUI.  <a href="#a15"></a><br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a16">SaveToFile</a> (char *fileName)</td></tr>
60
61<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Writes all parameter values into the specified file.  <a href="#a16"></a><br></td></tr>
62<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#a17">LoadFromFile</a> (char *fileName)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads all parameter values from the specified file.  <a href="#a17"></a><br></td></tr>
65<tr><td colspan="2"><br><h2>Private Types</h2></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom">{ <br>
67&nbsp;&nbsp;<a class="el" href="class_parameters.html#y5y0">checkboxID0</a> =  1000,
68<a class="el" href="class_parameters.html#y5y1">sliderID0</a> =  2000,
69<a class="el" href="class_parameters.html#y5y2">staticID0</a> =  3000,
70<a class="el" href="class_parameters.html#y5y3">upID0</a> =  4000,
71<br>
72&nbsp;&nbsp;<a class="el" href="class_parameters.html#y5y4">downID0</a> =  5000
73<br>
74 }</td></tr>
75
76<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r0">bparam</a> [LAST_BOOL]</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">current param value (boolean)  <a href="#r0"></a><br></td></tr>
80<tr><td class="memItemLeft" nowrap align="right" valign="top">wchar_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r1">bname</a> [LAST_BOOL][CHARBUF]</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">param name  <a href="#r1"></a><br></td></tr>
83<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r2">radiogroup</a> [LAST_BOOL]</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">for boolean params that are represented by a checkbox  <a href="#r2"></a><br></td></tr>
86<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r3">param</a> [LAST_NUMBER]</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">current param value (numeric)  <a href="#r3"></a><br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top">wchar_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r4">name</a> [LAST_NUMBER][CHARBUF]</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">param name  <a href="#r4"></a><br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r5">numsteps</a> [LAST_NUMBER]</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">number of possible steps for param  <a href="#r5"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r6">rotate</a> [LAST_NUMBER]</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">stores whether the slider can rotate around  <a href="#r6"></a><br></td></tr>
98<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_parameters_8h.html#a1">CONVERTER</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r7">ffunc</a> [LAST_NUMBER]</td></tr>
99
100<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r8">chfunc</a> [LAST_NUMBER+3]</td></tr>
101
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r9">bchfunc</a> [LAST_BOOL]</td></tr>
103
104<tr><td class="memItemLeft" nowrap align="right" valign="top">CDXUTDialog *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r10">g_HUD</a></td></tr>
105
106<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#r11">bSilent</a></td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">to avoid an endless loop due to a change  <a href="#r11"></a><br></td></tr>
109<tr><td colspan="2"><br><h2>Static Private Attributes</h2></td></tr>
110<tr><td class="memItemLeft" nowrap align="right" valign="top">static const int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_parameters.html#v0">CHARBUFFER_SIZE</a> = 200</td></tr>
111
112</table>
113<hr><a name="_details"></a><h2>Detailed Description</h2>
114Manages application parameters. Creates GUI controls (sliders, checkboxes) and hotkeys.
115<p>
116<dl compact><dt><b>Author:</b></dt><dd>Istvan Lazanyi, TU Budapest </dd></dl>
117<dl compact><dt><b>Date:</b></dt><dd>2006-04-26 </dd></dl>
118
119<p>
120<hr><h2>Member Enumeration Documentation</h2>
121<a class="anchor" name="y5" doxytag="Parameters::@0"></a><p>
122<table class="mdTable" cellpadding="2" cellspacing="0">
123  <tr>
124    <td class="mdRow">
125      <table cellpadding="0" cellspacing="0" border="0">
126        <tr>
127          <td class="md" nowrap valign="top">anonymous enum<code> [private]</code>          </td>
128        </tr>
129      </table>
130    </td>
131  </tr>
132</table>
133<table cellspacing="5" cellpadding="0" border="0">
134  <tr>
135    <td>
136      &nbsp;
137    </td>
138    <td>
139
140<p>
141<dl compact><dt><b>Enumeration values: </b></dt><dd>
142<table border="0" cellspacing="2" cellpadding="0">
143<tr><td valign="top"><em><a class="anchor" name="y5y0" doxytag="checkboxID0"></a>checkboxID0</em>&nbsp;</td><td>
144</td></tr>
145<tr><td valign="top"><em><a class="anchor" name="y5y1" doxytag="sliderID0"></a>sliderID0</em>&nbsp;</td><td>
146</td></tr>
147<tr><td valign="top"><em><a class="anchor" name="y5y2" doxytag="staticID0"></a>staticID0</em>&nbsp;</td><td>
148</td></tr>
149<tr><td valign="top"><em><a class="anchor" name="y5y3" doxytag="upID0"></a>upID0</em>&nbsp;</td><td>
150</td></tr>
151<tr><td valign="top"><em><a class="anchor" name="y5y4" doxytag="downID0"></a>downID0</em>&nbsp;</td><td>
152</td></tr>
153</table>
154</dl>
155    </td>
156  </tr>
157</table>
158<hr><h2>Member Function Documentation</h2>
159<a class="anchor" name="a12" doxytag="Parameters::Add"></a><p>
160<table class="mdTable" cellpadding="2" cellspacing="0">
161  <tr>
162    <td class="mdRow">
163      <table cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td class="md" nowrap valign="top">void Parameters::Add           </td>
166          <td class="md" valign="top">(&nbsp;</td>
167          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
168          <td class="mdname" nowrap> <em>ID</em>, </td>
169        </tr>
170        <tr>
171          <td class="md" nowrap align="right"></td>
172          <td class="md"></td>
173          <td class="md" nowrap>char *&nbsp;</td>
174          <td class="mdname" nowrap> <em>label</em>, </td>
175        </tr>
176        <tr>
177          <td class="md" nowrap align="right"></td>
178          <td class="md"></td>
179          <td class="md" nowrap>int&nbsp;</td>
180          <td class="mdname" nowrap> <em>num_steps</em>, </td>
181        </tr>
182        <tr>
183          <td class="md" nowrap align="right"></td>
184          <td class="md"></td>
185          <td class="md" nowrap>char&nbsp;</td>
186          <td class="mdname" nowrap> <em>cKeyDecr</em>, </td>
187        </tr>
188        <tr>
189          <td class="md" nowrap align="right"></td>
190          <td class="md"></td>
191          <td class="md" nowrap>char&nbsp;</td>
192          <td class="mdname" nowrap> <em>cKeyIncr</em> = <code>0</code>, </td>
193        </tr>
194        <tr>
195          <td class="md" nowrap align="right"></td>
196          <td class="md"></td>
197          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a1">CONVERTER</a>&nbsp;</td>
198          <td class="mdname" nowrap> <em>ff</em> = <code>noconvert</code>, </td>
199        </tr>
200        <tr>
201          <td class="md" nowrap align="right"></td>
202          <td class="md"></td>
203          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td>
204          <td class="mdname" nowrap> <em>chf</em> = <code>OnChange</code></td>
205        </tr>
206        <tr>
207          <td class="md"></td>
208          <td class="md">)&nbsp;</td>
209          <td class="md" colspan="2"></td>
210        </tr>
211      </table>
212    </td>
213  </tr>
214</table>
215<table cellspacing="5" cellpadding="0" border="0">
216  <tr>
217    <td>
218      &nbsp;
219    </td>
220    <td>
221
222<p>
223Adds a numeric parameter represented by a GUI <b>slider</b>. Specifies hotkeys and callback functions.
224<p>
225<dl compact><dt><b>Parameters:</b></dt><dd>
226  <table border="0" cellspacing="2" cellpadding="0">
227    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>id of the given numeric parameter </td></tr>
228    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>label to be displayed for the slider </td></tr>
229    <tr><td valign="top"></td><td valign="top"><em>num_steps</em>&nbsp;</td><td>number of possible parameter values </td></tr>
230    <tr><td valign="top"></td><td valign="top"><em>cKeyDecr</em>&nbsp;</td><td>Hotkey to decrease parameter value. (Note: keys R, S, L are reserved.) </td></tr>
231    <tr><td valign="top"></td><td valign="top"><em>cKeyIncr</em>&nbsp;</td><td>Hotkey to increase parameter value. (Note: keys R, S, L are reserved.) If 0, the slider will only have one hotkey that circulates between values min, min+1, ..., max-1, max, min, ...</td></tr>
232    <tr><td valign="top"></td><td valign="top"><em>ff</em>&nbsp;</td><td>converter function to transform the parameter value </td></tr>
233    <tr><td valign="top"></td><td valign="top"><em>chf</em>&nbsp;</td><td>callback to an action to be performed when the parameter changes </td></tr>
234  </table>
235</dl>
236    </td>
237  </tr>
238</table>
239<a class="anchor" name="a11" doxytag="Parameters::Add"></a><p>
240<table class="mdTable" cellpadding="2" cellspacing="0">
241  <tr>
242    <td class="mdRow">
243      <table cellpadding="0" cellspacing="0" border="0">
244        <tr>
245          <td class="md" nowrap valign="top">void Parameters::Add           </td>
246          <td class="md" valign="top">(&nbsp;</td>
247          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
248          <td class="mdname" nowrap> <em>ID</em>, </td>
249        </tr>
250        <tr>
251          <td class="md" nowrap align="right"></td>
252          <td class="md"></td>
253          <td class="md" nowrap>char *&nbsp;</td>
254          <td class="mdname" nowrap> <em>label</em>, </td>
255        </tr>
256        <tr>
257          <td class="md" nowrap align="right"></td>
258          <td class="md"></td>
259          <td class="md" nowrap>int&nbsp;</td>
260          <td class="mdname" nowrap> <em>num_steps</em>, </td>
261        </tr>
262        <tr>
263          <td class="md" nowrap align="right"></td>
264          <td class="md"></td>
265          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a1">CONVERTER</a>&nbsp;</td>
266          <td class="mdname" nowrap> <em>ff</em>, </td>
267        </tr>
268        <tr>
269          <td class="md" nowrap align="right"></td>
270          <td class="md"></td>
271          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td>
272          <td class="mdname" nowrap> <em>chf</em> = <code>OnChange</code></td>
273        </tr>
274        <tr>
275          <td class="md"></td>
276          <td class="md">)&nbsp;</td>
277          <td class="md" colspan="2"></td>
278        </tr>
279      </table>
280    </td>
281  </tr>
282</table>
283<table cellspacing="5" cellpadding="0" border="0">
284  <tr>
285    <td>
286      &nbsp;
287    </td>
288    <td>
289
290<p>
291Adds a numeric parameter represented by a GUI <b>slider</b>. Specifies callback functions.
292<p>
293<dl compact><dt><b>Parameters:</b></dt><dd>
294  <table border="0" cellspacing="2" cellpadding="0">
295    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>id of the given numeric parameter </td></tr>
296    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>label to be displayed for the slider </td></tr>
297    <tr><td valign="top"></td><td valign="top"><em>num_steps</em>&nbsp;</td><td>number of possible parameter values </td></tr>
298    <tr><td valign="top"></td><td valign="top"><em>ff</em>&nbsp;</td><td>converter function to transform the parameter value </td></tr>
299    <tr><td valign="top"></td><td valign="top"><em>chf</em>&nbsp;</td><td>callback to an action to be performed when the parameter changes </td></tr>
300  </table>
301</dl>
302    </td>
303  </tr>
304</table>
305<a class="anchor" name="a10" doxytag="Parameters::Add"></a><p>
306<table class="mdTable" cellpadding="2" cellspacing="0">
307  <tr>
308    <td class="mdRow">
309      <table cellpadding="0" cellspacing="0" border="0">
310        <tr>
311          <td class="md" nowrap valign="top">void Parameters::Add           </td>
312          <td class="md" valign="top">(&nbsp;</td>
313          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
314          <td class="mdname" nowrap> <em>ID</em>, </td>
315        </tr>
316        <tr>
317          <td class="md" nowrap align="right"></td>
318          <td class="md"></td>
319          <td class="md" nowrap>char *&nbsp;</td>
320          <td class="mdname" nowrap> <em>label</em>, </td>
321        </tr>
322        <tr>
323          <td class="md" nowrap align="right"></td>
324          <td class="md"></td>
325          <td class="md" nowrap>int&nbsp;</td>
326          <td class="mdname" nowrap> <em>num_steps</em></td>
327        </tr>
328        <tr>
329          <td class="md"></td>
330          <td class="md">)&nbsp;</td>
331          <td class="md" colspan="2"></td>
332        </tr>
333      </table>
334    </td>
335  </tr>
336</table>
337<table cellspacing="5" cellpadding="0" border="0">
338  <tr>
339    <td>
340      &nbsp;
341    </td>
342    <td>
343
344<p>
345Adds a numeric parameter represented by a GUI <b>slider</b>.
346<p>
347<dl compact><dt><b>Parameters:</b></dt><dd>
348  <table border="0" cellspacing="2" cellpadding="0">
349    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>id of the given numeric parameter </td></tr>
350    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>label to be displayed for the slider </td></tr>
351    <tr><td valign="top"></td><td valign="top"><em>num_steps</em>&nbsp;</td><td>number of possible parameter values </td></tr>
352  </table>
353</dl>
354    </td>
355  </tr>
356</table>
357<a class="anchor" name="a9" doxytag="Parameters::Add"></a><p>
358<table class="mdTable" cellpadding="2" cellspacing="0">
359  <tr>
360    <td class="mdRow">
361      <table cellpadding="0" cellspacing="0" border="0">
362        <tr>
363          <td class="md" nowrap valign="top">void Parameters::Add           </td>
364          <td class="md" valign="top">(&nbsp;</td>
365          <td class="md" nowrap valign="top">int&nbsp;</td>
366          <td class="mdname" nowrap> <em>radiogroupID</em>, </td>
367        </tr>
368        <tr>
369          <td class="md" nowrap align="right"></td>
370          <td class="md"></td>
371          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a26">bool_t</a>&nbsp;</td>
372          <td class="mdname" nowrap> <em>ID</em>, </td>
373        </tr>
374        <tr>
375          <td class="md" nowrap align="right"></td>
376          <td class="md"></td>
377          <td class="md" nowrap>char *&nbsp;</td>
378          <td class="mdname" nowrap> <em>label</em>, </td>
379        </tr>
380        <tr>
381          <td class="md" nowrap align="right"></td>
382          <td class="md"></td>
383          <td class="md" nowrap>char&nbsp;</td>
384          <td class="mdname" nowrap> <em>cHotKey</em> = <code>0</code>, </td>
385        </tr>
386        <tr>
387          <td class="md" nowrap align="right"></td>
388          <td class="md"></td>
389          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td>
390          <td class="mdname" nowrap> <em>bchf</em> = <code>OnChange</code></td>
391        </tr>
392        <tr>
393          <td class="md"></td>
394          <td class="md">)&nbsp;</td>
395          <td class="md" colspan="2"></td>
396        </tr>
397      </table>
398    </td>
399  </tr>
400</table>
401<table cellspacing="5" cellpadding="0" border="0">
402  <tr>
403    <td>
404      &nbsp;
405    </td>
406    <td>
407
408<p>
409Adds a boolean parameter represented by a GUI <b>radio button</b>. Specifies hotkey and callback function.
410<p>
411<dl compact><dt><b>Parameters:</b></dt><dd>
412  <table border="0" cellspacing="2" cellpadding="0">
413    <tr><td valign="top"></td><td valign="top"><em>radiogroupID</em>&nbsp;</td><td>id of radio button group. Checking a radio button will clear all other radio buttons with the same radiogroupID. </td></tr>
414    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>id of the given boolean parameter </td></tr>
415    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>label to be displayed for the control </td></tr>
416    <tr><td valign="top"></td><td valign="top"><em>cHotkey</em>&nbsp;</td><td>Hotkey to change parameter value. (Note: keys R, S, L are reserved.) </td></tr>
417    <tr><td valign="top"></td><td valign="top"><em>bchf</em>&nbsp;</td><td>callback to an action to be performed when the parameter changes </td></tr>
418  </table>
419</dl>
420    </td>
421  </tr>
422</table>
423<a class="anchor" name="a8" doxytag="Parameters::Add"></a><p>
424<table class="mdTable" cellpadding="2" cellspacing="0">
425  <tr>
426    <td class="mdRow">
427      <table cellpadding="0" cellspacing="0" border="0">
428        <tr>
429          <td class="md" nowrap valign="top">void Parameters::Add           </td>
430          <td class="md" valign="top">(&nbsp;</td>
431          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a26">bool_t</a>&nbsp;</td>
432          <td class="mdname" nowrap> <em>ID</em>, </td>
433        </tr>
434        <tr>
435          <td class="md" nowrap align="right"></td>
436          <td class="md"></td>
437          <td class="md" nowrap>char *&nbsp;</td>
438          <td class="mdname" nowrap> <em>label</em>, </td>
439        </tr>
440        <tr>
441          <td class="md" nowrap align="right"></td>
442          <td class="md"></td>
443          <td class="md" nowrap>char&nbsp;</td>
444          <td class="mdname" nowrap> <em>cHotKey</em> = <code>0</code>, </td>
445        </tr>
446        <tr>
447          <td class="md" nowrap align="right"></td>
448          <td class="md"></td>
449          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td>
450          <td class="mdname" nowrap> <em>bchf</em> = <code>OnChange</code></td>
451        </tr>
452        <tr>
453          <td class="md"></td>
454          <td class="md">)&nbsp;</td>
455          <td class="md" colspan="2"></td>
456        </tr>
457      </table>
458    </td>
459  </tr>
460</table>
461<table cellspacing="5" cellpadding="0" border="0">
462  <tr>
463    <td>
464      &nbsp;
465    </td>
466    <td>
467
468<p>
469Adds a boolean parameter represented by a GUI <b>checkbox</b>. Specifies hotkey and callback function.
470<p>
471<dl compact><dt><b>Parameters:</b></dt><dd>
472  <table border="0" cellspacing="2" cellpadding="0">
473    <tr><td valign="top"></td><td valign="top"><em>ID</em>&nbsp;</td><td>id of the given boolean parameter </td></tr>
474    <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>label to be displayed for the control </td></tr>
475    <tr><td valign="top"></td><td valign="top"><em>cHotkey</em>&nbsp;</td><td>Hotkey to change parameter value. (Note: keys R, S, L are reserved.) </td></tr>
476    <tr><td valign="top"></td><td valign="top"><em>bchf</em>&nbsp;</td><td>callback to an action to be performed when the parameter changes </td></tr>
477  </table>
478</dl>
479    </td>
480  </tr>
481</table>
482<a class="anchor" name="a3" doxytag="Parameters::Get"></a><p>
483<table class="mdTable" cellpadding="2" cellspacing="0">
484  <tr>
485    <td class="mdRow">
486      <table cellpadding="0" cellspacing="0" border="0">
487        <tr>
488          <td class="md" nowrap valign="top">float Parameters::Get           </td>
489          <td class="md" valign="top">(&nbsp;</td>
490          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
491          <td class="mdname1" valign="top" nowrap> <em>i</em>          </td>
492          <td class="md" valign="top">&nbsp;)&nbsp;</td>
493          <td class="md" nowrap></td>
494        </tr>
495      </table>
496    </td>
497  </tr>
498</table>
499<table cellspacing="5" cellpadding="0" border="0">
500  <tr>
501    <td>
502      &nbsp;
503    </td>
504    <td>
505
506<p>
507Returns float value of the specified numeric parameter, in range 0..1.
508<p>
509Example: Get( refractionIndex ). Converter functions (if present) are applied to the result.     </td>
510  </tr>
511</table>
512<a class="anchor" name="a2" doxytag="Parameters::Get"></a><p>
513<table class="mdTable" cellpadding="2" cellspacing="0">
514  <tr>
515    <td class="mdRow">
516      <table cellpadding="0" cellspacing="0" border="0">
517        <tr>
518          <td class="md" nowrap valign="top">bool Parameters::Get           </td>
519          <td class="md" valign="top">(&nbsp;</td>
520          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a26">bool_t</a>&nbsp;</td>
521          <td class="mdname1" valign="top" nowrap> <em>i</em>          </td>
522          <td class="md" valign="top">&nbsp;)&nbsp;</td>
523          <td class="md" nowrap></td>
524        </tr>
525      </table>
526    </td>
527  </tr>
528</table>
529<table cellspacing="5" cellpadding="0" border="0">
530  <tr>
531    <td>
532      &nbsp;
533    </td>
534    <td>
535
536<p>
537Returns value of the specified boolean parameter, e.g. Get( <a class="el" href="_parameters_8h.html#a26a3">bShowHelp</a> ).
538<p>
539    </td>
540  </tr>
541</table>
542<a class="anchor" name="a4" doxytag="Parameters::GetInt"></a><p>
543<table class="mdTable" cellpadding="2" cellspacing="0">
544  <tr>
545    <td class="mdRow">
546      <table cellpadding="0" cellspacing="0" border="0">
547        <tr>
548          <td class="md" nowrap valign="top">int Parameters::GetInt           </td>
549          <td class="md" valign="top">(&nbsp;</td>
550          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
551          <td class="mdname1" valign="top" nowrap> <em>i</em>          </td>
552          <td class="md" valign="top">&nbsp;)&nbsp;</td>
553          <td class="md" nowrap></td>
554        </tr>
555      </table>
556    </td>
557  </tr>
558</table>
559<table cellspacing="5" cellpadding="0" border="0">
560  <tr>
561    <td>
562      &nbsp;
563    </td>
564    <td>
565
566<p>
567Returns integer value of the specified numeric parameter, in range 0...number-of-steps.
568<p>
569Example: Get( fIntensity ) = 0..100. Converter functions (if present) are applied to the result.     </td>
570  </tr>
571</table>
572<a class="anchor" name="a17" doxytag="Parameters::LoadFromFile"></a><p>
573<table class="mdTable" cellpadding="2" cellspacing="0">
574  <tr>
575    <td class="mdRow">
576      <table cellpadding="0" cellspacing="0" border="0">
577        <tr>
578          <td class="md" nowrap valign="top">void Parameters::LoadFromFile           </td>
579          <td class="md" valign="top">(&nbsp;</td>
580          <td class="md" nowrap valign="top">char *&nbsp;</td>
581          <td class="mdname1" valign="top" nowrap> <em>fileName</em>          </td>
582          <td class="md" valign="top">&nbsp;)&nbsp;</td>
583          <td class="md" nowrap></td>
584        </tr>
585      </table>
586    </td>
587  </tr>
588</table>
589<table cellspacing="5" cellpadding="0" border="0">
590  <tr>
591    <td>
592      &nbsp;
593    </td>
594    <td>
595
596<p>
597Loads all parameter values from the specified file.
598<p>
599    </td>
600  </tr>
601</table>
602<a class="anchor" name="a16" doxytag="Parameters::SaveToFile"></a><p>
603<table class="mdTable" cellpadding="2" cellspacing="0">
604  <tr>
605    <td class="mdRow">
606      <table cellpadding="0" cellspacing="0" border="0">
607        <tr>
608          <td class="md" nowrap valign="top">void Parameters::SaveToFile           </td>
609          <td class="md" valign="top">(&nbsp;</td>
610          <td class="md" nowrap valign="top">char *&nbsp;</td>
611          <td class="mdname1" valign="top" nowrap> <em>fileName</em>          </td>
612          <td class="md" valign="top">&nbsp;)&nbsp;</td>
613          <td class="md" nowrap></td>
614        </tr>
615      </table>
616    </td>
617  </tr>
618</table>
619<table cellspacing="5" cellpadding="0" border="0">
620  <tr>
621    <td>
622      &nbsp;
623    </td>
624    <td>
625
626<p>
627Writes all parameter values into the specified file.
628<p>
629    </td>
630  </tr>
631</table>
632<a class="anchor" name="a5" doxytag="Parameters::SetBool"></a><p>
633<table class="mdTable" cellpadding="2" cellspacing="0">
634  <tr>
635    <td class="mdRow">
636      <table cellpadding="0" cellspacing="0" border="0">
637        <tr>
638          <td class="md" nowrap valign="top">void Parameters::SetBool           </td>
639          <td class="md" valign="top">(&nbsp;</td>
640          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a26">bool_t</a>&nbsp;</td>
641          <td class="mdname" nowrap> <em>ID</em>, </td>
642        </tr>
643        <tr>
644          <td class="md" nowrap align="right"></td>
645          <td class="md"></td>
646          <td class="md" nowrap>bool&nbsp;</td>
647          <td class="mdname" nowrap> <em>b</em></td>
648        </tr>
649        <tr>
650          <td class="md"></td>
651          <td class="md">)&nbsp;</td>
652          <td class="md" colspan="2"></td>
653        </tr>
654      </table>
655    </td>
656  </tr>
657</table>
658<table cellspacing="5" cellpadding="0" border="0">
659  <tr>
660    <td>
661      &nbsp;
662    </td>
663    <td>
664
665<p>
666    </td>
667  </tr>
668</table>
669<a class="anchor" name="a14" doxytag="Parameters::SetEnabled"></a><p>
670<table class="mdTable" cellpadding="2" cellspacing="0">
671  <tr>
672    <td class="mdRow">
673      <table cellpadding="0" cellspacing="0" border="0">
674        <tr>
675          <td class="md" nowrap valign="top">void Parameters::SetEnabled           </td>
676          <td class="md" valign="top">(&nbsp;</td>
677          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
678          <td class="mdname" nowrap> <em>ID</em>, </td>
679        </tr>
680        <tr>
681          <td class="md" nowrap align="right"></td>
682          <td class="md"></td>
683          <td class="md" nowrap>bool&nbsp;</td>
684          <td class="mdname" nowrap> <em>bEnabled</em></td>
685        </tr>
686        <tr>
687          <td class="md"></td>
688          <td class="md">)&nbsp;</td>
689          <td class="md" colspan="2"></td>
690        </tr>
691      </table>
692    </td>
693  </tr>
694</table>
695<table cellspacing="5" cellpadding="0" border="0">
696  <tr>
697    <td>
698      &nbsp;
699    </td>
700    <td>
701
702<p>
703    </td>
704  </tr>
705</table>
706<a class="anchor" name="a13" doxytag="Parameters::SetEnabled"></a><p>
707<table class="mdTable" cellpadding="2" cellspacing="0">
708  <tr>
709    <td class="mdRow">
710      <table cellpadding="0" cellspacing="0" border="0">
711        <tr>
712          <td class="md" nowrap valign="top">void Parameters::SetEnabled           </td>
713          <td class="md" valign="top">(&nbsp;</td>
714          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a26">bool_t</a>&nbsp;</td>
715          <td class="mdname" nowrap> <em>ID</em>, </td>
716        </tr>
717        <tr>
718          <td class="md" nowrap align="right"></td>
719          <td class="md"></td>
720          <td class="md" nowrap>bool&nbsp;</td>
721          <td class="mdname" nowrap> <em>bEnabled</em></td>
722        </tr>
723        <tr>
724          <td class="md"></td>
725          <td class="md">)&nbsp;</td>
726          <td class="md" colspan="2"></td>
727        </tr>
728      </table>
729    </td>
730  </tr>
731</table>
732<table cellspacing="5" cellpadding="0" border="0">
733  <tr>
734    <td>
735      &nbsp;
736    </td>
737    <td>
738
739<p>
740    </td>
741  </tr>
742</table>
743<a class="anchor" name="a6" doxytag="Parameters::SetFloat"></a><p>
744<table class="mdTable" cellpadding="2" cellspacing="0">
745  <tr>
746    <td class="mdRow">
747      <table cellpadding="0" cellspacing="0" border="0">
748        <tr>
749          <td class="md" nowrap valign="top">void Parameters::SetFloat           </td>
750          <td class="md" valign="top">(&nbsp;</td>
751          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
752          <td class="mdname" nowrap> <em>ID</em>, </td>
753        </tr>
754        <tr>
755          <td class="md" nowrap align="right"></td>
756          <td class="md"></td>
757          <td class="md" nowrap>float&nbsp;</td>
758          <td class="mdname" nowrap> <em>v</em></td>
759        </tr>
760        <tr>
761          <td class="md"></td>
762          <td class="md">)&nbsp;</td>
763          <td class="md" colspan="2"></td>
764        </tr>
765      </table>
766    </td>
767  </tr>
768</table>
769<table cellspacing="5" cellpadding="0" border="0">
770  <tr>
771    <td>
772      &nbsp;
773    </td>
774    <td>
775
776<p>
777    </td>
778  </tr>
779</table>
780<a class="anchor" name="a7" doxytag="Parameters::SetInt"></a><p>
781<table class="mdTable" cellpadding="2" cellspacing="0">
782  <tr>
783    <td class="mdRow">
784      <table cellpadding="0" cellspacing="0" border="0">
785        <tr>
786          <td class="md" nowrap valign="top">void Parameters::SetInt           </td>
787          <td class="md" valign="top">(&nbsp;</td>
788          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a27">number_t</a>&nbsp;</td>
789          <td class="mdname" nowrap> <em>ID</em>, </td>
790        </tr>
791        <tr>
792          <td class="md" nowrap align="right"></td>
793          <td class="md"></td>
794          <td class="md" nowrap>int&nbsp;</td>
795          <td class="mdname" nowrap> <em>v</em></td>
796        </tr>
797        <tr>
798          <td class="md"></td>
799          <td class="md">)&nbsp;</td>
800          <td class="md" colspan="2"></td>
801        </tr>
802      </table>
803    </td>
804  </tr>
805</table>
806<table cellspacing="5" cellpadding="0" border="0">
807  <tr>
808    <td>
809      &nbsp;
810    </td>
811    <td>
812
813<p>
814    </td>
815  </tr>
816</table>
817<a class="anchor" name="a1" doxytag="Parameters::Setup"></a><p>
818<table class="mdTable" cellpadding="2" cellspacing="0">
819  <tr>
820    <td class="mdRow">
821      <table cellpadding="0" cellspacing="0" border="0">
822        <tr>
823          <td class="md" nowrap valign="top">void Parameters::Setup           </td>
824          <td class="md" valign="top">(&nbsp;</td>
825          <td class="md" nowrap valign="top">CDXUTDialog *&nbsp;</td>
826          <td class="mdname" nowrap> <em>g_HUD</em>, </td>
827        </tr>
828        <tr>
829          <td class="md" nowrap align="right"></td>
830          <td class="md"></td>
831          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td>
832          <td class="mdname" nowrap> <em>OnReset</em>, </td>
833        </tr>
834        <tr>
835          <td class="md" nowrap align="right"></td>
836          <td class="md"></td>
837          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td>
838          <td class="mdname" nowrap> <em>OnSave</em> = <code>OnChange</code>, </td>
839        </tr>
840        <tr>
841          <td class="md" nowrap align="right"></td>
842          <td class="md"></td>
843          <td class="md" nowrap><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>&nbsp;</td>
844          <td class="mdname" nowrap> <em>OnLoad</em> = <code>OnChange</code></td>
845        </tr>
846        <tr>
847          <td class="md"></td>
848          <td class="md">)&nbsp;</td>
849          <td class="md" colspan="2"></td>
850        </tr>
851      </table>
852    </td>
853  </tr>
854</table>
855<table cellspacing="5" cellpadding="0" border="0">
856  <tr>
857    <td>
858      &nbsp;
859    </td>
860    <td>
861
862<p>
863You can set the dialog that manages input and rendering for the GUI controls.
864<p>
865Additionally, you can specify actions (<a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a>) to the standard buttons Reset, Save and Load.     </td>
866  </tr>
867</table>
868<a class="anchor" name="a0" doxytag="Parameters::Setup"></a><p>
869<table class="mdTable" cellpadding="2" cellspacing="0">
870  <tr>
871    <td class="mdRow">
872      <table cellpadding="0" cellspacing="0" border="0">
873        <tr>
874          <td class="md" nowrap valign="top">void Parameters::Setup           </td>
875          <td class="md" valign="top">(&nbsp;</td>
876          <td class="md" nowrap valign="top">CDXUTDialog *&nbsp;</td>
877          <td class="mdname1" valign="top" nowrap> <em>g_HUD</em>          </td>
878          <td class="md" valign="top">&nbsp;)&nbsp;</td>
879          <td class="md" nowrap></td>
880        </tr>
881      </table>
882    </td>
883  </tr>
884</table>
885<table cellspacing="5" cellpadding="0" border="0">
886  <tr>
887    <td>
888      &nbsp;
889    </td>
890    <td>
891
892<p>
893You can set the dialog that manages input and rendering for the GUI controls.
894<p>
895    </td>
896  </tr>
897</table>
898<a class="anchor" name="a15" doxytag="Parameters::UpdateFromHUD"></a><p>
899<table class="mdTable" cellpadding="2" cellspacing="0">
900  <tr>
901    <td class="mdRow">
902      <table cellpadding="0" cellspacing="0" border="0">
903        <tr>
904          <td class="md" nowrap valign="top">void Parameters::UpdateFromHUD           </td>
905          <td class="md" valign="top">(&nbsp;</td>
906          <td class="md" nowrap valign="top">int&nbsp;</td>
907          <td class="mdname1" valign="top" nowrap> <em>controlID</em>          </td>
908          <td class="md" valign="top">&nbsp;)&nbsp;</td>
909          <td class="md" nowrap></td>
910        </tr>
911      </table>
912    </td>
913  </tr>
914</table>
915<table cellspacing="5" cellpadding="0" border="0">
916  <tr>
917    <td>
918      &nbsp;
919    </td>
920    <td>
921
922<p>
923Updates the specified parameter from the GUI.
924<p>
925Since a GUI event provides the id of the sender (see <a class="el" href="_main_8cpp.html#a26">OnGUIEvent()</a> in <a class="el" href="_main_8cpp.html">Main.cpp</a>), we can update the parameter value belonging to that control.<p>
926In case of Load/Save, parameters are loaded from/saved to the file called <b>.params</b>. In case of Reset, parameters are loaded from the file called <b>.params0</b>.     </td>
927  </tr>
928</table>
929<hr><h2>Member Data Documentation</h2>
930<a class="anchor" name="r9" doxytag="Parameters::bchfunc"></a><p>
931<table class="mdTable" cellpadding="2" cellspacing="0">
932  <tr>
933    <td class="mdRow">
934      <table cellpadding="0" cellspacing="0" border="0">
935        <tr>
936          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> <a class="el" href="class_parameters.html#r9">Parameters::bchfunc</a>[LAST_BOOL]<code> [private]</code>          </td>
937        </tr>
938      </table>
939    </td>
940  </tr>
941</table>
942<table cellspacing="5" cellpadding="0" border="0">
943  <tr>
944    <td>
945      &nbsp;
946    </td>
947    <td>
948
949<p>
950    </td>
951  </tr>
952</table>
953<a class="anchor" name="r1" doxytag="Parameters::bname"></a><p>
954<table class="mdTable" cellpadding="2" cellspacing="0">
955  <tr>
956    <td class="mdRow">
957      <table cellpadding="0" cellspacing="0" border="0">
958        <tr>
959          <td class="md" nowrap valign="top">wchar_t <a class="el" href="class_parameters.html#r1">Parameters::bname</a>[LAST_BOOL][CHARBUF]<code> [private]</code>          </td>
960        </tr>
961      </table>
962    </td>
963  </tr>
964</table>
965<table cellspacing="5" cellpadding="0" border="0">
966  <tr>
967    <td>
968      &nbsp;
969    </td>
970    <td>
971
972<p>
973param name
974<p>
975    </td>
976  </tr>
977</table>
978<a class="anchor" name="r0" doxytag="Parameters::bparam"></a><p>
979<table class="mdTable" cellpadding="2" cellspacing="0">
980  <tr>
981    <td class="mdRow">
982      <table cellpadding="0" cellspacing="0" border="0">
983        <tr>
984          <td class="md" nowrap valign="top">bool <a class="el" href="class_parameters.html#r0">Parameters::bparam</a>[LAST_BOOL]<code> [private]</code>          </td>
985        </tr>
986      </table>
987    </td>
988  </tr>
989</table>
990<table cellspacing="5" cellpadding="0" border="0">
991  <tr>
992    <td>
993      &nbsp;
994    </td>
995    <td>
996
997<p>
998current param value (boolean)
999<p>
1000    </td>
1001  </tr>
1002</table>
1003<a class="anchor" name="r11" doxytag="Parameters::bSilent"></a><p>
1004<table class="mdTable" cellpadding="2" cellspacing="0">
1005  <tr>
1006    <td class="mdRow">
1007      <table cellpadding="0" cellspacing="0" border="0">
1008        <tr>
1009          <td class="md" nowrap valign="top">bool <a class="el" href="class_parameters.html#r11">Parameters::bSilent</a><code> [private]</code>          </td>
1010        </tr>
1011      </table>
1012    </td>
1013  </tr>
1014</table>
1015<table cellspacing="5" cellpadding="0" border="0">
1016  <tr>
1017    <td>
1018      &nbsp;
1019    </td>
1020    <td>
1021
1022<p>
1023to avoid an endless loop due to a change
1024<p>
1025    </td>
1026  </tr>
1027</table>
1028<a class="anchor" name="v0" doxytag="Parameters::CHARBUFFER_SIZE"></a><p>
1029<table class="mdTable" cellpadding="2" cellspacing="0">
1030  <tr>
1031    <td class="mdRow">
1032      <table cellpadding="0" cellspacing="0" border="0">
1033        <tr>
1034          <td class="md" nowrap valign="top">const int <a class="el" href="class_parameters.html#v0">Parameters::CHARBUFFER_SIZE</a> = 200<code> [static, private]</code>          </td>
1035        </tr>
1036      </table>
1037    </td>
1038  </tr>
1039</table>
1040<table cellspacing="5" cellpadding="0" border="0">
1041  <tr>
1042    <td>
1043      &nbsp;
1044    </td>
1045    <td>
1046
1047<p>
1048    </td>
1049  </tr>
1050</table>
1051<a class="anchor" name="r8" doxytag="Parameters::chfunc"></a><p>
1052<table class="mdTable" cellpadding="2" cellspacing="0">
1053  <tr>
1054    <td class="mdRow">
1055      <table cellpadding="0" cellspacing="0" border="0">
1056        <tr>
1057          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a2">ONCHANGE_CALLBACK</a> <a class="el" href="class_parameters.html#r8">Parameters::chfunc</a>[LAST_NUMBER+3]<code> [private]</code>          </td>
1058        </tr>
1059      </table>
1060    </td>
1061  </tr>
1062</table>
1063<table cellspacing="5" cellpadding="0" border="0">
1064  <tr>
1065    <td>
1066      &nbsp;
1067    </td>
1068    <td>
1069
1070<p>
1071    </td>
1072  </tr>
1073</table>
1074<a class="anchor" name="r7" doxytag="Parameters::ffunc"></a><p>
1075<table class="mdTable" cellpadding="2" cellspacing="0">
1076  <tr>
1077    <td class="mdRow">
1078      <table cellpadding="0" cellspacing="0" border="0">
1079        <tr>
1080          <td class="md" nowrap valign="top"><a class="el" href="_parameters_8h.html#a1">CONVERTER</a> <a class="el" href="class_parameters.html#r7">Parameters::ffunc</a>[LAST_NUMBER]<code> [private]</code>          </td>
1081        </tr>
1082      </table>
1083    </td>
1084  </tr>
1085</table>
1086<table cellspacing="5" cellpadding="0" border="0">
1087  <tr>
1088    <td>
1089      &nbsp;
1090    </td>
1091    <td>
1092
1093<p>
1094    </td>
1095  </tr>
1096</table>
1097<a class="anchor" name="r10" doxytag="Parameters::g_HUD"></a><p>
1098<table class="mdTable" cellpadding="2" cellspacing="0">
1099  <tr>
1100    <td class="mdRow">
1101      <table cellpadding="0" cellspacing="0" border="0">
1102        <tr>
1103          <td class="md" nowrap valign="top">CDXUTDialog* <a class="el" href="class_parameters.html#r10">Parameters::g_HUD</a><code> [private]</code>          </td>
1104        </tr>
1105      </table>
1106    </td>
1107  </tr>
1108</table>
1109<table cellspacing="5" cellpadding="0" border="0">
1110  <tr>
1111    <td>
1112      &nbsp;
1113    </td>
1114    <td>
1115
1116<p>
1117    </td>
1118  </tr>
1119</table>
1120<a class="anchor" name="r4" doxytag="Parameters::name"></a><p>
1121<table class="mdTable" cellpadding="2" cellspacing="0">
1122  <tr>
1123    <td class="mdRow">
1124      <table cellpadding="0" cellspacing="0" border="0">
1125        <tr>
1126          <td class="md" nowrap valign="top">wchar_t <a class="el" href="class_parameters.html#r4">Parameters::name</a>[LAST_NUMBER][CHARBUF]<code> [private]</code>          </td>
1127        </tr>
1128      </table>
1129    </td>
1130  </tr>
1131</table>
1132<table cellspacing="5" cellpadding="0" border="0">
1133  <tr>
1134    <td>
1135      &nbsp;
1136    </td>
1137    <td>
1138
1139<p>
1140param name
1141<p>
1142    </td>
1143  </tr>
1144</table>
1145<a class="anchor" name="r5" doxytag="Parameters::numsteps"></a><p>
1146<table class="mdTable" cellpadding="2" cellspacing="0">
1147  <tr>
1148    <td class="mdRow">
1149      <table cellpadding="0" cellspacing="0" border="0">
1150        <tr>
1151          <td class="md" nowrap valign="top">int <a class="el" href="class_parameters.html#r5">Parameters::numsteps</a>[LAST_NUMBER]<code> [private]</code>          </td>
1152        </tr>
1153      </table>
1154    </td>
1155  </tr>
1156</table>
1157<table cellspacing="5" cellpadding="0" border="0">
1158  <tr>
1159    <td>
1160      &nbsp;
1161    </td>
1162    <td>
1163
1164<p>
1165number of possible steps for param
1166<p>
1167    </td>
1168  </tr>
1169</table>
1170<a class="anchor" name="r3" doxytag="Parameters::param"></a><p>
1171<table class="mdTable" cellpadding="2" cellspacing="0">
1172  <tr>
1173    <td class="mdRow">
1174      <table cellpadding="0" cellspacing="0" border="0">
1175        <tr>
1176          <td class="md" nowrap valign="top">int <a class="el" href="class_parameters.html#r3">Parameters::param</a>[LAST_NUMBER]<code> [private]</code>          </td>
1177        </tr>
1178      </table>
1179    </td>
1180  </tr>
1181</table>
1182<table cellspacing="5" cellpadding="0" border="0">
1183  <tr>
1184    <td>
1185      &nbsp;
1186    </td>
1187    <td>
1188
1189<p>
1190current param value (numeric)
1191<p>
1192    </td>
1193  </tr>
1194</table>
1195<a class="anchor" name="r2" doxytag="Parameters::radiogroup"></a><p>
1196<table class="mdTable" cellpadding="2" cellspacing="0">
1197  <tr>
1198    <td class="mdRow">
1199      <table cellpadding="0" cellspacing="0" border="0">
1200        <tr>
1201          <td class="md" nowrap valign="top">int <a class="el" href="class_parameters.html#r2">Parameters::radiogroup</a>[LAST_BOOL]<code> [private]</code>          </td>
1202        </tr>
1203      </table>
1204    </td>
1205  </tr>
1206</table>
1207<table cellspacing="5" cellpadding="0" border="0">
1208  <tr>
1209    <td>
1210      &nbsp;
1211    </td>
1212    <td>
1213
1214<p>
1215for boolean params that are represented by a checkbox
1216<p>
1217    </td>
1218  </tr>
1219</table>
1220<a class="anchor" name="r6" doxytag="Parameters::rotate"></a><p>
1221<table class="mdTable" cellpadding="2" cellspacing="0">
1222  <tr>
1223    <td class="mdRow">
1224      <table cellpadding="0" cellspacing="0" border="0">
1225        <tr>
1226          <td class="md" nowrap valign="top">bool <a class="el" href="class_parameters.html#r6">Parameters::rotate</a>[LAST_NUMBER]<code> [private]</code>          </td>
1227        </tr>
1228      </table>
1229    </td>
1230  </tr>
1231</table>
1232<table cellspacing="5" cellpadding="0" border="0">
1233  <tr>
1234    <td>
1235      &nbsp;
1236    </td>
1237    <td>
1238
1239<p>
1240stores whether the slider can rotate around
1241<p>
1242    </td>
1243  </tr>
1244</table>
1245<hr>The documentation for this class was generated from the following files:<ul>
1246<li><a class="el" href="_parameters_8h.html">Parameters.h</a><li><a class="el" href="_parameters_8cpp.html">Parameters.cpp</a></ul>
1247<hr size="1"><address style="align: right;"><small>Generated on Wed Aug 23 00:00:39 2006 for Indirect Environment Mapping by&nbsp;
1248<a href="http://www.doxygen.org/index.html">
1249<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
1250</body>
1251</html>
Note: See TracBrowser for help on using the repository browser.