[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: FCDEntityInstance 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 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 Pages</span></a></li> |
---|
| 16 | </ul></div> |
---|
| 17 | <div class="tabs"> |
---|
| 18 | <ul> |
---|
| 19 | <li><a href="classes.html"><span>Alphabetical List</span></a></li> |
---|
| 20 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
| 21 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
| 22 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
| 23 | </ul></div> |
---|
| 24 | <h1>FCDEntityInstance 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="FCDEntityInstance" --><!-- doxytag: inherits="FCDObject" -->A COLLADA entity instance. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_c_d_entity_instance_8h-source.html">FCDEntityInstance.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <p>Inheritance diagram for FCDEntityInstance: |
---|
| 33 | <p><center><img src="class_f_c_d_entity_instance.png" usemap="#FCDEntityInstance_map" border="0" alt=""></center> |
---|
| 34 | <map name="FCDEntityInstance_map"> |
---|
| 35 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="153,56,296,80"> |
---|
| 36 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="153,0,296,24"> |
---|
| 37 | <area href="class_f_c_d_external_reference.html" alt="FCDExternalReference" shape="rect" coords="0,168,143,192"> |
---|
| 38 | <area href="class_f_c_d_geometry_instance.html" alt="FCDGeometryInstance" shape="rect" coords="153,168,296,192"> |
---|
| 39 | <area href="class_f_c_d_material_instance.html" alt="FCDMaterialInstance" shape="rect" coords="306,168,449,192"> |
---|
| 40 | </map> |
---|
| 41 | <a href="class_f_c_d_entity_instance-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 42 | <tr><td></td></tr> |
---|
| 43 | <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> |
---|
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">Type</a> { <br> |
---|
| 45 | <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3a31de3dc363bacacbbf12a8f9d760477">SIMPLE</a>, |
---|
| 46 | <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3efe2bdfbc299f672e4f97f730a59989f">EXTERNAL_REFERENCE</a>, |
---|
| 47 | <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d36026b8777b8988f942f78b8172c1604d">GEOMETRY</a>, |
---|
| 48 | <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d37fd9bb75e47a0173ec8298eaaa71ef3f">MATERIAL</a>, |
---|
| 49 | <br> |
---|
| 50 | <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d303e68768f437adde6f6c2d518f9db58c">PHYSICS_MODEL</a>, |
---|
| 51 | <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3c01cf93a002bd04a94094fedd096e9bb">PHYSICS_RIGID_BODY</a>, |
---|
| 52 | <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d32f1de96262a206342daf00ceda2bd582">PHYSICS_RIGID_CONSTRAINT</a> |
---|
| 53 | <br> |
---|
| 54 | }</td></tr> |
---|
| 55 | |
---|
| 56 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The class type of the entity instance class. <a href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">More...</a><br></td></tr> |
---|
| 57 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#5b632025af8d2d5e65ced9503299a91b">FCDEntityInstance</a> (<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=NULL)</td></tr> |
---|
| 59 | |
---|
| 60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#5b632025af8d2d5e65ced9503299a91b"></a><br></td></tr> |
---|
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#3a6755170c237b1390cc9941c638e737">~FCDEntityInstance</a> ()</td></tr> |
---|
| 62 | |
---|
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#3a6755170c237b1390cc9941c638e737"></a><br></td></tr> |
---|
| 64 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#773c2cfdbad937e93da7a3fa71a671a7">GetType</a> () const </td></tr> |
---|
| 65 | |
---|
| 66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the entity instance class type. <a href="#773c2cfdbad937e93da7a3fa71a671a7"></a><br></td></tr> |
---|
| 67 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_entity.html">FCDEntity</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#7ebde388a7aa19467c07c9b1fd5bad4b">GetEntity</a> ()</td></tr> |
---|
| 68 | |
---|
| 69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the instantiated entity. <a href="#7ebde388a7aa19467c07c9b1fd5bad4b"></a><br></td></tr> |
---|
| 70 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c311fa6264528437a06bf02fb9a2b3a8"></a><!-- doxytag: member="FCDEntityInstance::GetEntity" ref="c311fa6264528437a06bf02fb9a2b3a8" args="() const " --> |
---|
| 71 | const <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#c311fa6264528437a06bf02fb9a2b3a8">GetEntity</a> () const </td></tr> |
---|
| 72 | |
---|
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 74 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#b70a5bb408f85f587e2d890f0ebb0452">LoadFromXML</a> (xmlNode *UNUSED(instanceNode))</td></tr> |
---|
| 75 | |
---|
| 76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the entity instance from a given COLLADA XML tree node. <a href="#b70a5bb408f85f587e2d890f0ebb0452"></a><br></td></tr> |
---|
| 77 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual xmlNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#a67ca9dc1db615c0cec9f3879015e453">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
| 78 | |
---|
| 79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the entity instance to the given COLLADA XML tree node. <a href="#a67ca9dc1db615c0cec9f3879015e453"></a><br></td></tr> |
---|
| 80 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
| 81 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#f486b23c74a630378fd25b2865bafd0b">SetEntity</a> (<a class="el" href="class_f_c_d_entity.html">FCDEntity</a> *_entity)</td></tr> |
---|
| 82 | |
---|
| 83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the instantiated entity. <a href="#f486b23c74a630378fd25b2865bafd0b"></a><br></td></tr> |
---|
| 84 | <tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr> |
---|
| 85 | <tr><td class="memItemLeft" nowrap align="right" valign="top">static const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity_instance.html#a41ed4315556fc3ea867b27285ab6170">GetInstanceClassType</a> (<a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">FCDEntity::Type</a> type)</td></tr> |
---|
| 86 | |
---|
| 87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Retrieves the COLLADA name for the instantiation of a given entity type. <a href="#a41ed4315556fc3ea867b27285ab6170"></a><br></td></tr> |
---|
| 88 | </table> |
---|
| 89 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 90 | A COLLADA entity instance. |
---|
| 91 | <p> |
---|
| 92 | COLLADA allows for quite a bit of per-instance settings for entities. This information is held by the up-classes of this class. This base class is simply meant to hold the entity that is instantiated. |
---|
| 93 | <p> |
---|
| 94 | <hr><h2>Member Enumeration Documentation</h2> |
---|
| 95 | <a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d3"></a><!-- doxytag: member="FCDEntityInstance::Type" ref="82e95eec7d9242bbedb336b0d35b59d3" args="" --><p> |
---|
| 96 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 97 | <tr> |
---|
| 98 | <td class="mdRow"> |
---|
| 99 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 100 | <tr> |
---|
| 101 | <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">FCDEntityInstance::Type</a> </td> |
---|
| 102 | </tr> |
---|
| 103 | </table> |
---|
| 104 | </td> |
---|
| 105 | </tr> |
---|
| 106 | </table> |
---|
| 107 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 108 | <tr> |
---|
| 109 | <td> |
---|
| 110 | |
---|
| 111 | </td> |
---|
| 112 | <td> |
---|
| 113 | |
---|
| 114 | <p> |
---|
| 115 | The class type of the entity instance class. |
---|
| 116 | <p> |
---|
| 117 | Used this information to up-cast an entity instance. <dl compact><dt><b>Enumerator: </b></dt><dd> |
---|
| 118 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 119 | <tr><td valign="top"><em><a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d3a31de3dc363bacacbbf12a8f9d760477"></a><!-- doxytag: member="SIMPLE" ref="82e95eec7d9242bbedb336b0d35b59d3a31de3dc363bacacbbf12a8f9d760477" args="" -->SIMPLE</em> </td><td> |
---|
| 120 | A simple entity instance that has no per-instance information. |
---|
| 121 | <p> |
---|
| 122 | This is used for lights and cameras in the visual scene graph and there is no up-class. </td></tr> |
---|
| 123 | <tr><td valign="top"><em><a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d3efe2bdfbc299f672e4f97f730a59989f"></a><!-- doxytag: member="EXTERNAL_REFERENCE" ref="82e95eec7d9242bbedb336b0d35b59d3efe2bdfbc299f672e4f97f730a59989f" args="" -->EXTERNAL_REFERENCE</em> </td><td> |
---|
| 124 | An external reference(FCDExternalReference). </td></tr> |
---|
| 125 | <tr><td valign="top"><em><a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d36026b8777b8988f942f78b8172c1604d"></a><!-- doxytag: member="GEOMETRY" ref="82e95eec7d9242bbedb336b0d35b59d36026b8777b8988f942f78b8172c1604d" args="" -->GEOMETRY</em> </td><td> |
---|
| 126 | A geometry entity(FCDGeometryInstance). </td></tr> |
---|
| 127 | <tr><td valign="top"><em><a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d37fd9bb75e47a0173ec8298eaaa71ef3f"></a><!-- doxytag: member="MATERIAL" ref="82e95eec7d9242bbedb336b0d35b59d37fd9bb75e47a0173ec8298eaaa71ef3f" args="" -->MATERIAL</em> </td><td> |
---|
| 128 | A material entity(FCDMaterialInstance). </td></tr> |
---|
| 129 | <tr><td valign="top"><em><a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d303e68768f437adde6f6c2d518f9db58c"></a><!-- doxytag: member="PHYSICS_MODEL" ref="82e95eec7d9242bbedb336b0d35b59d303e68768f437adde6f6c2d518f9db58c" args="" -->PHYSICS_MODEL</em> </td><td> |
---|
| 130 | A physics model(FCDPhysicsModelInstance). </td></tr> |
---|
| 131 | <tr><td valign="top"><em><a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d3c01cf93a002bd04a94094fedd096e9bb"></a><!-- doxytag: member="PHYSICS_RIGID_BODY" ref="82e95eec7d9242bbedb336b0d35b59d3c01cf93a002bd04a94094fedd096e9bb" args="" -->PHYSICS_RIGID_BODY</em> </td><td> |
---|
| 132 | A physics rigid body(FCDPhysicsRigidBodyInstance). </td></tr> |
---|
| 133 | <tr><td valign="top"><em><a class="anchor" name="82e95eec7d9242bbedb336b0d35b59d32f1de96262a206342daf00ceda2bd582"></a><!-- doxytag: member="PHYSICS_RIGID_CONSTRAINT" ref="82e95eec7d9242bbedb336b0d35b59d32f1de96262a206342daf00ceda2bd582" args="" -->PHYSICS_RIGID_CONSTRAINT</em> </td><td> |
---|
| 134 | A physics rigid constraint(FCDPhysicsRigidConstraintInstance). </td></tr> |
---|
| 135 | </table> |
---|
| 136 | </dl> |
---|
| 137 | </td> |
---|
| 138 | </tr> |
---|
| 139 | </table> |
---|
| 140 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 141 | <a class="anchor" name="5b632025af8d2d5e65ced9503299a91b"></a><!-- doxytag: member="FCDEntityInstance::FCDEntityInstance" ref="5b632025af8d2d5e65ced9503299a91b" args="(FCDocument *document, FCDEntity *entity=NULL)" --><p> |
---|
| 142 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 143 | <tr> |
---|
| 144 | <td class="mdRow"> |
---|
| 145 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 146 | <tr> |
---|
| 147 | <td class="md" nowrap valign="top">FCDEntityInstance::FCDEntityInstance </td> |
---|
| 148 | <td class="md" valign="top">( </td> |
---|
| 149 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 150 | <td class="mdname" nowrap> <em>document</em>, </td> |
---|
| 151 | </tr> |
---|
| 152 | <tr> |
---|
| 153 | <td class="md" nowrap align="right"></td> |
---|
| 154 | <td class="md"></td> |
---|
| 155 | <td class="md" nowrap><a class="el" href="class_f_c_d_entity.html">FCDEntity</a> * </td> |
---|
| 156 | <td class="mdname" nowrap> <em>entity</em> = <code>NULL</code></td> |
---|
| 157 | </tr> |
---|
| 158 | <tr> |
---|
| 159 | <td class="md"></td> |
---|
| 160 | <td class="md">) </td> |
---|
| 161 | <td class="md" colspan="2"></td> |
---|
| 162 | </tr> |
---|
| 163 | </table> |
---|
| 164 | </td> |
---|
| 165 | </tr> |
---|
| 166 | </table> |
---|
| 167 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 168 | <tr> |
---|
| 169 | <td> |
---|
| 170 | |
---|
| 171 | </td> |
---|
| 172 | <td> |
---|
| 173 | |
---|
| 174 | <p> |
---|
| 175 | Constructor: do not use directly. |
---|
| 176 | <p> |
---|
| 177 | Instead, use the appropriate allocation function. For scene node instance: <a class="el" href="class_f_c_d_scene_node.html#7660c240db5c142f087c6aa90a2b25e3">FCDSceneNode::AddInstance</a>. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 178 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 179 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the entity instance. </td></tr> |
---|
| 180 | <tr><td valign="top"></td><td valign="top"><em>entity</em> </td><td>The entity to instantiate. This pointer will be NULL for some up-classes where the entity instantiate is more complex. </td></tr> |
---|
| 181 | </table> |
---|
| 182 | </dl> |
---|
| 183 | </td> |
---|
| 184 | </tr> |
---|
| 185 | </table> |
---|
| 186 | <a class="anchor" name="3a6755170c237b1390cc9941c638e737"></a><!-- doxytag: member="FCDEntityInstance::~FCDEntityInstance" ref="3a6755170c237b1390cc9941c638e737" args="()" --><p> |
---|
| 187 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 188 | <tr> |
---|
| 189 | <td class="mdRow"> |
---|
| 190 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 191 | <tr> |
---|
| 192 | <td class="md" nowrap valign="top">virtual FCDEntityInstance::~FCDEntityInstance </td> |
---|
| 193 | <td class="md" valign="top">( </td> |
---|
| 194 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 195 | <td class="md" valign="top"> ) </td> |
---|
| 196 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 197 | </tr> |
---|
| 198 | </table> |
---|
| 199 | </td> |
---|
| 200 | </tr> |
---|
| 201 | </table> |
---|
| 202 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 203 | <tr> |
---|
| 204 | <td> |
---|
| 205 | |
---|
| 206 | </td> |
---|
| 207 | <td> |
---|
| 208 | |
---|
| 209 | <p> |
---|
| 210 | Destructor: do not use directly. |
---|
| 211 | <p> |
---|
| 212 | Instead, use the appropriate release funciton. For scene node instances: <a class="el" href="class_f_c_d_scene_node.html#51c32207d487862c1ca2d53a119b1345">FCDSceneNode::ReleaseInstance</a>. </td> |
---|
| 213 | </tr> |
---|
| 214 | </table> |
---|
| 215 | <hr><h2>Member Function Documentation</h2> |
---|
| 216 | <a class="anchor" name="7ebde388a7aa19467c07c9b1fd5bad4b"></a><!-- doxytag: member="FCDEntityInstance::GetEntity" ref="7ebde388a7aa19467c07c9b1fd5bad4b" args="()" --><p> |
---|
| 217 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 218 | <tr> |
---|
| 219 | <td class="mdRow"> |
---|
| 220 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 221 | <tr> |
---|
| 222 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_entity.html">FCDEntity</a>* FCDEntityInstance::GetEntity </td> |
---|
| 223 | <td class="md" valign="top">( </td> |
---|
| 224 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 225 | <td class="md" valign="top"> ) </td> |
---|
| 226 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 227 | </tr> |
---|
| 228 | </table> |
---|
| 229 | </td> |
---|
| 230 | </tr> |
---|
| 231 | </table> |
---|
| 232 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 233 | <tr> |
---|
| 234 | <td> |
---|
| 235 | |
---|
| 236 | </td> |
---|
| 237 | <td> |
---|
| 238 | |
---|
| 239 | <p> |
---|
| 240 | Retrieves the instantiated entity. |
---|
| 241 | <p> |
---|
| 242 | <dl compact><dt><b>Returns:</b></dt><dd>The instantiated entity. </dd></dl> |
---|
| 243 | </td> |
---|
| 244 | </tr> |
---|
| 245 | </table> |
---|
| 246 | <a class="anchor" name="a41ed4315556fc3ea867b27285ab6170"></a><!-- doxytag: member="FCDEntityInstance::GetInstanceClassType" ref="a41ed4315556fc3ea867b27285ab6170" args="(FCDEntity::Type type)" --><p> |
---|
| 247 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 248 | <tr> |
---|
| 249 | <td class="mdRow"> |
---|
| 250 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 251 | <tr> |
---|
| 252 | <td class="md" nowrap valign="top">static const char* FCDEntityInstance::GetInstanceClassType </td> |
---|
| 253 | <td class="md" valign="top">( </td> |
---|
| 254 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">FCDEntity::Type</a> </td> |
---|
| 255 | <td class="mdname1" valign="top" nowrap> <em>type</em> </td> |
---|
| 256 | <td class="md" valign="top"> ) </td> |
---|
| 257 | <td class="md" nowrap><code> [static, protected]</code></td> |
---|
| 258 | </tr> |
---|
| 259 | </table> |
---|
| 260 | </td> |
---|
| 261 | </tr> |
---|
| 262 | </table> |
---|
| 263 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 264 | <tr> |
---|
| 265 | <td> |
---|
| 266 | |
---|
| 267 | </td> |
---|
| 268 | <td> |
---|
| 269 | |
---|
| 270 | <p> |
---|
| 271 | [INTERNAL] Retrieves the COLLADA name for the instantiation of a given entity type. |
---|
| 272 | <p> |
---|
| 273 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 274 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 275 | <tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>The entity class type. </td></tr> |
---|
| 276 | </table> |
---|
| 277 | </dl> |
---|
| 278 | <dl compact><dt><b>Returns:</b></dt><dd>The COLLADA name to instantiate an entity of the given class type. </dd></dl> |
---|
| 279 | </td> |
---|
| 280 | </tr> |
---|
| 281 | </table> |
---|
| 282 | <a class="anchor" name="773c2cfdbad937e93da7a3fa71a671a7"></a><!-- doxytag: member="FCDEntityInstance::GetType" ref="773c2cfdbad937e93da7a3fa71a671a7" args="() const " --><p> |
---|
| 283 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 284 | <tr> |
---|
| 285 | <td class="mdRow"> |
---|
| 286 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 287 | <tr> |
---|
| 288 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity_instance.html#82e95eec7d9242bbedb336b0d35b59d3">Type</a> FCDEntityInstance::GetType </td> |
---|
| 289 | <td class="md" valign="top">( </td> |
---|
| 290 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 291 | <td class="md" valign="top"> ) </td> |
---|
| 292 | <td class="md" nowrap> const<code> [inline, virtual]</code></td> |
---|
| 293 | </tr> |
---|
| 294 | </table> |
---|
| 295 | </td> |
---|
| 296 | </tr> |
---|
| 297 | </table> |
---|
| 298 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 299 | <tr> |
---|
| 300 | <td> |
---|
| 301 | |
---|
| 302 | </td> |
---|
| 303 | <td> |
---|
| 304 | |
---|
| 305 | <p> |
---|
| 306 | Retrieves the entity instance class type. |
---|
| 307 | <p> |
---|
| 308 | This 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> |
---|
| 309 | |
---|
| 310 | <p> |
---|
| 311 | Reimplemented in <a class="el" href="class_f_c_d_external_reference.html#4a98a4e429f89532352fa439b1fa7758">FCDExternalReference</a>, <a class="el" href="class_f_c_d_geometry_instance.html#6125c229bbac52a27ae4a1fa8cd0dac6">FCDGeometryInstance</a>, and <a class="el" href="class_f_c_d_material_instance.html#ac2d768573a02ba8a55a329a6d4b39e3">FCDMaterialInstance</a>. </td> |
---|
| 312 | </tr> |
---|
| 313 | </table> |
---|
| 314 | <a class="anchor" name="b70a5bb408f85f587e2d890f0ebb0452"></a><!-- doxytag: member="FCDEntityInstance::LoadFromXML" ref="b70a5bb408f85f587e2d890f0ebb0452" args="(xmlNode *UNUSED(instanceNode))" --><p> |
---|
| 315 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 316 | <tr> |
---|
| 317 | <td class="mdRow"> |
---|
| 318 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 319 | <tr> |
---|
| 320 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEntityInstance::LoadFromXML </td> |
---|
| 321 | <td class="md" valign="top">( </td> |
---|
| 322 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 323 | <td class="mdname1" valign="top" nowrap> <em>UNUSED</em>(instanceNode) </td> |
---|
| 324 | <td class="md" valign="top"> ) </td> |
---|
| 325 | <td class="md" nowrap><code> [inline, virtual]</code></td> |
---|
| 326 | </tr> |
---|
| 327 | </table> |
---|
| 328 | </td> |
---|
| 329 | </tr> |
---|
| 330 | </table> |
---|
| 331 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 332 | <tr> |
---|
| 333 | <td> |
---|
| 334 | |
---|
| 335 | </td> |
---|
| 336 | <td> |
---|
| 337 | |
---|
| 338 | <p> |
---|
| 339 | [INTERNAL] Reads in the entity instance from a given COLLADA XML tree node. |
---|
| 340 | <p> |
---|
| 341 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 342 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 343 | <tr><td valign="top"></td><td valign="top"><em>UNUSED</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
| 344 | </table> |
---|
| 345 | </dl> |
---|
| 346 | <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 instance. </dd></dl> |
---|
| 347 | </td> |
---|
| 348 | </tr> |
---|
| 349 | </table> |
---|
| 350 | <a class="anchor" name="f486b23c74a630378fd25b2865bafd0b"></a><!-- doxytag: member="FCDEntityInstance::SetEntity" ref="f486b23c74a630378fd25b2865bafd0b" args="(FCDEntity *_entity)" --><p> |
---|
| 351 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 352 | <tr> |
---|
| 353 | <td class="mdRow"> |
---|
| 354 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 355 | <tr> |
---|
| 356 | <td class="md" nowrap valign="top">void FCDEntityInstance::SetEntity </td> |
---|
| 357 | <td class="md" valign="top">( </td> |
---|
| 358 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_entity.html">FCDEntity</a> * </td> |
---|
| 359 | <td class="mdname1" valign="top" nowrap> <em>_entity</em> </td> |
---|
| 360 | <td class="md" valign="top"> ) </td> |
---|
| 361 | <td class="md" nowrap><code> [inline, protected]</code></td> |
---|
| 362 | </tr> |
---|
| 363 | </table> |
---|
| 364 | </td> |
---|
| 365 | </tr> |
---|
| 366 | </table> |
---|
| 367 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 368 | <tr> |
---|
| 369 | <td> |
---|
| 370 | |
---|
| 371 | </td> |
---|
| 372 | <td> |
---|
| 373 | |
---|
| 374 | <p> |
---|
| 375 | Sets the instantiated entity. |
---|
| 376 | <p> |
---|
| 377 | This is used in up-classes to support different instantiation schemes. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 378 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 379 | <tr><td valign="top"></td><td valign="top"><em>_entity</em> </td><td>The instantiated entity. </td></tr> |
---|
| 380 | </table> |
---|
| 381 | </dl> |
---|
| 382 | </td> |
---|
| 383 | </tr> |
---|
| 384 | </table> |
---|
| 385 | <a class="anchor" name="a67ca9dc1db615c0cec9f3879015e453"></a><!-- doxytag: member="FCDEntityInstance::WriteToXML" ref="a67ca9dc1db615c0cec9f3879015e453" args="(xmlNode *parentNode) 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">virtual xmlNode* FCDEntityInstance::WriteToXML </td> |
---|
| 392 | <td class="md" valign="top">( </td> |
---|
| 393 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 394 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
| 395 | <td class="md" valign="top"> ) </td> |
---|
| 396 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 397 | </tr> |
---|
| 398 | </table> |
---|
| 399 | </td> |
---|
| 400 | </tr> |
---|
| 401 | </table> |
---|
| 402 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 403 | <tr> |
---|
| 404 | <td> |
---|
| 405 | |
---|
| 406 | </td> |
---|
| 407 | <td> |
---|
| 408 | |
---|
| 409 | <p> |
---|
| 410 | [INTERNAL] Writes out the entity instance to the given COLLADA XML tree node. |
---|
| 411 | <p> |
---|
| 412 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 413 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 414 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the node. </td></tr> |
---|
| 415 | </table> |
---|
| 416 | </dl> |
---|
| 417 | <dl compact><dt><b>Returns:</b></dt><dd>The created XML tree node. </dd></dl> |
---|
| 418 | |
---|
| 419 | <p> |
---|
| 420 | Reimplemented in <a class="el" href="class_f_c_d_external_reference.html#190ee2b815963aa1f7358bd420bdabbf">FCDExternalReference</a>, <a class="el" href="class_f_c_d_geometry_instance.html#8532a601e056ec0b5ba4fc90b5e83068">FCDGeometryInstance</a>, and <a class="el" href="class_f_c_d_material_instance.html#6ada9494530e83b0d70ac99cf2a8f5ed">FCDMaterialInstance</a>. </td> |
---|
| 421 | </tr> |
---|
| 422 | </table> |
---|
| 423 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 424 | <li>FCDocument/<a class="el" href="_f_c_d_entity_instance_8h-source.html">FCDEntityInstance.h</a></ul> |
---|
| 425 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by |
---|
| 426 | <a href="http://www.doxygen.org/index.html"> |
---|
| 427 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 428 | </body> |
---|
| 429 | </html> |
---|