[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: FCDLibrary< T > Class Template 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>FCDLibrary< T > Class Template Reference<br> |
---|
| 25 | <small> |
---|
| 26 | [<a class="el" href="group___f_c_document.html">COLLADA Document Object Model.</a>]</small> |
---|
| 27 | </h1><!-- doxytag: class="FCDLibrary" -->A COLLADA library. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_c_d_library_8h-source.html">FCDLibrary.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <a href="class_f_c_d_library-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 33 | <tr><td></td></tr> |
---|
| 34 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 35 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#9cf3270dce2286c94003cabe65602bd3">FCDLibrary</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
| 36 | |
---|
| 37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#9cf3270dce2286c94003cabe65602bd3"></a><br></td></tr> |
---|
| 38 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#ca8cf97f6797c52ff37422d7e7158afd">~FCDLibrary</a> ()</td></tr> |
---|
| 39 | |
---|
| 40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#ca8cf97f6797c52ff37422d7e7158afd"></a><br></td></tr> |
---|
| 41 | <tr><td class="memItemLeft" nowrap align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#a5cdcac5a447298d5e3816e4f8c864d0">AddEntity</a> ()</td></tr> |
---|
| 42 | |
---|
| 43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new entity within this library. <a href="#a5cdcac5a447298d5e3816e4f8c864d0"></a><br></td></tr> |
---|
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#3fbfbcf4ade5b9c94d2ee2f59db5921d">ReleaseEntity</a> (T *entity)</td></tr> |
---|
| 45 | |
---|
| 46 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Releases an entity contained within this library. <a href="#3fbfbcf4ade5b9c94d2ee2f59db5921d"></a><br></td></tr> |
---|
| 47 | <tr><td class="memItemLeft" nowrap align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#5d9fdcf2b8d4edb840a1502c9814dd27">FindDaeId</a> (const string &daeId)</td></tr> |
---|
| 48 | |
---|
| 49 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the library entity with the given COLLADA id. <a href="#5d9fdcf2b8d4edb840a1502c9814dd27"></a><br></td></tr> |
---|
| 50 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#5045adb8f08e9a8f51fada3fdce63470">IsEmpty</a> () const </td></tr> |
---|
| 51 | |
---|
| 52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the library contains no entities. <a href="#5045adb8f08e9a8f51fada3fdce63470"></a><br></td></tr> |
---|
| 53 | <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_library.html#813347c0e988c025235eaeaf12400d1a">LoadFromXML</a> (xmlNode *node)</td></tr> |
---|
| 54 | |
---|
| 55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the contents of the library from the COLLADA XML document. <a href="#813347c0e988c025235eaeaf12400d1a"></a><br></td></tr> |
---|
| 56 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#297ebf05ef14830be557ddf57909471f">WriteToXML</a> (xmlNode *node) const </td></tr> |
---|
| 57 | |
---|
| 58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the library entities to the COLLADA XML document. <a href="#297ebf05ef14830be557ddf57909471f"></a><br></td></tr> |
---|
| 59 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">StringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#6c0c8f49e36eb99b82f838231e013461">GetPostProcessCmds</a> () const </td></tr> |
---|
| 60 | |
---|
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#b79bd9b55bce87bcb597a3343a94957a">GetEntityCount</a> () const </td></tr> |
---|
| 62 | |
---|
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the number of entities within the library. <a href="#b79bd9b55bce87bcb597a3343a94957a"></a><br></td></tr> |
---|
| 64 | <tr><td class="memItemLeft" nowrap align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#b2aa913794a0ceaafe3b3773deac3398">GetEntity</a> (size_t index)</td></tr> |
---|
| 65 | |
---|
| 66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an indexed entity from the library. <a href="#b2aa913794a0ceaafe3b3773deac3398"></a><br></td></tr> |
---|
| 67 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const T * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#3a53f0a1500d48e935f1469f002f27ce">GetEntity</a> (size_t index) const </td></tr> |
---|
| 68 | |
---|
| 69 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an indexed entity from the library. <a href="#3a53f0a1500d48e935f1469f002f27ce"></a><br></td></tr> |
---|
| 70 | <tr><td colspan="2"><br><h2>Protected Types</h2></td></tr> |
---|
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="607c0512d9c60197945dff2cb8466e53"></a><!-- doxytag: member="FCDLibrary::FCDEntityList" ref="607c0512d9c60197945dff2cb8466e53" args="" --> |
---|
| 72 | typedef <a class="el" href="classvector.html">vector</a>< T * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#607c0512d9c60197945dff2cb8466e53">FCDEntityList</a></td></tr> |
---|
| 73 | |
---|
| 74 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The list type for the entities. <br></td></tr> |
---|
| 75 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
| 76 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#1fec4251289d23f91d879952d26c426a">GetDocument</a> ()</td></tr> |
---|
| 77 | |
---|
| 78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the parent document. <a href="#1fec4251289d23f91d879952d26c426a"></a><br></td></tr> |
---|
| 79 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7f20eea0bf100d5548d345a1c043896b"></a><!-- doxytag: member="FCDLibrary::GetDocument" ref="7f20eea0bf100d5548d345a1c043896b" args="() const " --> |
---|
| 80 | const <a class="el" href="class_f_c_document.html">FCDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#7f20eea0bf100d5548d345a1c043896b">GetDocument</a> () const </td></tr> |
---|
| 81 | |
---|
| 82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 83 | <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> |
---|
| 84 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classvector.html">FCDEntityList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_library.html#51f2628cd303aea6368029a8ce77a7e4">entities</a></td></tr> |
---|
| 85 | |
---|
| 86 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Entities list. <a href="#51f2628cd303aea6368029a8ce77a7e4"></a><br></td></tr> |
---|
| 87 | </table> |
---|
| 88 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 89 | <h3>template<class T><br> |
---|
| 90 | class FCDLibrary< T ></h3> |
---|
| 91 | |
---|
| 92 | A COLLADA library. |
---|
| 93 | <p> |
---|
| 94 | A COLLADA library holds a list of entities. There are libraries for the following entities: animations (<a class="el" href="class_f_c_d_animation.html">FCDAnimation</a>), animation clips (FCDAnimationClip), meshes and splines (<a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a>), materials (<a class="el" href="class_f_c_d_material.html">FCDMaterial</a>), effects (<a class="el" href="class_f_c_d_effect.html">FCDEffect</a>), images (<a class="el" href="class_f_c_d_image.html">FCDImage</a>), skins and morphers (<a class="el" href="class_f_c_d_controller.html">FCDController</a>), cameras (<a class="el" href="class_f_c_d_camera.html">FCDCamera</a>), lights (<a class="el" href="class_f_c_d_light.html">FCDLight</a>), physics models (FCDPhysicsModel), physics materials (FCDPhysicsMaterial), physics scenes (FCDPhysicsSceneNode) and visual scenes (<a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a>).<p> |
---|
| 95 | The COLLADA libraries are contained within the <a class="el" href="class_f_c_document.html">FCDocument</a> object. |
---|
| 96 | <p> |
---|
| 97 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 98 | <a class="anchor" name="9cf3270dce2286c94003cabe65602bd3"></a><!-- doxytag: member="FCDLibrary::FCDLibrary" ref="9cf3270dce2286c94003cabe65602bd3" args="(FCDocument *document)" --><p> |
---|
| 99 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 100 | <tr> |
---|
| 101 | <td class="mdRow"> |
---|
| 102 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 103 | <tr> |
---|
| 104 | <td class="mdPrefix" colspan="4"> |
---|
| 105 | template<class T> </td> |
---|
| 106 | </tr> |
---|
| 107 | <tr> |
---|
| 108 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::<a class="el" href="class_f_c_d_library.html">FCDLibrary</a> </td> |
---|
| 109 | <td class="md" valign="top">( </td> |
---|
| 110 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 111 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
| 112 | <td class="md" valign="top"> ) </td> |
---|
| 113 | <td class="md" nowrap></td> |
---|
| 114 | </tr> |
---|
| 115 | </table> |
---|
| 116 | </td> |
---|
| 117 | </tr> |
---|
| 118 | </table> |
---|
| 119 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 120 | <tr> |
---|
| 121 | <td> |
---|
| 122 | |
---|
| 123 | </td> |
---|
| 124 | <td> |
---|
| 125 | |
---|
| 126 | <p> |
---|
| 127 | Constructor: do not use directly. |
---|
| 128 | <p> |
---|
| 129 | All the necessary libraries are created by the <a class="el" href="class_f_c_document.html">FCDocument</a> object during its creation. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 130 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 131 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The parent document. </td></tr> |
---|
| 132 | </table> |
---|
| 133 | </dl> |
---|
| 134 | </td> |
---|
| 135 | </tr> |
---|
| 136 | </table> |
---|
| 137 | <a class="anchor" name="ca8cf97f6797c52ff37422d7e7158afd"></a><!-- doxytag: member="FCDLibrary::~FCDLibrary" ref="ca8cf97f6797c52ff37422d7e7158afd" args="()" --><p> |
---|
| 138 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 139 | <tr> |
---|
| 140 | <td class="mdRow"> |
---|
| 141 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 142 | <tr> |
---|
| 143 | <td class="mdPrefix" colspan="4"> |
---|
| 144 | template<class T> </td> |
---|
| 145 | </tr> |
---|
| 146 | <tr> |
---|
| 147 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::~<a class="el" href="class_f_c_d_library.html">FCDLibrary</a> </td> |
---|
| 148 | <td class="md" valign="top">( </td> |
---|
| 149 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 150 | <td class="md" valign="top"> ) </td> |
---|
| 151 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 152 | </tr> |
---|
| 153 | </table> |
---|
| 154 | </td> |
---|
| 155 | </tr> |
---|
| 156 | </table> |
---|
| 157 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 158 | <tr> |
---|
| 159 | <td> |
---|
| 160 | |
---|
| 161 | </td> |
---|
| 162 | <td> |
---|
| 163 | |
---|
| 164 | <p> |
---|
| 165 | Destructor: do not use directly. |
---|
| 166 | <p> |
---|
| 167 | The libraries are released by the <a class="el" href="class_f_c_document.html">FCDocument</a>, just before it is released. </td> |
---|
| 168 | </tr> |
---|
| 169 | </table> |
---|
| 170 | <hr><h2>Member Function Documentation</h2> |
---|
| 171 | <a class="anchor" name="a5cdcac5a447298d5e3816e4f8c864d0"></a><!-- doxytag: member="FCDLibrary::AddEntity" ref="a5cdcac5a447298d5e3816e4f8c864d0" args="()" --><p> |
---|
| 172 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 173 | <tr> |
---|
| 174 | <td class="mdRow"> |
---|
| 175 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 176 | <tr> |
---|
| 177 | <td class="mdPrefix" colspan="4"> |
---|
| 178 | template<class T> </td> |
---|
| 179 | </tr> |
---|
| 180 | <tr> |
---|
| 181 | <td class="md" nowrap valign="top">T * <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::AddEntity </td> |
---|
| 182 | <td class="md" valign="top">( </td> |
---|
| 183 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 184 | <td class="md" valign="top"> ) </td> |
---|
| 185 | <td class="md" nowrap></td> |
---|
| 186 | </tr> |
---|
| 187 | </table> |
---|
| 188 | </td> |
---|
| 189 | </tr> |
---|
| 190 | </table> |
---|
| 191 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 192 | <tr> |
---|
| 193 | <td> |
---|
| 194 | |
---|
| 195 | </td> |
---|
| 196 | <td> |
---|
| 197 | |
---|
| 198 | <p> |
---|
| 199 | Create a new entity within this library. |
---|
| 200 | <p> |
---|
| 201 | <dl compact><dt><b>Returns:</b></dt><dd>The newly created entity. </dd></dl> |
---|
| 202 | </td> |
---|
| 203 | </tr> |
---|
| 204 | </table> |
---|
| 205 | <a class="anchor" name="5d9fdcf2b8d4edb840a1502c9814dd27"></a><!-- doxytag: member="FCDLibrary::FindDaeId" ref="5d9fdcf2b8d4edb840a1502c9814dd27" args="(const string &daeId)" --><p> |
---|
| 206 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 207 | <tr> |
---|
| 208 | <td class="mdRow"> |
---|
| 209 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 210 | <tr> |
---|
| 211 | <td class="mdPrefix" colspan="4"> |
---|
| 212 | template<class T> </td> |
---|
| 213 | </tr> |
---|
| 214 | <tr> |
---|
| 215 | <td class="md" nowrap valign="top">T * <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::FindDaeId </td> |
---|
| 216 | <td class="md" valign="top">( </td> |
---|
| 217 | <td class="md" nowrap valign="top">const string & </td> |
---|
| 218 | <td class="mdname1" valign="top" nowrap> <em>daeId</em> </td> |
---|
| 219 | <td class="md" valign="top"> ) </td> |
---|
| 220 | <td class="md" nowrap></td> |
---|
| 221 | </tr> |
---|
| 222 | </table> |
---|
| 223 | </td> |
---|
| 224 | </tr> |
---|
| 225 | </table> |
---|
| 226 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 227 | <tr> |
---|
| 228 | <td> |
---|
| 229 | |
---|
| 230 | </td> |
---|
| 231 | <td> |
---|
| 232 | |
---|
| 233 | <p> |
---|
| 234 | Retrieve the library entity with the given COLLADA id. |
---|
| 235 | <p> |
---|
| 236 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 237 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 238 | <tr><td valign="top"></td><td valign="top"><em>daeId</em> </td><td>The COLLADA id of the entity. </td></tr> |
---|
| 239 | </table> |
---|
| 240 | </dl> |
---|
| 241 | <dl compact><dt><b>Returns:</b></dt><dd>The library entity which matches the COLLADA id. This pointer will be NULL if no matching entity was found. </dd></dl> |
---|
| 242 | </td> |
---|
| 243 | </tr> |
---|
| 244 | </table> |
---|
| 245 | <a class="anchor" name="1fec4251289d23f91d879952d26c426a"></a><!-- doxytag: member="FCDLibrary::GetDocument" ref="1fec4251289d23f91d879952d26c426a" args="()" --><p> |
---|
| 246 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 247 | <tr> |
---|
| 248 | <td class="mdRow"> |
---|
| 249 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 250 | <tr> |
---|
| 251 | <td class="mdPrefix" colspan="4"> |
---|
| 252 | template<class T> </td> |
---|
| 253 | </tr> |
---|
| 254 | <tr> |
---|
| 255 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a>* <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::GetDocument </td> |
---|
| 256 | <td class="md" valign="top">( </td> |
---|
| 257 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 258 | <td class="md" valign="top"> ) </td> |
---|
| 259 | <td class="md" nowrap><code> [inline, protected]</code></td> |
---|
| 260 | </tr> |
---|
| 261 | </table> |
---|
| 262 | </td> |
---|
| 263 | </tr> |
---|
| 264 | </table> |
---|
| 265 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 266 | <tr> |
---|
| 267 | <td> |
---|
| 268 | |
---|
| 269 | </td> |
---|
| 270 | <td> |
---|
| 271 | |
---|
| 272 | <p> |
---|
| 273 | Retrieves the parent document. |
---|
| 274 | <p> |
---|
| 275 | <dl compact><dt><b>Returns:</b></dt><dd>The parent document. </dd></dl> |
---|
| 276 | </td> |
---|
| 277 | </tr> |
---|
| 278 | </table> |
---|
| 279 | <a class="anchor" name="3a53f0a1500d48e935f1469f002f27ce"></a><!-- doxytag: member="FCDLibrary::GetEntity" ref="3a53f0a1500d48e935f1469f002f27ce" args="(size_t index) const " --><p> |
---|
| 280 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 281 | <tr> |
---|
| 282 | <td class="mdRow"> |
---|
| 283 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 284 | <tr> |
---|
| 285 | <td class="mdPrefix" colspan="4"> |
---|
| 286 | template<class T> </td> |
---|
| 287 | </tr> |
---|
| 288 | <tr> |
---|
| 289 | <td class="md" nowrap valign="top">const T* <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::GetEntity </td> |
---|
| 290 | <td class="md" valign="top">( </td> |
---|
| 291 | <td class="md" nowrap valign="top">size_t </td> |
---|
| 292 | <td class="mdname1" valign="top" nowrap> <em>index</em> </td> |
---|
| 293 | <td class="md" valign="top"> ) </td> |
---|
| 294 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 295 | </tr> |
---|
| 296 | </table> |
---|
| 297 | </td> |
---|
| 298 | </tr> |
---|
| 299 | </table> |
---|
| 300 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 301 | <tr> |
---|
| 302 | <td> |
---|
| 303 | |
---|
| 304 | </td> |
---|
| 305 | <td> |
---|
| 306 | |
---|
| 307 | <p> |
---|
| 308 | Retrieve an indexed entity from the library. |
---|
| 309 | <p> |
---|
| 310 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 311 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 312 | <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The index of the entity to retrieve. Should be within the range [0, <a class="el" href="class_f_c_d_library.html#b79bd9b55bce87bcb597a3343a94957a">GetEntityCount()</a>[. </td></tr> |
---|
| 313 | </table> |
---|
| 314 | </dl> |
---|
| 315 | <dl compact><dt><b>Returns:</b></dt><dd>The indexed entity. </dd></dl> |
---|
| 316 | </td> |
---|
| 317 | </tr> |
---|
| 318 | </table> |
---|
| 319 | <a class="anchor" name="b2aa913794a0ceaafe3b3773deac3398"></a><!-- doxytag: member="FCDLibrary::GetEntity" ref="b2aa913794a0ceaafe3b3773deac3398" args="(size_t index)" --><p> |
---|
| 320 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 321 | <tr> |
---|
| 322 | <td class="mdRow"> |
---|
| 323 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 324 | <tr> |
---|
| 325 | <td class="mdPrefix" colspan="4"> |
---|
| 326 | template<class T> </td> |
---|
| 327 | </tr> |
---|
| 328 | <tr> |
---|
| 329 | <td class="md" nowrap valign="top">T* <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::GetEntity </td> |
---|
| 330 | <td class="md" valign="top">( </td> |
---|
| 331 | <td class="md" nowrap valign="top">size_t </td> |
---|
| 332 | <td class="mdname1" valign="top" nowrap> <em>index</em> </td> |
---|
| 333 | <td class="md" valign="top"> ) </td> |
---|
| 334 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 335 | </tr> |
---|
| 336 | </table> |
---|
| 337 | </td> |
---|
| 338 | </tr> |
---|
| 339 | </table> |
---|
| 340 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 341 | <tr> |
---|
| 342 | <td> |
---|
| 343 | |
---|
| 344 | </td> |
---|
| 345 | <td> |
---|
| 346 | |
---|
| 347 | <p> |
---|
| 348 | Retrieve an indexed entity from the library. |
---|
| 349 | <p> |
---|
| 350 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 351 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 352 | <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>The index of the entity to retrieve. Should be within the range [0, <a class="el" href="class_f_c_d_library.html#b79bd9b55bce87bcb597a3343a94957a">GetEntityCount()</a>[. </td></tr> |
---|
| 353 | </table> |
---|
| 354 | </dl> |
---|
| 355 | <dl compact><dt><b>Returns:</b></dt><dd>The indexed entity. </dd></dl> |
---|
| 356 | </td> |
---|
| 357 | </tr> |
---|
| 358 | </table> |
---|
| 359 | <a class="anchor" name="b79bd9b55bce87bcb597a3343a94957a"></a><!-- doxytag: member="FCDLibrary::GetEntityCount" ref="b79bd9b55bce87bcb597a3343a94957a" args="() const " --><p> |
---|
| 360 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 361 | <tr> |
---|
| 362 | <td class="mdRow"> |
---|
| 363 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 364 | <tr> |
---|
| 365 | <td class="mdPrefix" colspan="4"> |
---|
| 366 | template<class T> </td> |
---|
| 367 | </tr> |
---|
| 368 | <tr> |
---|
| 369 | <td class="md" nowrap valign="top">size_t <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::GetEntityCount </td> |
---|
| 370 | <td class="md" valign="top">( </td> |
---|
| 371 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 372 | <td class="md" valign="top"> ) </td> |
---|
| 373 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 374 | </tr> |
---|
| 375 | </table> |
---|
| 376 | </td> |
---|
| 377 | </tr> |
---|
| 378 | </table> |
---|
| 379 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 380 | <tr> |
---|
| 381 | <td> |
---|
| 382 | |
---|
| 383 | </td> |
---|
| 384 | <td> |
---|
| 385 | |
---|
| 386 | <p> |
---|
| 387 | Retrieve the number of entities within the library. |
---|
| 388 | <p> |
---|
| 389 | <dl compact><dt><b>Returns:</b></dt><dd>the number of entities contained within the library. </dd></dl> |
---|
| 390 | </td> |
---|
| 391 | </tr> |
---|
| 392 | </table> |
---|
| 393 | <a class="anchor" name="6c0c8f49e36eb99b82f838231e013461"></a><!-- doxytag: member="FCDLibrary::GetPostProcessCmds" ref="6c0c8f49e36eb99b82f838231e013461" args="() const " --><p> |
---|
| 394 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 395 | <tr> |
---|
| 396 | <td class="mdRow"> |
---|
| 397 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 398 | <tr> |
---|
| 399 | <td class="mdPrefix" colspan="4"> |
---|
| 400 | template<class T> </td> |
---|
| 401 | </tr> |
---|
| 402 | <tr> |
---|
| 403 | <td class="md" nowrap valign="top"><a class="el" href="classvector.html">StringList</a> <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::GetPostProcessCmds </td> |
---|
| 404 | <td class="md" valign="top">( </td> |
---|
| 405 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 406 | <td class="md" valign="top"> ) </td> |
---|
| 407 | <td class="md" nowrap> const</td> |
---|
| 408 | </tr> |
---|
| 409 | </table> |
---|
| 410 | </td> |
---|
| 411 | </tr> |
---|
| 412 | </table> |
---|
| 413 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 414 | <tr> |
---|
| 415 | <td> |
---|
| 416 | |
---|
| 417 | </td> |
---|
| 418 | <td> |
---|
| 419 | |
---|
| 420 | <p> |
---|
| 421 | <dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>[INTERNAL] Retrieves the list of post-processing commands for the entities of this library. </dd></dl> |
---|
| 422 | <dl compact><dt><b>Returns:</b></dt><dd>The list of post-processing commands. </dd></dl> |
---|
| 423 | </td> |
---|
| 424 | </tr> |
---|
| 425 | </table> |
---|
| 426 | <a class="anchor" name="5045adb8f08e9a8f51fada3fdce63470"></a><!-- doxytag: member="FCDLibrary::IsEmpty" ref="5045adb8f08e9a8f51fada3fdce63470" args="() const " --><p> |
---|
| 427 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 428 | <tr> |
---|
| 429 | <td class="mdRow"> |
---|
| 430 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 431 | <tr> |
---|
| 432 | <td class="mdPrefix" colspan="4"> |
---|
| 433 | template<class T> </td> |
---|
| 434 | </tr> |
---|
| 435 | <tr> |
---|
| 436 | <td class="md" nowrap valign="top">bool <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::IsEmpty </td> |
---|
| 437 | <td class="md" valign="top">( </td> |
---|
| 438 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 439 | <td class="md" valign="top"> ) </td> |
---|
| 440 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 441 | </tr> |
---|
| 442 | </table> |
---|
| 443 | </td> |
---|
| 444 | </tr> |
---|
| 445 | </table> |
---|
| 446 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 447 | <tr> |
---|
| 448 | <td> |
---|
| 449 | |
---|
| 450 | </td> |
---|
| 451 | <td> |
---|
| 452 | |
---|
| 453 | <p> |
---|
| 454 | Returns whether the library contains no entities. |
---|
| 455 | <p> |
---|
| 456 | <dl compact><dt><b>Returns:</b></dt><dd>Whether the library is empty. </dd></dl> |
---|
| 457 | </td> |
---|
| 458 | </tr> |
---|
| 459 | </table> |
---|
| 460 | <a class="anchor" name="813347c0e988c025235eaeaf12400d1a"></a><!-- doxytag: member="FCDLibrary::LoadFromXML" ref="813347c0e988c025235eaeaf12400d1a" args="(xmlNode *node)" --><p> |
---|
| 461 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 462 | <tr> |
---|
| 463 | <td class="mdRow"> |
---|
| 464 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 465 | <tr> |
---|
| 466 | <td class="mdPrefix" colspan="4"> |
---|
| 467 | template<class T> </td> |
---|
| 468 | </tr> |
---|
| 469 | <tr> |
---|
| 470 | <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::LoadFromXML </td> |
---|
| 471 | <td class="md" valign="top">( </td> |
---|
| 472 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 473 | <td class="mdname1" valign="top" nowrap> <em>node</em> </td> |
---|
| 474 | <td class="md" valign="top"> ) </td> |
---|
| 475 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 476 | </tr> |
---|
| 477 | </table> |
---|
| 478 | </td> |
---|
| 479 | </tr> |
---|
| 480 | </table> |
---|
| 481 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 482 | <tr> |
---|
| 483 | <td> |
---|
| 484 | |
---|
| 485 | </td> |
---|
| 486 | <td> |
---|
| 487 | |
---|
| 488 | <p> |
---|
| 489 | [INTERNAL] Reads in the contents of the library from the COLLADA XML document. |
---|
| 490 | <p> |
---|
| 491 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 492 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 493 | <tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>The COLLADA XML tree node to parse into entities. </td></tr> |
---|
| 494 | </table> |
---|
| 495 | </dl> |
---|
| 496 | <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> |
---|
| 497 | |
---|
| 498 | <p> |
---|
| 499 | Reimplemented in <a class="el" href="class_f_c_d_material_library.html#f2ec5534ec180d596641d32b37754283">FCDMaterialLibrary</a>. </td> |
---|
| 500 | </tr> |
---|
| 501 | </table> |
---|
| 502 | <a class="anchor" name="3fbfbcf4ade5b9c94d2ee2f59db5921d"></a><!-- doxytag: member="FCDLibrary::ReleaseEntity" ref="3fbfbcf4ade5b9c94d2ee2f59db5921d" args="(T *entity)" --><p> |
---|
| 503 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 504 | <tr> |
---|
| 505 | <td class="mdRow"> |
---|
| 506 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 507 | <tr> |
---|
| 508 | <td class="mdPrefix" colspan="4"> |
---|
| 509 | template<class T> </td> |
---|
| 510 | </tr> |
---|
| 511 | <tr> |
---|
| 512 | <td class="md" nowrap valign="top">void <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::ReleaseEntity </td> |
---|
| 513 | <td class="md" valign="top">( </td> |
---|
| 514 | <td class="md" nowrap valign="top">T * </td> |
---|
| 515 | <td class="mdname1" valign="top" nowrap> <em>entity</em> </td> |
---|
| 516 | <td class="md" valign="top"> ) </td> |
---|
| 517 | <td class="md" nowrap></td> |
---|
| 518 | </tr> |
---|
| 519 | </table> |
---|
| 520 | </td> |
---|
| 521 | </tr> |
---|
| 522 | </table> |
---|
| 523 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 524 | <tr> |
---|
| 525 | <td> |
---|
| 526 | |
---|
| 527 | </td> |
---|
| 528 | <td> |
---|
| 529 | |
---|
| 530 | <p> |
---|
| 531 | Releases an entity contained within this library. |
---|
| 532 | <p> |
---|
| 533 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 534 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 535 | <tr><td valign="top"></td><td valign="top"><em>entity</em> </td><td>The entity to delete. </td></tr> |
---|
| 536 | </table> |
---|
| 537 | </dl> |
---|
| 538 | </td> |
---|
| 539 | </tr> |
---|
| 540 | </table> |
---|
| 541 | <a class="anchor" name="297ebf05ef14830be557ddf57909471f"></a><!-- doxytag: member="FCDLibrary::WriteToXML" ref="297ebf05ef14830be557ddf57909471f" args="(xmlNode *node) const " --><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="mdPrefix" colspan="4"> |
---|
| 548 | template<class T> </td> |
---|
| 549 | </tr> |
---|
| 550 | <tr> |
---|
| 551 | <td class="md" nowrap valign="top">void <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::WriteToXML </td> |
---|
| 552 | <td class="md" valign="top">( </td> |
---|
| 553 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 554 | <td class="mdname1" valign="top" nowrap> <em>node</em> </td> |
---|
| 555 | <td class="md" valign="top"> ) </td> |
---|
| 556 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 557 | </tr> |
---|
| 558 | </table> |
---|
| 559 | </td> |
---|
| 560 | </tr> |
---|
| 561 | </table> |
---|
| 562 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 563 | <tr> |
---|
| 564 | <td> |
---|
| 565 | |
---|
| 566 | </td> |
---|
| 567 | <td> |
---|
| 568 | |
---|
| 569 | <p> |
---|
| 570 | [INTERNAL] Writes out the library entities to the COLLADA XML document. |
---|
| 571 | <p> |
---|
| 572 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 573 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 574 | <tr><td valign="top"></td><td valign="top"><em>node</em> </td><td>The COLLADA XML tree node in which to write the library entities. </td></tr> |
---|
| 575 | </table> |
---|
| 576 | </dl> |
---|
| 577 | |
---|
| 578 | <p> |
---|
| 579 | Reimplemented in <a class="el" href="class_f_c_d_material_library.html#766ef8ca3c872cc24f6c21dedcf0d1f9">FCDMaterialLibrary</a>. </td> |
---|
| 580 | </tr> |
---|
| 581 | </table> |
---|
| 582 | <hr><h2>Member Data Documentation</h2> |
---|
| 583 | <a class="anchor" name="51f2628cd303aea6368029a8ce77a7e4"></a><!-- doxytag: member="FCDLibrary::entities" ref="51f2628cd303aea6368029a8ce77a7e4" args="" --><p> |
---|
| 584 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 585 | <tr> |
---|
| 586 | <td class="mdRow"> |
---|
| 587 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 588 | <tr> |
---|
| 589 | <td class="mdPrefix" colspan="4"> |
---|
| 590 | template<class T> </td> |
---|
| 591 | </tr> |
---|
| 592 | <tr> |
---|
| 593 | <td class="md" nowrap valign="top"><a class="el" href="classvector.html">FCDEntityList</a> <a class="el" href="class_f_c_d_library.html">FCDLibrary</a>< T >::<a class="el" href="class_f_c_d_library.html#51f2628cd303aea6368029a8ce77a7e4">entities</a><code> [protected]</code> </td> |
---|
| 594 | </tr> |
---|
| 595 | </table> |
---|
| 596 | </td> |
---|
| 597 | </tr> |
---|
| 598 | </table> |
---|
| 599 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 600 | <tr> |
---|
| 601 | <td> |
---|
| 602 | |
---|
| 603 | </td> |
---|
| 604 | <td> |
---|
| 605 | |
---|
| 606 | <p> |
---|
| 607 | Entities list. |
---|
| 608 | <p> |
---|
| 609 | This list should contain all the root entities of the correct type. Note that the following entity types are tree-based, rather than list-based: <a class="el" href="class_f_c_d_animation.html">FCDAnimation</a>, <a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a> and FCDPhysicsSceneNode. </td> |
---|
| 610 | </tr> |
---|
| 611 | </table> |
---|
| 612 | <hr>The documentation for this class was generated from the following files:<ul> |
---|
| 613 | <li>FCDocument/<a class="el" href="_f_c_d_library_8h-source.html">FCDLibrary.h</a><li>FCDocument/<a class="el" href="_f_c_d_library_8hpp-source.html">FCDLibrary.hpp</a></ul> |
---|
| 614 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by |
---|
| 615 | <a href="http://www.doxygen.org/index.html"> |
---|
| 616 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 617 | </body> |
---|
| 618 | </html> |
---|