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

Revision 964, 16.7 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: FCDMaterialInstance 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>FCDMaterialInstance 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="FCDMaterialInstance" --><!-- doxytag: inherits="FCDEntityInstance" -->A COLLADA material instance. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_c_d_material_instance_8h-source.html">FCDMaterialInstance.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FCDMaterialInstance:
33<p><center><img src="class_f_c_d_material_instance.png" usemap="#FCDMaterialInstance_map" border="0" alt=""></center>
34<map name="FCDMaterialInstance_map">
35<area href="class_f_c_d_entity_instance.html" alt="FCDEntityInstance" shape="rect" coords="0,112,131,136">
36<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,131,80">
37<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,131,24">
38</map>
39<a href="class_f_c_d_material_instance-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4040c201d4551cc8db7d031aefbbc34"></a><!-- doxytag: member="FCDMaterialInstance::FCDMaterialInstance" ref="d4040c201d4551cc8db7d031aefbbc34" args="(FCDocument *document, FCDGeometryInstance *parent)" -->
43&nbsp;</td><td class="memItemRight" valign="bottom"><b>FCDMaterialInstance</b> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_c_d_geometry_instance.html">FCDGeometryInstance</a> *parent)</td></tr>
44
45<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_instance.html#ac2d768573a02ba8a55a329a6d4b39e3">GetType</a> () const </td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the entity instance class type.  <a href="#ac2d768573a02ba8a55a329a6d4b39e3"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fb39d26ab1e0eaedcedb9ec7be0ba492"></a><!-- doxytag: member="FCDMaterialInstance::GetSemantic" ref="fb39d26ab1e0eaedcedb9ec7be0ba492" args="() const " -->
49const fstring &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetSemantic</b> () const </td></tr>
50
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8b74872facbef6ce4de3c3eea3ed524a"></a><!-- doxytag: member="FCDMaterialInstance::SetSemantic" ref="8b74872facbef6ce4de3c3eea3ed524a" args="(const fchar *_semantic)" -->
52void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetSemantic</b> (const fchar *_semantic)</td></tr>
53
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7a1930462c50ff340e40f60fc1642ebd"></a><!-- doxytag: member="FCDMaterialInstance::SetSemantic" ref="7a1930462c50ff340e40f60fc1642ebd" args="(const fstring &amp;_semantic)" -->
55void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetSemantic</b> (const fstring &amp;_semantic)</td></tr>
56
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="190f2bb81d391892a0edc501c682bba7"></a><!-- doxytag: member="FCDMaterialInstance::GetMaterial" ref="190f2bb81d391892a0edc501c682bba7" args="()" -->
58<a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMaterial</b> ()</td></tr>
59
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8dd52145748ea4424bd6d5ce67ce4110"></a><!-- doxytag: member="FCDMaterialInstance::GetMaterial" ref="8dd52145748ea4424bd6d5ce67ce4110" args="() const " -->
61const <a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMaterial</b> () const </td></tr>
62
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="de599811f26176190f8174d50bacb2b7"></a><!-- doxytag: member="FCDMaterialInstance::SetMaterial" ref="de599811f26176190f8174d50bacb2b7" args="(FCDMaterial *_material)" -->
64void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetMaterial</b> (<a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *_material)</td></tr>
65
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e3404040705046faa4f8bf1c4475a460"></a><!-- doxytag: member="FCDMaterialInstance::GetBindings" ref="e3404040705046faa4f8bf1c4475a460" args="()" -->
67<a class="el" href="classvector.html">FCDMaterialInstanceBindList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetBindings</b> ()</td></tr>
68
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9ab4ff2df3c4fcece387b2b23727381"></a><!-- doxytag: member="FCDMaterialInstance::GetBindings" ref="a9ab4ff2df3c4fcece387b2b23727381" args="() const " -->
70const <a class="el" href="classvector.html">FCDMaterialInstanceBindList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetBindings</b> () const </td></tr>
71
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ad2749897b63b5ccb090dc2f3e2b6b95"></a><!-- doxytag: member="FCDMaterialInstance::GetBindingCount" ref="ad2749897b63b5ccb090dc2f3e2b6b95" args="() const " -->
73size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetBindingCount</b> () const </td></tr>
74
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b1e047084ed5191337e369733b74641"></a><!-- doxytag: member="FCDMaterialInstance::GetBinding" ref="2b1e047084ed5191337e369733b74641" args="(size_t index)" -->
76<a class="el" href="class_f_c_d_material_instance_bind.html">FCDMaterialInstanceBind</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetBinding</b> (size_t index)</td></tr>
77
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8adfe57c81d757c46d1598f782079090"></a><!-- doxytag: member="FCDMaterialInstance::GetBinding" ref="8adfe57c81d757c46d1598f782079090" args="(size_t index) const " -->
79const <a class="el" href="class_f_c_d_material_instance_bind.html">FCDMaterialInstanceBind</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetBinding</b> (size_t index) const </td></tr>
80
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="69466671603dc8364edf0ed036453ab7"></a><!-- doxytag: member="FCDMaterialInstance::AddBinding" ref="69466671603dc8364edf0ed036453ab7" args="()" -->
82<a class="el" href="class_f_c_d_material_instance_bind.html">FCDMaterialInstanceBind</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddBinding</b> ()</td></tr>
83
84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05555541d878bc03b8fde4edfc5f3d4e"></a><!-- doxytag: member="FCDMaterialInstance::AddBinding" ref="05555541d878bc03b8fde4edfc5f3d4e" args="(const char *semantic, const char *target)" -->
85<a class="el" href="class_f_c_d_material_instance_bind.html">FCDMaterialInstanceBind</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddBinding</b> (const char *semantic, const char *target)</td></tr>
86
87<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e056e05e664db2253c5bc4364edc73d9"></a><!-- doxytag: member="FCDMaterialInstance::AddBinding" ref="e056e05e664db2253c5bc4364edc73d9" args="(const string &amp;semantic, const char *target)" -->
88<a class="el" href="class_f_c_d_material_instance_bind.html">FCDMaterialInstanceBind</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddBinding</b> (const string &amp;semantic, const char *target)</td></tr>
89
90<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="83639ded25f916169657e7c86ccbab9f"></a><!-- doxytag: member="FCDMaterialInstance::AddBinding" ref="83639ded25f916169657e7c86ccbab9f" args="(const char *semantic, const string &amp;target)" -->
91<a class="el" href="class_f_c_d_material_instance_bind.html">FCDMaterialInstanceBind</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddBinding</b> (const char *semantic, const string &amp;target)</td></tr>
92
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43e8b409a3a9e8398e2e40fc8d125ea0"></a><!-- doxytag: member="FCDMaterialInstance::AddBinding" ref="43e8b409a3a9e8398e2e40fc8d125ea0" args="(const string &amp;semantic, const string &amp;target)" -->
94<a class="el" href="class_f_c_d_material_instance_bind.html">FCDMaterialInstanceBind</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddBinding</b> (const string &amp;semantic, const string &amp;target)</td></tr>
95
96<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da8c95697d37ba4b215366dd3dc027a3"></a><!-- doxytag: member="FCDMaterialInstance::ReleaseBinding" ref="da8c95697d37ba4b215366dd3dc027a3" args="(size_t index)" -->
97void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ReleaseBinding</b> (size_t index)</td></tr>
98
99<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_instance.html#58182994223d2cbc81d90b1dab289239">FlattenMaterial</a> ()</td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a flattened version of the instantiated material.  <a href="#58182994223d2cbc81d90b1dab289239"></a><br></td></tr>
102<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73ad5a709f1bd02dc34aae400f093ade"></a><!-- doxytag: member="FCDMaterialInstance::LoadFromXML" ref="73ad5a709f1bd02dc34aae400f093ade" args="(xmlNode *instanceNode)" -->
103virtual <a class="el" href="class_f_u_status.html">FUStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>LoadFromXML</b> (xmlNode *instanceNode)</td></tr>
104
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e45aec6c613298af22de6327ae374573"></a><!-- doxytag: member="FCDMaterialInstance::LoadFromId" ref="e45aec6c613298af22de6327ae374573" args="(const string &amp;materialId)" -->
106<a class="el" href="class_f_u_status.html">FUStatus</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>LoadFromId</b> (const string &amp;materialId)</td></tr>
107
108<tr><td class="memItemLeft" nowrap align="right" valign="top">xmlNode *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_material_instance.html#6ada9494530e83b0d70ac99cf2a8f5ed">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node.  <a href="#6ada9494530e83b0d70ac99cf2a8f5ed"></a><br></td></tr>
111</table>
112<hr><a name="_details"></a><h2>Detailed Description</h2>
113A COLLADA material instance.
114<p>
115A material instance is used to given polygon sets with a COLLADA material entity. It is also used to bind data sources with the inputs of an effect.
116<p>
117<hr><h2>Member Function Documentation</h2>
118<a class="anchor" name="58182994223d2cbc81d90b1dab289239"></a><!-- doxytag: member="FCDMaterialInstance::FlattenMaterial" ref="58182994223d2cbc81d90b1dab289239" args="()" --><p>
119<table class="mdTable" cellpadding="2" cellspacing="0">
120  <tr>
121    <td class="mdRow">
122      <table cellpadding="0" cellspacing="0" border="0">
123        <tr>
124          <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_material.html">FCDMaterial</a>* FCDMaterialInstance::FlattenMaterial           </td>
125          <td class="md" valign="top">(&nbsp;</td>
126          <td class="mdname1" valign="top" nowrap>          </td>
127          <td class="md" valign="top">&nbsp;)&nbsp;</td>
128          <td class="md" nowrap></td>
129        </tr>
130      </table>
131    </td>
132  </tr>
133</table>
134<table cellspacing="5" cellpadding="0" border="0">
135  <tr>
136    <td>
137      &nbsp;
138    </td>
139    <td>
140
141<p>
142Creates a flattened version of the instantiated material.
143<p>
144This is the prefered way to generate viewer materials from a COLLADA document. <dl compact><dt><b>Returns:</b></dt><dd>The flattened version of the instantiated material. You will need to delete this pointer manually. This pointer will be NULL when there is no material attached to this instance. </dd></dl>
145    </td>
146  </tr>
147</table>
148<a class="anchor" name="ac2d768573a02ba8a55a329a6d4b39e3"></a><!-- doxytag: member="FCDMaterialInstance::GetType" ref="ac2d768573a02ba8a55a329a6d4b39e3" args="() const " --><p>
149<table class="mdTable" cellpadding="2" cellspacing="0">
150  <tr>
151    <td class="mdRow">
152      <table cellpadding="0" cellspacing="0" border="0">
153        <tr>
154          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">Type</a> FCDMaterialInstance::GetType           </td>
155          <td class="md" valign="top">(&nbsp;</td>
156          <td class="mdname1" valign="top" nowrap>          </td>
157          <td class="md" valign="top">&nbsp;)&nbsp;</td>
158          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
159        </tr>
160      </table>
161    </td>
162  </tr>
163</table>
164<table cellspacing="5" cellpadding="0" border="0">
165  <tr>
166    <td>
167      &nbsp;
168    </td>
169    <td>
170
171<p>
172Retrieves the entity instance class type.
173<p>
174This is used to determine the up-class for the entity instance object. <dl compact><dt><b>Returns:</b></dt><dd>The class type: SIMPLE for entity instances with no up-class. </dd></dl>
175
176<p>
177Reimplemented from <a class="el" href="class_f_c_d_entity_instance.html#773c2cfdbad937e93da7a3fa71a671a7">FCDEntityInstance</a>.    </td>
178  </tr>
179</table>
180<a class="anchor" name="6ada9494530e83b0d70ac99cf2a8f5ed"></a><!-- doxytag: member="FCDMaterialInstance::WriteToXML" ref="6ada9494530e83b0d70ac99cf2a8f5ed" args="(xmlNode *parentNode) const " --><p>
181<table class="mdTable" cellpadding="2" cellspacing="0">
182  <tr>
183    <td class="mdRow">
184      <table cellpadding="0" cellspacing="0" border="0">
185        <tr>
186          <td class="md" nowrap valign="top">xmlNode* FCDMaterialInstance::WriteToXML           </td>
187          <td class="md" valign="top">(&nbsp;</td>
188          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
189          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
190          <td class="md" valign="top">&nbsp;)&nbsp;</td>
191          <td class="md" nowrap> const<code> [virtual]</code></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>
205[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node.
206<p>
207<dl compact><dt><b>Parameters:</b></dt><dd>
208  <table border="0" cellspacing="2" cellpadding="0">
209    <tr><td valign="top"></td><td valign="top"><em>parentNode</em>&nbsp;</td><td>The COLLADA XML parent node in which to insert the node. </td></tr>
210  </table>
211</dl>
212<dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl>
213
214<p>
215Reimplemented from <a class="el" href="class_f_c_d_entity_instance.html#a67ca9dc1db615c0cec9f3879015e453">FCDEntityInstance</a>.    </td>
216  </tr>
217</table>
218<hr>The documentation for this class was generated from the following file:<ul>
219<li>FCDocument/<a class="el" href="_f_c_d_material_instance_8h-source.html">FCDMaterialInstance.h</a></ul>
220<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by&nbsp;
221<a href="http://www.doxygen.org/index.html">
222<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
223</body>
224</html>
Note: See TracBrowser for help on using the repository browser.