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