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

Revision 964, 34.4 KB checked in by igarcia, 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>FCollada: FCDMaterialLibrary 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>FCDMaterialLibrary Class Reference<br>
25<small>
26[<a class="el" href="group___f_c_document.html">COLLADA Document Object Model.</a>]</small>
27</h1><!-- doxytag: class="FCDMaterialLibrary" --><!-- doxytag: inherits="FCDLibrary&lt; FCDEntity &gt;" -->The shared COLLADA material and effect libraries. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_material_library_8h-source.html">FCDMaterialLibrary.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDMaterialLibrary:
33<p><center><img src="class_f_c_d_material_library.png" usemap="#FCDMaterialLibrary_map" border="0" alt=""></center>
34<map name="FCDMaterialLibrary_map">
35<area href="class_f_c_d_library.html" alt="FCDLibrary< FCDEntity >" shape="rect" coords="0,0,160,24">
36</map>
37<a href="class_f_c_d_material_library-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
38<tr><td></td></tr>
39<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#44fb686de2557d45d22cb6a5ea6f068b">FCDMaterialLibrary</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor: do not use directly.  <a href="#44fb686de2557d45d22cb6a5ea6f068b"></a><br></td></tr>
43<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_material_library.html#bf65427e735bd4e7e104e1454ff33cef">~FCDMaterialLibrary</a> ()</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor: do not use directly.  <a href="#bf65427e735bd4e7e104e1454ff33cef"></a><br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDEffectList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#dd12ed61ccf5211887316f279b4a1345">GetEffects</a> ()</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of effects contained by this library.  <a href="#dd12ed61ccf5211887316f279b4a1345"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="307db4b777e6768524f1961ce00c1329"></a><!-- doxytag: member="FCDMaterialLibrary::GetEffects" ref="307db4b777e6768524f1961ce00c1329" args="() const " -->
50const <a class="el" href="classvector.html">FCDEffectList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#307db4b777e6768524f1961ce00c1329">GetEffects</a> () const </td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#4ba3f17366d1c4d8b53ec61af369b609">GetEffectCount</a> () const </td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of effects contained by this library.  <a href="#4ba3f17366d1c4d8b53ec61af369b609"></a><br></td></tr>
56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#b569c4c89b13ef94c7890487bb7ea3f9">GetEffect</a> (size_t index)</td></tr>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves an effect contained by this library.  <a href="#b569c4c89b13ef94c7890487bb7ea3f9"></a><br></td></tr>
59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="020920d777a7181ecab3c9039da7213d"></a><!-- doxytag: member="FCDMaterialLibrary::GetEffect" ref="020920d777a7181ecab3c9039da7213d" args="(size_t index) const " -->
60const <a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#020920d777a7181ecab3c9039da7213d">GetEffect</a> (size_t index) const </td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#4183a5fcd9a2f618cf93c376e791a691">FindEffect</a> (const string &amp;daeId)</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves an effect contained by this library.  <a href="#4183a5fcd9a2f618cf93c376e791a691"></a><br></td></tr>
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#186179dc841f965438e0da5b0971ab90">AddEffect</a> ()</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new effect.  <a href="#186179dc841f965438e0da5b0971ab90"></a><br></td></tr>
69<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_material_library.html#5ee1f0dcc0f4d05890e9609eb79bb6c7">ReleaseEffect</a> (<a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *effect)</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases an effect.  <a href="#5ee1f0dcc0f4d05890e9609eb79bb6c7"></a><br></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDMaterialList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#d7291297d19f57c0b113ce7972760d01">GetMaterials</a> ()</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the list of materials contained by this library.  <a href="#d7291297d19f57c0b113ce7972760d01"></a><br></td></tr>
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da3e757f4d9fb3c27466e2532bd0ced8"></a><!-- doxytag: member="FCDMaterialLibrary::GetMaterials" ref="da3e757f4d9fb3c27466e2532bd0ced8" args="() const " -->
76const <a class="el" href="classvector.html">FCDMaterialList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#da3e757f4d9fb3c27466e2532bd0ced8">GetMaterials</a> () const </td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#3b632eef3f70a5035c09c0219ad7d640">GetMaterialCount</a> () const </td></tr>
80
81<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the number of materials contained by this library.  <a href="#3b632eef3f70a5035c09c0219ad7d640"></a><br></td></tr>
82<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#54b2746b040a0061a25275d11e70589c">GetMaterial</a> (size_t index)</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a material contained by this library.  <a href="#54b2746b040a0061a25275d11e70589c"></a><br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="943e225f3e522f931ed6f812ddba097b"></a><!-- doxytag: member="FCDMaterialLibrary::GetMaterial" ref="943e225f3e522f931ed6f812ddba097b" args="(size_t index) const " -->
86const <a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#943e225f3e522f931ed6f812ddba097b">GetMaterial</a> (size_t index) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#ff9925d4e0b074f9d3bfd335406757a0">FindMaterial</a> (const string &amp;daeId)</td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves a material contained by this library.  <a href="#ff9925d4e0b074f9d3bfd335406757a0"></a><br></td></tr>
92<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_texture.html">FCDTexture</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#612cb40f05061f74fa7f19debe807a3b">FindTexture</a> (const string &amp;daeId)</td></tr>
93
94<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Retrieves a texture contained by this library.  <a href="#612cb40f05061f74fa7f19debe807a3b"></a><br></td></tr>
95<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_library.html#79eae716a86ccd4e74e02a71e2999b0d">AddMaterial</a> ()</td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new material.  <a href="#79eae716a86ccd4e74e02a71e2999b0d"></a><br></td></tr>
98<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_material_library.html#5b7691d0e9756fa41d0c37d2ead63f6c">ReleaseMaterial</a> (<a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *material)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Releases a material.  <a href="#5b7691d0e9756fa41d0c37d2ead63f6c"></a><br></td></tr>
101<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_material_library.html#f2ec5534ec180d596641d32b37754283">LoadFromXML</a> (xmlNode *node)</td></tr>
102
103<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Reads in the contents of the library from the COLLADA XML document.  <a href="#f2ec5534ec180d596641d32b37754283"></a><br></td></tr>
104<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_material_library.html#766ef8ca3c872cc24f6c21dedcf0d1f9">WriteToXML</a> (xmlNode *libraryNode) const </td></tr>
105
106<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the library entities to the COLLADA XML document.  <a href="#766ef8ca3c872cc24f6c21dedcf0d1f9"></a><br></td></tr>
107</table>
108<hr><a name="_details"></a><h2>Detailed Description</h2>
109The shared COLLADA material and effect libraries.
110<p>
111This class covers the material and effect libraries, as well as the texture library for COLLADA 1.3 backward compatibility.<p>
112<dl compact><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>When information push is fully implemented: split the effect library out of this one.</dd></dl>
113
114<p>
115<hr><h2>Constructor &amp; Destructor Documentation</h2>
116<a class="anchor" name="44fb686de2557d45d22cb6a5ea6f068b"></a><!-- doxytag: member="FCDMaterialLibrary::FCDMaterialLibrary" ref="44fb686de2557d45d22cb6a5ea6f068b" args="(FCDocument *document)" --><p>
117<table class="mdTable" cellpadding="2" cellspacing="0">
118  <tr>
119    <td class="mdRow">
120      <table cellpadding="0" cellspacing="0" border="0">
121        <tr>
122          <td class="md" nowrap valign="top">FCDMaterialLibrary::FCDMaterialLibrary           </td>
123          <td class="md" valign="top">(&nbsp;</td>
124          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> *&nbsp;</td>
125          <td class="mdname1" valign="top" nowrap> <em>document</em>          </td>
126          <td class="md" valign="top">&nbsp;)&nbsp;</td>
127          <td class="md" nowrap></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>
141Constructor: do not use directly.
142<p>
143The document object will create the one and only object of this class. <dl compact><dt><b>Parameters:</b></dt><dd>
144  <table border="0" cellspacing="2" cellpadding="0">
145    <tr><td valign="top"></td><td valign="top"><em>document</em>&nbsp;</td><td>The COLLADA document that owns this library. </td></tr>
146  </table>
147</dl>
148    </td>
149  </tr>
150</table>
151<a class="anchor" name="bf65427e735bd4e7e104e1454ff33cef"></a><!-- doxytag: member="FCDMaterialLibrary::~FCDMaterialLibrary" ref="bf65427e735bd4e7e104e1454ff33cef" args="()" --><p>
152<table class="mdTable" cellpadding="2" cellspacing="0">
153  <tr>
154    <td class="mdRow">
155      <table cellpadding="0" cellspacing="0" border="0">
156        <tr>
157          <td class="md" nowrap valign="top">virtual FCDMaterialLibrary::~FCDMaterialLibrary           </td>
158          <td class="md" valign="top">(&nbsp;</td>
159          <td class="mdname1" valign="top" nowrap>          </td>
160          <td class="md" valign="top">&nbsp;)&nbsp;</td>
161          <td class="md" nowrap><code> [virtual]</code></td>
162        </tr>
163      </table>
164    </td>
165  </tr>
166</table>
167<table cellspacing="5" cellpadding="0" border="0">
168  <tr>
169    <td>
170      &nbsp;
171    </td>
172    <td>
173
174<p>
175Destructor: do not use directly.
176<p>
177The document object will release its libraries.     </td>
178  </tr>
179</table>
180<hr><h2>Member Function Documentation</h2>
181<a class="anchor" name="186179dc841f965438e0da5b0971ab90"></a><!-- doxytag: member="FCDMaterialLibrary::AddEffect" ref="186179dc841f965438e0da5b0971ab90" args="()" --><p>
182<table class="mdTable" cellpadding="2" cellspacing="0">
183  <tr>
184    <td class="mdRow">
185      <table cellpadding="0" cellspacing="0" border="0">
186        <tr>
187          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a>* FCDMaterialLibrary::AddEffect           </td>
188          <td class="md" valign="top">(&nbsp;</td>
189          <td class="mdname1" valign="top" nowrap>          </td>
190          <td class="md" valign="top">&nbsp;)&nbsp;</td>
191          <td class="md" nowrap></td>
192        </tr>
193      </table>
194    </td>
195  </tr>
196</table>
197<table cellspacing="5" cellpadding="0" border="0">
198  <tr>
199    <td>
200      &nbsp;
201    </td>
202    <td>
203
204<p>
205Creates a new effect.
206<p>
207<dl compact><dt><b>Returns:</b></dt><dd>The newly created effect. </dd></dl>
208    </td>
209  </tr>
210</table>
211<a class="anchor" name="79eae716a86ccd4e74e02a71e2999b0d"></a><!-- doxytag: member="FCDMaterialLibrary::AddMaterial" ref="79eae716a86ccd4e74e02a71e2999b0d" args="()" --><p>
212<table class="mdTable" cellpadding="2" cellspacing="0">
213  <tr>
214    <td class="mdRow">
215      <table cellpadding="0" cellspacing="0" border="0">
216        <tr>
217          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a>* FCDMaterialLibrary::AddMaterial           </td>
218          <td class="md" valign="top">(&nbsp;</td>
219          <td class="mdname1" valign="top" nowrap>          </td>
220          <td class="md" valign="top">&nbsp;)&nbsp;</td>
221          <td class="md" nowrap></td>
222        </tr>
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing="5" cellpadding="0" border="0">
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235Creates a new material.
236<p>
237<dl compact><dt><b>Returns:</b></dt><dd>The newly created material. </dd></dl>
238    </td>
239  </tr>
240</table>
241<a class="anchor" name="4183a5fcd9a2f618cf93c376e791a691"></a><!-- doxytag: member="FCDMaterialLibrary::FindEffect" ref="4183a5fcd9a2f618cf93c376e791a691" args="(const string &amp;daeId)" --><p>
242<table class="mdTable" cellpadding="2" cellspacing="0">
243  <tr>
244    <td class="mdRow">
245      <table cellpadding="0" cellspacing="0" border="0">
246        <tr>
247          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a>* FCDMaterialLibrary::FindEffect           </td>
248          <td class="md" valign="top">(&nbsp;</td>
249          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
250          <td class="mdname1" valign="top" nowrap> <em>daeId</em>          </td>
251          <td class="md" valign="top">&nbsp;)&nbsp;</td>
252          <td class="md" nowrap></td>
253        </tr>
254      </table>
255    </td>
256  </tr>
257</table>
258<table cellspacing="5" cellpadding="0" border="0">
259  <tr>
260    <td>
261      &nbsp;
262    </td>
263    <td>
264
265<p>
266[INTERNAL] Retrieves an effect contained by this library.
267<p>
268<dl compact><dt><b>Parameters:</b></dt><dd>
269  <table border="0" cellspacing="2" cellpadding="0">
270    <tr><td valign="top"></td><td valign="top"><em>daeId</em>&nbsp;</td><td>The COLLADA id of the effect. </td></tr>
271  </table>
272</dl>
273<dl compact><dt><b>Returns:</b></dt><dd>The matching effect. This pointer will be NULL if no effect matches the COLLADA id. </dd></dl>
274    </td>
275  </tr>
276</table>
277<a class="anchor" name="ff9925d4e0b074f9d3bfd335406757a0"></a><!-- doxytag: member="FCDMaterialLibrary::FindMaterial" ref="ff9925d4e0b074f9d3bfd335406757a0" args="(const string &amp;daeId)" --><p>
278<table class="mdTable" cellpadding="2" cellspacing="0">
279  <tr>
280    <td class="mdRow">
281      <table cellpadding="0" cellspacing="0" border="0">
282        <tr>
283          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a>* FCDMaterialLibrary::FindMaterial           </td>
284          <td class="md" valign="top">(&nbsp;</td>
285          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
286          <td class="mdname1" valign="top" nowrap> <em>daeId</em>          </td>
287          <td class="md" valign="top">&nbsp;)&nbsp;</td>
288          <td class="md" nowrap></td>
289        </tr>
290      </table>
291    </td>
292  </tr>
293</table>
294<table cellspacing="5" cellpadding="0" border="0">
295  <tr>
296    <td>
297      &nbsp;
298    </td>
299    <td>
300
301<p>
302[INTERNAL] Retrieves a material contained by this library.
303<p>
304<dl compact><dt><b>Parameters:</b></dt><dd>
305  <table border="0" cellspacing="2" cellpadding="0">
306    <tr><td valign="top"></td><td valign="top"><em>daeId</em>&nbsp;</td><td>The COLLADA id of the material. </td></tr>
307  </table>
308</dl>
309<dl compact><dt><b>Returns:</b></dt><dd>The matching material. This pointer will be NULL if no material matches the COLLADA id. </dd></dl>
310    </td>
311  </tr>
312</table>
313<a class="anchor" name="612cb40f05061f74fa7f19debe807a3b"></a><!-- doxytag: member="FCDMaterialLibrary::FindTexture" ref="612cb40f05061f74fa7f19debe807a3b" args="(const string &amp;daeId)" --><p>
314<table class="mdTable" cellpadding="2" cellspacing="0">
315  <tr>
316    <td class="mdRow">
317      <table cellpadding="0" cellspacing="0" border="0">
318        <tr>
319          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_texture.html">FCDTexture</a>* FCDMaterialLibrary::FindTexture           </td>
320          <td class="md" valign="top">(&nbsp;</td>
321          <td class="md" nowrap valign="top">const string &amp;&nbsp;</td>
322          <td class="mdname1" valign="top" nowrap> <em>daeId</em>          </td>
323          <td class="md" valign="top">&nbsp;)&nbsp;</td>
324          <td class="md" nowrap></td>
325        </tr>
326      </table>
327    </td>
328  </tr>
329</table>
330<table cellspacing="5" cellpadding="0" border="0">
331  <tr>
332    <td>
333      &nbsp;
334    </td>
335    <td>
336
337<p>
338[INTERNAL] Retrieves a texture contained by this library.
339<p>
340<dl compact><dt><b>Parameters:</b></dt><dd>
341  <table border="0" cellspacing="2" cellpadding="0">
342    <tr><td valign="top"></td><td valign="top"><em>daeId</em>&nbsp;</td><td>The COLLADA id of the texture. </td></tr>
343  </table>
344</dl>
345<dl compact><dt><b>Returns:</b></dt><dd>The matching texture. This pointer will be NULL if no texture matches the COLLADA id. </dd></dl>
346    </td>
347  </tr>
348</table>
349<a class="anchor" name="b569c4c89b13ef94c7890487bb7ea3f9"></a><!-- doxytag: member="FCDMaterialLibrary::GetEffect" ref="b569c4c89b13ef94c7890487bb7ea3f9" args="(size_t index)" --><p>
350<table class="mdTable" cellpadding="2" cellspacing="0">
351  <tr>
352    <td class="mdRow">
353      <table cellpadding="0" cellspacing="0" border="0">
354        <tr>
355          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a>* FCDMaterialLibrary::GetEffect           </td>
356          <td class="md" valign="top">(&nbsp;</td>
357          <td class="md" nowrap valign="top">size_t&nbsp;</td>
358          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
359          <td class="md" valign="top">&nbsp;)&nbsp;</td>
360          <td class="md" nowrap><code> [inline]</code></td>
361        </tr>
362      </table>
363    </td>
364  </tr>
365</table>
366<table cellspacing="5" cellpadding="0" border="0">
367  <tr>
368    <td>
369      &nbsp;
370    </td>
371    <td>
372
373<p>
374Retrieves an effect contained by this library.
375<p>
376<dl compact><dt><b>Parameters:</b></dt><dd>
377  <table border="0" cellspacing="2" cellpadding="0">
378    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the effect. </td></tr>
379  </table>
380</dl>
381<dl compact><dt><b>Returns:</b></dt><dd>The given effect. This pointer will be NULL if no effect matches the index. </dd></dl>
382    </td>
383  </tr>
384</table>
385<a class="anchor" name="4ba3f17366d1c4d8b53ec61af369b609"></a><!-- doxytag: member="FCDMaterialLibrary::GetEffectCount" ref="4ba3f17366d1c4d8b53ec61af369b609" args="() const " --><p>
386<table class="mdTable" cellpadding="2" cellspacing="0">
387  <tr>
388    <td class="mdRow">
389      <table cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td class="md" nowrap valign="top">size_t FCDMaterialLibrary::GetEffectCount           </td>
392          <td class="md" valign="top">(&nbsp;</td>
393          <td class="mdname1" valign="top" nowrap>          </td>
394          <td class="md" valign="top">&nbsp;)&nbsp;</td>
395          <td class="md" nowrap> const<code> [inline]</code></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>
409Retrieves the number of effects contained by this library.
410<p>
411<dl compact><dt><b>Returns:</b></dt><dd>The number of effects within the library. </dd></dl>
412    </td>
413  </tr>
414</table>
415<a class="anchor" name="dd12ed61ccf5211887316f279b4a1345"></a><!-- doxytag: member="FCDMaterialLibrary::GetEffects" ref="dd12ed61ccf5211887316f279b4a1345" args="()" --><p>
416<table class="mdTable" cellpadding="2" cellspacing="0">
417  <tr>
418    <td class="mdRow">
419      <table cellpadding="0" cellspacing="0" border="0">
420        <tr>
421          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDEffectList</a>&amp; FCDMaterialLibrary::GetEffects           </td>
422          <td class="md" valign="top">(&nbsp;</td>
423          <td class="mdname1" valign="top" nowrap>          </td>
424          <td class="md" valign="top">&nbsp;)&nbsp;</td>
425          <td class="md" nowrap><code> [inline]</code></td>
426        </tr>
427      </table>
428    </td>
429  </tr>
430</table>
431<table cellspacing="5" cellpadding="0" border="0">
432  <tr>
433    <td>
434      &nbsp;
435    </td>
436    <td>
437
438<p>
439Retrieves the list of effects contained by this library.
440<p>
441<dl compact><dt><b>Returns:</b></dt><dd>The list of effects. </dd></dl>
442    </td>
443  </tr>
444</table>
445<a class="anchor" name="54b2746b040a0061a25275d11e70589c"></a><!-- doxytag: member="FCDMaterialLibrary::GetMaterial" ref="54b2746b040a0061a25275d11e70589c" args="(size_t index)" --><p>
446<table class="mdTable" cellpadding="2" cellspacing="0">
447  <tr>
448    <td class="mdRow">
449      <table cellpadding="0" cellspacing="0" border="0">
450        <tr>
451          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a>* FCDMaterialLibrary::GetMaterial           </td>
452          <td class="md" valign="top">(&nbsp;</td>
453          <td class="md" nowrap valign="top">size_t&nbsp;</td>
454          <td class="mdname1" valign="top" nowrap> <em>index</em>          </td>
455          <td class="md" valign="top">&nbsp;)&nbsp;</td>
456          <td class="md" nowrap><code> [inline]</code></td>
457        </tr>
458      </table>
459    </td>
460  </tr>
461</table>
462<table cellspacing="5" cellpadding="0" border="0">
463  <tr>
464    <td>
465      &nbsp;
466    </td>
467    <td>
468
469<p>
470Retrieves a material contained by this library.
471<p>
472<dl compact><dt><b>Parameters:</b></dt><dd>
473  <table border="0" cellspacing="2" cellpadding="0">
474    <tr><td valign="top"></td><td valign="top"><em>index</em>&nbsp;</td><td>The index of the material. </td></tr>
475  </table>
476</dl>
477<dl compact><dt><b>Returns:</b></dt><dd>The given material. This pointer will be NULL if no material matches the index. </dd></dl>
478    </td>
479  </tr>
480</table>
481<a class="anchor" name="3b632eef3f70a5035c09c0219ad7d640"></a><!-- doxytag: member="FCDMaterialLibrary::GetMaterialCount" ref="3b632eef3f70a5035c09c0219ad7d640" args="() const " --><p>
482<table class="mdTable" cellpadding="2" cellspacing="0">
483  <tr>
484    <td class="mdRow">
485      <table cellpadding="0" cellspacing="0" border="0">
486        <tr>
487          <td class="md" nowrap valign="top">size_t FCDMaterialLibrary::GetMaterialCount           </td>
488          <td class="md" valign="top">(&nbsp;</td>
489          <td class="mdname1" valign="top" nowrap>          </td>
490          <td class="md" valign="top">&nbsp;)&nbsp;</td>
491          <td class="md" nowrap> const<code> [inline]</code></td>
492        </tr>
493      </table>
494    </td>
495  </tr>
496</table>
497<table cellspacing="5" cellpadding="0" border="0">
498  <tr>
499    <td>
500      &nbsp;
501    </td>
502    <td>
503
504<p>
505Retrieves the number of materials contained by this library.
506<p>
507<dl compact><dt><b>Returns:</b></dt><dd>The number of materials within the library. </dd></dl>
508    </td>
509  </tr>
510</table>
511<a class="anchor" name="d7291297d19f57c0b113ce7972760d01"></a><!-- doxytag: member="FCDMaterialLibrary::GetMaterials" ref="d7291297d19f57c0b113ce7972760d01" args="()" --><p>
512<table class="mdTable" cellpadding="2" cellspacing="0">
513  <tr>
514    <td class="mdRow">
515      <table cellpadding="0" cellspacing="0" border="0">
516        <tr>
517          <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDMaterialList</a>&amp; FCDMaterialLibrary::GetMaterials           </td>
518          <td class="md" valign="top">(&nbsp;</td>
519          <td class="mdname1" valign="top" nowrap>          </td>
520          <td class="md" valign="top">&nbsp;)&nbsp;</td>
521          <td class="md" nowrap><code> [inline]</code></td>
522        </tr>
523      </table>
524    </td>
525  </tr>
526</table>
527<table cellspacing="5" cellpadding="0" border="0">
528  <tr>
529    <td>
530      &nbsp;
531    </td>
532    <td>
533
534<p>
535Retrieves the list of materials contained by this library.
536<p>
537<dl compact><dt><b>Returns:</b></dt><dd>The list of materials. </dd></dl>
538    </td>
539  </tr>
540</table>
541<a class="anchor" name="f2ec5534ec180d596641d32b37754283"></a><!-- doxytag: member="FCDMaterialLibrary::LoadFromXML" ref="f2ec5534ec180d596641d32b37754283" args="(xmlNode *node)" --><p>
542<table class="mdTable" cellpadding="2" cellspacing="0">
543  <tr>
544    <td class="mdRow">
545      <table cellpadding="0" cellspacing="0" border="0">
546        <tr>
547          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDMaterialLibrary::LoadFromXML           </td>
548          <td class="md" valign="top">(&nbsp;</td>
549          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
550          <td class="mdname1" valign="top" nowrap> <em>node</em>          </td>
551          <td class="md" valign="top">&nbsp;)&nbsp;</td>
552          <td class="md" nowrap><code> [virtual]</code></td>
553        </tr>
554      </table>
555    </td>
556  </tr>
557</table>
558<table cellspacing="5" cellpadding="0" border="0">
559  <tr>
560    <td>
561      &nbsp;
562    </td>
563    <td>
564
565<p>
566[INTERNAL] Reads in the contents of the library from the COLLADA XML document.
567<p>
568This method will be called once for the effect library and once for the material library. It may also be called once, for COLLADA 1.3 backward compatibility, for the texture library. <dl compact><dt><b>Parameters:</b></dt><dd>
569  <table border="0" cellspacing="2" cellpadding="0">
570    <tr><td valign="top"></td><td valign="top"><em>node</em>&nbsp;</td><td>The COLLADA XML tree node to parse into entities. </td></tr>
571  </table>
572</dl>
573<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 library. </dd></dl>
574
575<p>
576Reimplemented from <a class="el" href="class_f_c_d_library.html#813347c0e988c025235eaeaf12400d1a">FCDLibrary&lt; FCDEntity &gt;</a>.    </td>
577  </tr>
578</table>
579<a class="anchor" name="5ee1f0dcc0f4d05890e9609eb79bb6c7"></a><!-- doxytag: member="FCDMaterialLibrary::ReleaseEffect" ref="5ee1f0dcc0f4d05890e9609eb79bb6c7" args="(FCDEffect *effect)" --><p>
580<table class="mdTable" cellpadding="2" cellspacing="0">
581  <tr>
582    <td class="mdRow">
583      <table cellpadding="0" cellspacing="0" border="0">
584        <tr>
585          <td class="md" nowrap valign="top">void FCDMaterialLibrary::ReleaseEffect           </td>
586          <td class="md" valign="top">(&nbsp;</td>
587          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_effect.html">FCDEffect</a> *&nbsp;</td>
588          <td class="mdname1" valign="top" nowrap> <em>effect</em>          </td>
589          <td class="md" valign="top">&nbsp;)&nbsp;</td>
590          <td class="md" nowrap></td>
591        </tr>
592      </table>
593    </td>
594  </tr>
595</table>
596<table cellspacing="5" cellpadding="0" border="0">
597  <tr>
598    <td>
599      &nbsp;
600    </td>
601    <td>
602
603<p>
604Releases an effect.
605<p>
606<dl compact><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>Implement <a class="el" href="class_f_c_d_material_library.html#5ee1f0dcc0f4d05890e9609eb79bb6c7">FCDMaterialLibrary::ReleaseEffect</a>. </dd></dl>
607<dl compact><dt><b>Parameters:</b></dt><dd>
608  <table border="0" cellspacing="2" cellpadding="0">
609    <tr><td valign="top"></td><td valign="top"><em>effect</em>&nbsp;</td><td>The effect to release. </td></tr>
610  </table>
611</dl>
612    </td>
613  </tr>
614</table>
615<a class="anchor" name="5b7691d0e9756fa41d0c37d2ead63f6c"></a><!-- doxytag: member="FCDMaterialLibrary::ReleaseMaterial" ref="5b7691d0e9756fa41d0c37d2ead63f6c" args="(FCDMaterial *material)" --><p>
616<table class="mdTable" cellpadding="2" cellspacing="0">
617  <tr>
618    <td class="mdRow">
619      <table cellpadding="0" cellspacing="0" border="0">
620        <tr>
621          <td class="md" nowrap valign="top">void FCDMaterialLibrary::ReleaseMaterial           </td>
622          <td class="md" valign="top">(&nbsp;</td>
623          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *&nbsp;</td>
624          <td class="mdname1" valign="top" nowrap> <em>material</em>          </td>
625          <td class="md" valign="top">&nbsp;)&nbsp;</td>
626          <td class="md" nowrap></td>
627        </tr>
628      </table>
629    </td>
630  </tr>
631</table>
632<table cellspacing="5" cellpadding="0" border="0">
633  <tr>
634    <td>
635      &nbsp;
636    </td>
637    <td>
638
639<p>
640Releases a material.
641<p>
642<dl compact><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>Implement <a class="el" href="class_f_c_d_material_library.html#5b7691d0e9756fa41d0c37d2ead63f6c">FCDMaterialLibrary::ReleaseMaterial</a>. </dd></dl>
643<dl compact><dt><b>Parameters:</b></dt><dd>
644  <table border="0" cellspacing="2" cellpadding="0">
645    <tr><td valign="top"></td><td valign="top"><em>material</em>&nbsp;</td><td>The material to release. </td></tr>
646  </table>
647</dl>
648    </td>
649  </tr>
650</table>
651<a class="anchor" name="766ef8ca3c872cc24f6c21dedcf0d1f9"></a><!-- doxytag: member="FCDMaterialLibrary::WriteToXML" ref="766ef8ca3c872cc24f6c21dedcf0d1f9" args="(xmlNode *libraryNode) const " --><p>
652<table class="mdTable" cellpadding="2" cellspacing="0">
653  <tr>
654    <td class="mdRow">
655      <table cellpadding="0" cellspacing="0" border="0">
656        <tr>
657          <td class="md" nowrap valign="top">virtual void FCDMaterialLibrary::WriteToXML           </td>
658          <td class="md" valign="top">(&nbsp;</td>
659          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
660          <td class="mdname1" valign="top" nowrap> <em>libraryNode</em>          </td>
661          <td class="md" valign="top">&nbsp;)&nbsp;</td>
662          <td class="md" nowrap> const<code> [virtual]</code></td>
663        </tr>
664      </table>
665    </td>
666  </tr>
667</table>
668<table cellspacing="5" cellpadding="0" border="0">
669  <tr>
670    <td>
671      &nbsp;
672    </td>
673    <td>
674
675<p>
676[INTERNAL] Writes out the library entities to the COLLADA XML document.
677<p>
678This method writes out the material library within the given node and writes out the effect library as a sibling node to the given node. <dl compact><dt><b>Parameters:</b></dt><dd>
679  <table border="0" cellspacing="2" cellpadding="0">
680    <tr><td valign="top"></td><td valign="top"><em>libraryNode</em>&nbsp;</td><td>The COLLADA XML tree node in which to write the materials. </td></tr>
681  </table>
682</dl>
683
684<p>
685Reimplemented from <a class="el" href="class_f_c_d_library.html#297ebf05ef14830be557ddf57909471f">FCDLibrary&lt; FCDEntity &gt;</a>.    </td>
686  </tr>
687</table>
688<hr>The documentation for this class was generated from the following file:<ul>
689<li>FCDocument/<a class="el" href="_f_c_d_material_library_8h-source.html">FCDMaterialLibrary.h</a></ul>
690<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by&nbsp;
691<a href="http://www.doxygen.org/index.html">
692<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
693</body>
694</html>
Note: See TracBrowser for help on using the repository browser.