source: NonGTP/FCollada/Documentation/class_f_c_d_effect_parameter_bool.html @ 964

Revision 964, 18.8 KB checked in by igarcia, 19 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>FCollada: FCDEffectParameterBool Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.4.6-NO -->
8<div class="tabs">
9  <ul>
10    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11    <li><a href="modules.html"><span>Modules</span></a></li>
12    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13    <li id="current"><a href="classes.html"><span>Classes</span></a></li>
14    <li><a href="files.html"><span>Files</span></a></li>
15    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
20    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23  </ul></div>
24<h1>FCDEffectParameterBool Class Reference</h1><!-- doxytag: class="FCDEffectParameterBool" --><!-- doxytag: inherits="FCDEffectParameter" -->A COLLADA boolean effect parameter. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDEffectParameterBool:
30<p><center><img src="class_f_c_d_effect_parameter_bool.png" usemap="#FCDEffectParameterBool_map" border="0" alt=""></center>
31<map name="FCDEffectParameterBool_map">
32<area href="class_f_c_d_effect_parameter.html" alt="FCDEffectParameter" shape="rect" coords="0,112,154,136">
33<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,154,80">
34<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,154,24">
35</map>
36<a href="class_f_c_d_effect_parameter_bool-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
37<tr><td></td></tr>
38<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
39<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#ad789f6227b3965f3f6780751a6ff3b1">FCDEffectParameterBool</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#ad789f6227b3965f3f6780751a6ff3b1"></a><br></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#3de42dde2c1b61088904c0c0498748d4">~FCDEffectParameterBool</a> ()</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#3de42dde2c1b61088904c0c0498748d4"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#9dcd9b8cfdd28ac8ed1d077a06f310c3">GetType</a> () const </td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type of effect parameter class.  <a href="#9dcd9b8cfdd28ac8ed1d077a06f310c3"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#8e00c88e7a2c2c1e48f27e2d7da4a7b8">GetValue</a> () const </td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the boolean value of the effect parameter.  <a href="#8e00c88e7a2c2c1e48f27e2d7da4a7b8"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#eda6e4ec8451cf3df18bbd91c5c34cee">SetValue</a> (bool _value)</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the boolean value of the effect parameter.  <a href="#eda6e4ec8451cf3df18bbd91c5c34cee"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#bd7cb3640e93bf4ea69208720da2f0d8">Clone</a> ()</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a full copy of the effect parameter.  <a href="#bd7cb3640e93bf4ea69208720da2f0d8"></a><br></td></tr>
57<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#b12e01129144af7c5dc44316ea134752">Overwrite</a> (<a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *target)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Overwrites the target parameter with this parameter.  <a href="#b12e01129144af7c5dc44316ea134752"></a><br></td></tr>
60<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#36e922356a5bbee4965c14cbd5bd0cfa">LoadFromXML</a> (xmlNode *parameterNode)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.  <a href="#36e922356a5bbee4965c14cbd5bd0cfa"></a><br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_effect_parameter_bool.html#c177489519a1ec4f8ace8816da91f391">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.  <a href="#c177489519a1ec4f8ace8816da91f391"></a><br></td></tr>
66</table>
67<hr><a name="_details"></a><h2>Detailed Description</h2>
68A COLLADA boolean effect parameter.
69<p>
70Contains a single, unanimated boolean.
71<p>
72<hr><h2>Constructor &amp; Destructor Documentation</h2>
73<a class="anchor" name="ad789f6227b3965f3f6780751a6ff3b1"></a><!-- doxytag: member="FCDEffectParameterBool::FCDEffectParameterBool" ref="ad789f6227b3965f3f6780751a6ff3b1" args="(FCDocument *document)" --><p>
74<table class="mdTable" cellpadding="2" cellspacing="0">
75  <tr>
76    <td class="mdRow">
77      <table cellpadding="0" cellspacing="0" border="0">
78        <tr>
79          <td class="md" nowrap valign="top">FCDEffectParameterBool::FCDEffectParameterBool           </td>
80          <td class="md" valign="top">(&nbsp;</td>
81          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
82          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
83          <td class="md" valign="top">&nbsp;)&nbsp;</td>
84          <td class="md" nowrap></td>
85        </tr>
86      </table>
87    </td>
88  </tr>
89</table>
90<table cellspacing="5" cellpadding="0" border="0">
91  <tr>
92    <td>
93      &nbsp;
94    </td>
95    <td>
96
97<p>
98Constructor: do not use directly.
99<p>
100Instead, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#da878b47cabf114c520fdf70bf252a2c">FCDEffectParameterList::AddParameter</a> function. <dl compact><dt><b>Parameters:</b></dt><dd>
101  <table border="0" cellspacing="2" cellpadding="0">
102    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns the effect parameter. </td></tr>
103  </table>
104</dl>
105    </td>
106  </tr>
107</table>
108<a class="anchor" name="3de42dde2c1b61088904c0c0498748d4"></a><!-- doxytag: member="FCDEffectParameterBool::~FCDEffectParameterBool" ref="3de42dde2c1b61088904c0c0498748d4" args="()" --><p>
109<table class="mdTable" cellpadding="2" cellspacing="0">
110  <tr>
111    <td class="mdRow">
112      <table cellpadding="0" cellspacing="0" border="0">
113        <tr>
114          <td class="md" nowrap valign="top">virtual FCDEffectParameterBool::~FCDEffectParameterBool           </td>
115          <td class="md" valign="top">(&nbsp;</td>
116          <td class="mdname1" valign="top" nowrap>          </td>
117          <td class="md" valign="top">&nbsp;)&nbsp;</td>
118          <td class="md" nowrap><code> [virtual]</code></td>
119        </tr>
120      </table>
121    </td>
122  </tr>
123</table>
124<table cellspacing="5" cellpadding="0" border="0">
125  <tr>
126    <td>
127      &nbsp;
128    </td>
129    <td>
130
131<p>
132Destructor: do not use directly.
133<p>
134Instead, use the <a class="el" href="class_f_c_d_effect_parameter_list.html#b5ef02e0d258871d25d75666e199a9f3">FCDEffectParameterList::ReleaseParameter</a> function. When released, the effect parameter list will also release all its parameters, if it owns them.     </td>
135  </tr>
136</table>
137<hr><h2>Member Function Documentation</h2>
138<a class="anchor" name="bd7cb3640e93bf4ea69208720da2f0d8"></a><!-- doxytag: member="FCDEffectParameterBool::Clone" ref="bd7cb3640e93bf4ea69208720da2f0d8" args="()" --><p>
139<table class="mdTable" cellpadding="2" cellspacing="0">
140  <tr>
141    <td class="mdRow">
142      <table cellpadding="0" cellspacing="0" border="0">
143        <tr>
144          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a>* FCDEffectParameterBool::Clone           </td>
145          <td class="md" valign="top">(&nbsp;</td>
146          <td class="mdname1" valign="top" nowrap>          </td>
147          <td class="md" valign="top">&nbsp;)&nbsp;</td>
148          <td class="md" nowrap><code> [virtual]</code></td>
149        </tr>
150      </table>
151    </td>
152  </tr>
153</table>
154<table cellspacing="5" cellpadding="0" border="0">
155  <tr>
156    <td>
157      &nbsp;
158    </td>
159    <td>
160
161<p>
162Creates a full copy of the effect parameter.
163<p>
164<dl compact><dt><b>Returns:</b></dt><dd>The cloned effect parameter. You will need to delete this pointer. </dd></dl>
165
166<p>
167Implements <a class="el" href="class_f_c_d_effect_parameter.html#760f178513367b602f7c3363a158b76e">FCDEffectParameter</a>.    </td>
168  </tr>
169</table>
170<a class="anchor" name="9dcd9b8cfdd28ac8ed1d077a06f310c3"></a><!-- doxytag: member="FCDEffectParameterBool::GetType" ref="9dcd9b8cfdd28ac8ed1d077a06f310c3" args="() const " --><p>
171<table class="mdTable" cellpadding="2" cellspacing="0">
172  <tr>
173    <td class="mdRow">
174      <table cellpadding="0" cellspacing="0" border="0">
175        <tr>
176          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_effect_parameter.html#1efe74553d2ed199435085c171743b08">Type</a> FCDEffectParameterBool::GetType           </td>
177          <td class="md" valign="top">(&nbsp;</td>
178          <td class="mdname1" valign="top" nowrap>          </td>
179          <td class="md" valign="top">&nbsp;)&nbsp;</td>
180          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
181        </tr>
182      </table>
183    </td>
184  </tr>
185</table>
186<table cellspacing="5" cellpadding="0" border="0">
187  <tr>
188    <td>
189      &nbsp;
190    </td>
191    <td>
192
193<p>
194Retrieves the type of effect parameter class.
195<p>
196<dl compact><dt><b>Returns:</b></dt><dd>The parameter class type: BOOLEAN. </dd></dl>
197
198<p>
199Implements <a class="el" href="class_f_c_d_effect_parameter.html#5858946f333ea4486ca30c4c1b104871">FCDEffectParameter</a>.    </td>
200  </tr>
201</table>
202<a class="anchor" name="8e00c88e7a2c2c1e48f27e2d7da4a7b8"></a><!-- doxytag: member="FCDEffectParameterBool::GetValue" ref="8e00c88e7a2c2c1e48f27e2d7da4a7b8" args="() const " --><p>
203<table class="mdTable" cellpadding="2" cellspacing="0">
204  <tr>
205    <td class="mdRow">
206      <table cellpadding="0" cellspacing="0" border="0">
207        <tr>
208          <td class="md" nowrap valign="top">bool FCDEffectParameterBool::GetValue           </td>
209          <td class="md" valign="top">(&nbsp;</td>
210          <td class="mdname1" valign="top" nowrap>          </td>
211          <td class="md" valign="top">&nbsp;)&nbsp;</td>
212          <td class="md" nowrap> const<code> [inline]</code></td>
213        </tr>
214      </table>
215    </td>
216  </tr>
217</table>
218<table cellspacing="5" cellpadding="0" border="0">
219  <tr>
220    <td>
221      &nbsp;
222    </td>
223    <td>
224
225<p>
226Retrieves the boolean value of the effect parameter.
227<p>
228<dl compact><dt><b>Returns:</b></dt><dd>The boolean value. </dd></dl>
229    </td>
230  </tr>
231</table>
232<a class="anchor" name="36e922356a5bbee4965c14cbd5bd0cfa"></a><!-- doxytag: member="FCDEffectParameterBool::LoadFromXML" ref="36e922356a5bbee4965c14cbd5bd0cfa" args="(xmlNode *parameterNode)" --><p>
233<table class="mdTable" cellpadding="2" cellspacing="0">
234  <tr>
235    <td class="mdRow">
236      <table cellpadding="0" cellspacing="0" border="0">
237        <tr>
238          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEffectParameterBool::LoadFromXML           </td>
239          <td class="md" valign="top">(&nbsp;</td>
240          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
241          <td class="mdname1" valign="top" nowrap> <em>parameterNode</em>          </td>
242          <td class="md" valign="top">&nbsp;)&nbsp;</td>
243          <td class="md" nowrap><code> [virtual]</code></td>
244        </tr>
245      </table>
246    </td>
247  </tr>
248</table>
249<table cellspacing="5" cellpadding="0" border="0">
250  <tr>
251    <td>
252      &nbsp;
253    </td>
254    <td>
255
256<p>
257[INTERNAL] Reads in the effect parameter from a given COLLADA XML tree node.
258<p>
259<dl compact><dt><b>Parameters:</b></dt><dd>
260  <table border="0" cellspacing="2" cellpadding="0">
261    <tr><td valign="top"></td><td valign="top"><em>parameterNode</em>&nbsp;</td><td>The COLLADA XML tree node. </td></tr>
262  </table>
263</dl>
264<dl compact><dt><b>Returns:</b></dt><dd>The status of the import. If the status is not successful, it may be dangerous to extract information from the parameter. </dd></dl>
265
266<p>
267Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#c9dacd1e9af15e71f54daf59b3f142fd">FCDEffectParameter</a>.    </td>
268  </tr>
269</table>
270<a class="anchor" name="b12e01129144af7c5dc44316ea134752"></a><!-- doxytag: member="FCDEffectParameterBool::Overwrite" ref="b12e01129144af7c5dc44316ea134752" args="(FCDEffectParameter *target)" --><p>
271<table class="mdTable" cellpadding="2" cellspacing="0">
272  <tr>
273    <td class="mdRow">
274      <table cellpadding="0" cellspacing="0" border="0">
275        <tr>
276          <td class="md" nowrap valign="top">virtual void FCDEffectParameterBool::Overwrite           </td>
277          <td class="md" valign="top">(&nbsp;</td>
278          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect_parameter.html">FCDEffectParameter</a> *&nbsp;</td>
279          <td class="mdname1" valign="top" nowrap> <em>target</em>          </td>
280          <td class="md" valign="top">&nbsp;)&nbsp;</td>
281          <td class="md" nowrap><code> [virtual]</code></td>
282        </tr>
283      </table>
284    </td>
285  </tr>
286</table>
287<table cellspacing="5" cellpadding="0" border="0">
288  <tr>
289    <td>
290      &nbsp;
291    </td>
292    <td>
293
294<p>
295[INTERNAL] Overwrites the target parameter with this parameter.
296<p>
297This function is used during the flattening of materials. <dl compact><dt><b>Parameters:</b></dt><dd>
298  <table border="0" cellspacing="2" cellpadding="0">
299    <tr><td valign="top"></td><td valign="top"><em>target</em>&nbsp;</td><td>The target parameter to overwrite. </td></tr>
300  </table>
301</dl>
302
303<p>
304Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#016be91dbd27ff3c8c30f759f00b8c53">FCDEffectParameter</a>.    </td>
305  </tr>
306</table>
307<a class="anchor" name="eda6e4ec8451cf3df18bbd91c5c34cee"></a><!-- doxytag: member="FCDEffectParameterBool::SetValue" ref="eda6e4ec8451cf3df18bbd91c5c34cee" args="(bool _value)" --><p>
308<table class="mdTable" cellpadding="2" cellspacing="0">
309  <tr>
310    <td class="mdRow">
311      <table cellpadding="0" cellspacing="0" border="0">
312        <tr>
313          <td class="md" nowrap valign="top">void FCDEffectParameterBool::SetValue           </td>
314          <td class="md" valign="top">(&nbsp;</td>
315          <td class="md" nowrap valign="top">bool&nbsp;</td>
316          <td class="mdname1" valign="top" nowrap> <em>_value</em>          </td>
317          <td class="md" valign="top">&nbsp;)&nbsp;</td>
318          <td class="md" nowrap><code> [inline]</code></td>
319        </tr>
320      </table>
321    </td>
322  </tr>
323</table>
324<table cellspacing="5" cellpadding="0" border="0">
325  <tr>
326    <td>
327      &nbsp;
328    </td>
329    <td>
330
331<p>
332Sets the boolean value of the effect parameter.
333<p>
334<dl compact><dt><b>Parameters:</b></dt><dd>
335  <table border="0" cellspacing="2" cellpadding="0">
336    <tr><td valign="top"></td><td valign="top"><em>_value</em>&nbsp;</td><td>The boolean value. </td></tr>
337  </table>
338</dl>
339    </td>
340  </tr>
341</table>
342<a class="anchor" name="c177489519a1ec4f8ace8816da91f391"></a><!-- doxytag: member="FCDEffectParameterBool::WriteToXML" ref="c177489519a1ec4f8ace8816da91f391" args="(xmlNode *parentNode) const " --><p>
343<table class="mdTable" cellpadding="2" cellspacing="0">
344  <tr>
345    <td class="mdRow">
346      <table cellpadding="0" cellspacing="0" border="0">
347        <tr>
348          <td class="md" nowrap valign="top">virtual xmlNode* FCDEffectParameterBool::WriteToXML           </td>
349          <td class="md" valign="top">(&nbsp;</td>
350          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
351          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
352          <td class="md" valign="top">&nbsp;)&nbsp;</td>
353          <td class="md" nowrap> const<code> [virtual]</code></td>
354        </tr>
355      </table>
356    </td>
357  </tr>
358</table>
359<table cellspacing="5" cellpadding="0" border="0">
360  <tr>
361    <td>
362      &nbsp;
363    </td>
364    <td>
365
366<p>
367[INTERNAL] Writes out the effect parameter to the given COLLADA XML tree node.
368<p>
369<dl compact><dt><b>Parameters:</b></dt><dd>
370  <table border="0" cellspacing="2" cellpadding="0">
371    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the parameter. </td></tr>
372  </table>
373</dl>
374<dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl>
375
376<p>
377Reimplemented from <a class="el" href="class_f_c_d_effect_parameter.html#71aaa548d040bdae0af136f250262ea5">FCDEffectParameter</a>.    </td>
378  </tr>
379</table>
380<hr>The documentation for this class was generated from the following file:<ul>
381<li>FCDocument/<a class="el" href="_f_c_d_effect_parameter_8h-source.html">FCDEffectParameter.h</a></ul>
382<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by&nbsp;
383<a href="http://www.doxygen.org/index.html">
384<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
385</body>
386</html>
Note: See TracBrowser for help on using the repository browser.