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

Revision 964, 12.7 KB checked in by igarcia, 19 years ago (diff)
RevLine 
[964]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: FCDGeometryInstance 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>FCDGeometryInstance Class Reference</h1><!-- doxytag: class="FCDGeometryInstance" --><!-- doxytag: inherits="FCDEntityInstance" -->A COLLADA geometry instance. 
25<a href="#_details">More...</a>
26<p>
27<code>#include &lt;<a class="el" href="_f_c_d_geometry_instance_8h-source.html">FCDGeometryInstance.h</a>&gt;</code>
28<p>
29<p>Inheritance diagram for FCDGeometryInstance:
30<p><center><img src="class_f_c_d_geometry_instance.png" usemap="#FCDGeometryInstance_map" border="0" alt=""></center>
31<map name="FCDGeometryInstance_map">
32<area href="class_f_c_d_entity_instance.html" alt="FCDEntityInstance" shape="rect" coords="0,112,139,136">
33<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,139,80">
34<area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,139,24">
35</map>
36<a href="class_f_c_d_geometry_instance-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"><a class="anchor" name="20a18f6323b854f1c6ac7bd02f1907c1"></a><!-- doxytag: member="FCDGeometryInstance::FCDGeometryInstance" ref="20a18f6323b854f1c6ac7bd02f1907c1" args="(FCDocument *document, FCDEntity *entity)" -->
40&nbsp;</td><td class="memItemRight" valign="bottom"><b>FCDGeometryInstance</b> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> *entity)</td></tr>
41
42<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_geometry_instance.html#6125c229bbac52a27ae4a1fa8cd0dac6">GetType</a> () const </td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the entity instance class type.  <a href="#6125c229bbac52a27ae4a1fa8cd0dac6"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c9d105a74407a7e184cc69049f7255d6"></a><!-- doxytag: member="FCDGeometryInstance::FindMaterialInstance" ref="c9d105a74407a7e184cc69049f7255d6" args="(const fchar *semantic)" -->
46<a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>FindMaterialInstance</b> (const fchar *semantic)</td></tr>
47
48<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f07ed4cac509b46bc36d5f8aa94a4fe"></a><!-- doxytag: member="FCDGeometryInstance::FindMaterialInstance" ref="4f07ed4cac509b46bc36d5f8aa94a4fe" args="(const fstring &amp;semantic)" -->
49<a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>FindMaterialInstance</b> (const fstring &amp;semantic)</td></tr>
50
51<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2152ba90a8278f95e0855619c9de454e"></a><!-- doxytag: member="FCDGeometryInstance::FindMaterialInstance" ref="2152ba90a8278f95e0855619c9de454e" args="(const fchar *semantic) const " -->
52const <a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>FindMaterialInstance</b> (const fchar *semantic) const </td></tr>
53
54<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d49c53b2a8bea739087f8894d86c5656"></a><!-- doxytag: member="FCDGeometryInstance::FindMaterialInstance" ref="d49c53b2a8bea739087f8894d86c5656" args="(const fstring &amp;semantic) const " -->
55const <a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>FindMaterialInstance</b> (const fstring &amp;semantic) const </td></tr>
56
57<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8a6cf397e0102602aa87a6c6a2f838d1"></a><!-- doxytag: member="FCDGeometryInstance::GetMaterialInstanceList" ref="8a6cf397e0102602aa87a6c6a2f838d1" args="()" -->
58<a class="el" href="classvector.html">FCDMaterialInstanceList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMaterialInstanceList</b> ()</td></tr>
59
60<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fba55ed5b233faa843bbc306cd15e7c3"></a><!-- doxytag: member="FCDGeometryInstance::GetMaterialInstanceList" ref="fba55ed5b233faa843bbc306cd15e7c3" args="() const " -->
61const <a class="el" href="classvector.html">FCDMaterialInstanceList</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetMaterialInstanceList</b> () const </td></tr>
62
63<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f063d2ff4d04b7d48dcc4faaa3a9910"></a><!-- doxytag: member="FCDGeometryInstance::AddMaterialInstance" ref="7f063d2ff4d04b7d48dcc4faaa3a9910" args="()" -->
64<a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddMaterialInstance</b> ()</td></tr>
65
66<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="360286c0ce88c9de0eed8523967b3ff3"></a><!-- doxytag: member="FCDGeometryInstance::AddMaterialInstance" ref="360286c0ce88c9de0eed8523967b3ff3" args="(FCDMaterial *material, FCDGeometryPolygons *polygons)" -->
67<a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddMaterialInstance</b> (<a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *material, <a class="el" href="class_f_c_d_geometry_polygons.html">FCDGeometryPolygons</a> *polygons)</td></tr>
68
69<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0bf9ed485a2320d85699f4e6f6f6be36"></a><!-- doxytag: member="FCDGeometryInstance::AddMaterialInstance" ref="0bf9ed485a2320d85699f4e6f6f6be36" args="(FCDMaterial *material, const fchar *semantic)" -->
70<a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddMaterialInstance</b> (<a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *material, const fchar *semantic)</td></tr>
71
72<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b4c4be172128f47986875e6253fa4bfe"></a><!-- doxytag: member="FCDGeometryInstance::AddMaterialInstance" ref="b4c4be172128f47986875e6253fa4bfe" args="(FCDMaterial *material, const fstring &amp;semantic)" -->
73<a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>AddMaterialInstance</b> (<a class="el" href="class_f_c_d_material.html">FCDMaterial</a> *material, const fstring &amp;semantic)</td></tr>
74
75<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="04e01b9fb505a1e623c4d3e297f75a60"></a><!-- doxytag: member="FCDGeometryInstance::ReleaseMaterialInstance" ref="04e01b9fb505a1e623c4d3e297f75a60" args="(FCDMaterialInstance *instance)" -->
76void&nbsp;</td><td class="memItemRight" valign="bottom"><b>ReleaseMaterialInstance</b> (<a class="el" href="class_f_c_d_material_instance.html">FCDMaterialInstance</a> *instance)</td></tr>
77
78<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="51231c167536002881f2cfdd4c972d56"></a><!-- doxytag: member="FCDGeometryInstance::LoadFromXML" ref="51231c167536002881f2cfdd4c972d56" args="(xmlNode *instanceNode)" -->
79virtual <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>
80
81<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_geometry_instance.html#8532a601e056ec0b5ba4fc90b5e83068">WriteToXML</a> (xmlNode *parentNode) const </td></tr>
82
83<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node.  <a href="#8532a601e056ec0b5ba4fc90b5e83068"></a><br></td></tr>
84</table>
85<hr><a name="_details"></a><h2>Detailed Description</h2>
86A COLLADA geometry instance.
87<p>
88It is during the instantiation of geometries that the mesh polygons are attached to actual materials.
89<p>
90<hr><h2>Member Function Documentation</h2>
91<a class="anchor" name="6125c229bbac52a27ae4a1fa8cd0dac6"></a><!-- doxytag: member="FCDGeometryInstance::GetType" ref="6125c229bbac52a27ae4a1fa8cd0dac6" args="() const " --><p>
92<table class="mdTable" cellpadding="2" cellspacing="0">
93  <tr>
94    <td class="mdRow">
95      <table cellpadding="0" cellspacing="0" border="0">
96        <tr>
97          <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">Type</a> FCDGeometryInstance::GetType           </td>
98          <td class="md" valign="top">(&nbsp;</td>
99          <td class="mdname1" valign="top" nowrap>          </td>
100          <td class="md" valign="top">&nbsp;)&nbsp;</td>
101          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
102        </tr>
103      </table>
104    </td>
105  </tr>
106</table>
107<table cellspacing="5" cellpadding="0" border="0">
108  <tr>
109    <td>
110      &nbsp;
111    </td>
112    <td>
113
114<p>
115Retrieves the entity instance class type.
116<p>
117This 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>
118
119<p>
120Reimplemented from <a class="el" href="class_f_c_d_entity_instance.html#773c2cfdbad937e93da7a3fa71a671a7">FCDEntityInstance</a>.    </td>
121  </tr>
122</table>
123<a class="anchor" name="8532a601e056ec0b5ba4fc90b5e83068"></a><!-- doxytag: member="FCDGeometryInstance::WriteToXML" ref="8532a601e056ec0b5ba4fc90b5e83068" args="(xmlNode *parentNode) const " --><p>
124<table class="mdTable" cellpadding="2" cellspacing="0">
125  <tr>
126    <td class="mdRow">
127      <table cellpadding="0" cellspacing="0" border="0">
128        <tr>
129          <td class="md" nowrap valign="top">virtual xmlNode* FCDGeometryInstance::WriteToXML           </td>
130          <td class="md" valign="top">(&nbsp;</td>
131          <td class="md" nowrap valign="top">xmlNode *&nbsp;</td>
132          <td class="mdname1" valign="top" nowrap> <em>parentNode</em>          </td>
133          <td class="md" valign="top">&nbsp;)&nbsp;</td>
134          <td class="md" nowrap> const<code> [virtual]</code></td>
135        </tr>
136      </table>
137    </td>
138  </tr>
139</table>
140<table cellspacing="5" cellpadding="0" border="0">
141  <tr>
142    <td>
143      &nbsp;
144    </td>
145    <td>
146
147<p>
148[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node.
149<p>
150<dl compact><dt><b>Parameters:</b></dt><dd>
151  <table border="0" cellspacing="2" cellpadding="0">
152    <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>
153  </table>
154</dl>
155<dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl>
156
157<p>
158Reimplemented from <a class="el" href="class_f_c_d_entity_instance.html#a67ca9dc1db615c0cec9f3879015e453">FCDEntityInstance</a>.    </td>
159  </tr>
160</table>
161<hr>The documentation for this class was generated from the following file:<ul>
162<li>FCDocument/<a class="el" href="_f_c_d_geometry_instance_8h-source.html">FCDGeometryInstance.h</a></ul>
163<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by&nbsp;
164<a href="http://www.doxygen.org/index.html">
165<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
166</body>
167</html>
Note: See TracBrowser for help on using the repository browser.