[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: FCDEntity 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>FCDEntity 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="FCDEntity" --><!-- doxytag: inherits="FCDObjectWithId" -->A COLLADA entity. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_c_d_entity_8h-source.html">FCDEntity.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <p>Inheritance diagram for FCDEntity: |
---|
| 33 | <p><center><img src="class_f_c_d_entity.png" usemap="#FCDEntity_map" border="0" alt=""></center> |
---|
| 34 | <map name="FCDEntity_map"> |
---|
| 35 | <area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="0,112,119,136"> |
---|
| 36 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,119,80"> |
---|
| 37 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,119,24"> |
---|
| 38 | <area href="class_f_c_d_animation.html" alt="FCDAnimation" shape="rect" coords="129,224,248,248"> |
---|
| 39 | <area href="class_f_c_d_controller.html" alt="FCDController" shape="rect" coords="129,280,248,304"> |
---|
| 40 | <area href="class_f_c_d_effect.html" alt="FCDEffect" shape="rect" coords="129,336,248,360"> |
---|
| 41 | <area href="class_f_c_d_geometry.html" alt="FCDGeometry" shape="rect" coords="129,392,248,416"> |
---|
| 42 | <area href="class_f_c_d_image.html" alt="FCDImage" shape="rect" coords="129,448,248,472"> |
---|
| 43 | <area href="class_f_c_d_material.html" alt="FCDMaterial" shape="rect" coords="129,504,248,528"> |
---|
| 44 | <area href="class_f_c_d_scene_node.html" alt="FCDSceneNode" shape="rect" coords="129,560,248,584"> |
---|
| 45 | <area href="class_f_c_d_targeted_entity.html" alt="FCDTargetedEntity" shape="rect" coords="129,616,248,640"> |
---|
| 46 | <area href="class_f_c_d_texture.html" alt="FCDTexture" shape="rect" coords="129,672,248,696"> |
---|
| 47 | </map> |
---|
| 48 | <a href="class_f_c_d_entity-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 49 | <tr><td></td></tr> |
---|
| 50 | <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> |
---|
| 51 | <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.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> { <br> |
---|
| 52 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7d3c81776d7cbf8bc30f5a92aa1cdc6af">ENTITY</a>, |
---|
| 53 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7d056f9a0c0836aa9add7e10969736fd5">ANIMATION</a>, |
---|
| 54 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd771cf4ef98b4af310de2fca7cfd3c6b63">ANIMATION_CLIP</a>, |
---|
| 55 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7079dc3be01f63d3552374a7717f23f8f">CAMERA</a>, |
---|
| 56 | <br> |
---|
| 57 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7eaff98f940446b32b452289b0a79de71">LIGHT</a>, |
---|
| 58 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd79ad49c80c980e901cfefb18e037fce81">IMAGE</a>, |
---|
| 59 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7f1bcc6219cca12b1a3c805d5dac7a581">TEXTURE</a>, |
---|
| 60 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7f0658dd0aa3b5a1b0c5e3dc44c5d763c">MATERIAL</a>, |
---|
| 61 | <br> |
---|
| 62 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd725776f0c3122d297fd3b6026618d50af">EFFECT</a>, |
---|
| 63 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd799b17e5e6e7e9cdcb353bad7ff811c85">GEOMETRY</a>, |
---|
| 64 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7d1448b2688394292605bed327a679afe">CONTROLLER</a>, |
---|
| 65 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7d56e9eb11f4aa44893f27411ac9a2455">SCENE_NODE</a>, |
---|
| 66 | <br> |
---|
| 67 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7026283951793084a7a849e508857d603">PHYSICS_RIGID_CONSTRAINT</a>, |
---|
| 68 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7e754a84e2c8b4c525e8207e0a971b89c">PHYSICS_MATERIAL</a>, |
---|
| 69 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd79bc7a8ae178d5f9cb06111b4d51240d0">PHYSICS_RIGID_BODY</a>, |
---|
| 70 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7d4b1f4af3fdb3f4b7a0188437749baf7">PHYSICS_SHAPE</a>, |
---|
| 71 | <br> |
---|
| 72 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd784bd56ee18a6f6e1118f89078714a761">PHYSICS_ANALYTICAL_GEOMETRY</a>, |
---|
| 73 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7cc96ac70dd041d7bf674e18c11d628af">PHYSICS_MODEL</a>, |
---|
| 74 | <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd73f3aa51d0684a57da181845722e8cc1f">PHYSICS_SCENE_NODE</a> |
---|
| 75 | <br> |
---|
| 76 | }</td></tr> |
---|
| 77 | |
---|
| 78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The types of entity classes. <a href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">More...</a><br></td></tr> |
---|
| 79 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 80 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#d302a33b87642d93072c49b385ab93a0">FCDEntity</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document, const char *baseId="GenericEntity")</td></tr> |
---|
| 81 | |
---|
| 82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#d302a33b87642d93072c49b385ab93a0"></a><br></td></tr> |
---|
| 83 | <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.html#0f1748712f4532d1a32cc2adc73e04f1">~FCDEntity</a> ()</td></tr> |
---|
| 84 | |
---|
| 85 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#0f1748712f4532d1a32cc2adc73e04f1"></a><br></td></tr> |
---|
| 86 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#bfd4312a7124f92364c1e6517c7e60ba">GetType</a> () const </td></tr> |
---|
| 87 | |
---|
| 88 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the entity class type for an entity. <a href="#bfd4312a7124f92364c1e6517c7e60ba"></a><br></td></tr> |
---|
| 89 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const fstring & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#35cfd66b81c3cdf9024077f36e076db3">GetName</a> () const </td></tr> |
---|
| 90 | |
---|
| 91 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the name of the entity. <a href="#35cfd66b81c3cdf9024077f36e076db3"></a><br></td></tr> |
---|
| 92 | <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.html#1babd49b4bd5c3165932d8c390dae61e">SetName</a> (const fstring &_name)</td></tr> |
---|
| 93 | |
---|
| 94 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the name of the entity. <a href="#1babd49b4bd5c3165932d8c390dae61e"></a><br></td></tr> |
---|
| 95 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_extra.html">FCDExtra</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#2f05f99564ddf44896602ef020a3b5c1">GetExtra</a> ()</td></tr> |
---|
| 96 | |
---|
| 97 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the extra information tree for this entity. <a href="#2f05f99564ddf44896602ef020a3b5c1"></a><br></td></tr> |
---|
| 98 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9198b84815c826fed3d872c72b1c6137"></a><!-- doxytag: member="FCDEntity::GetExtra" ref="9198b84815c826fed3d872c72b1c6137" args="() const " --> |
---|
| 99 | const <a class="el" href="class_f_c_d_extra.html">FCDExtra</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#9198b84815c826fed3d872c72b1c6137">GetExtra</a> () const </td></tr> |
---|
| 100 | |
---|
| 101 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 102 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#8026453fbf365692639dfdeda0dca56c">HasNote</a> () const </td></tr> |
---|
| 103 | |
---|
| 104 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether the entity has a user-defined note. <a href="#8026453fbf365692639dfdeda0dca56c"></a><br></td></tr> |
---|
| 105 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const fstring & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#6fd8e55a6281c971d63711b24d8f02db">GetNote</a> () const </td></tr> |
---|
| 106 | |
---|
| 107 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the user-defined note for this entity. <a href="#6fd8e55a6281c971d63711b24d8f02db"></a><br></td></tr> |
---|
| 108 | <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.html#8589906fc686e63486db9bc8e899f794">SetNote</a> (const fstring &_note)</td></tr> |
---|
| 109 | |
---|
| 110 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the user-defined note for this entity. <a href="#8589906fc686e63486db9bc8e899f794"></a><br></td></tr> |
---|
| 111 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <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.html#90832c3838b2eaf5e5b346052ec2331e">FindDaeId</a> (const string &daeId)</td></tr> |
---|
| 112 | |
---|
| 113 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the child entity that has the given COLLADA id. <a href="#90832c3838b2eaf5e5b346052ec2331e"></a><br></td></tr> |
---|
| 114 | <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.html#8e32fcc93de76acc4b606db7b5b83890">LoadFromXML</a> (xmlNode *entityNode)</td></tr> |
---|
| 115 | |
---|
| 116 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the entity from a given COLLADA XML tree node. <a href="#8e32fcc93de76acc4b606db7b5b83890"></a><br></td></tr> |
---|
| 117 | <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.html#b27f0c175c3f8fd7064cde48bcf1d7a0">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
| 118 | |
---|
| 119 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the entity to the given COLLADA XML tree node. <a href="#b27f0c175c3f8fd7064cde48bcf1d7a0"></a><br></td></tr> |
---|
| 120 | <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_entity.html#4865b5a1ea13ba0a7aa786bc969e6ea7">GetPostProcessCmds</a> ()</td></tr> |
---|
| 121 | |
---|
| 122 | <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> |
---|
| 123 | <tr><td class="memItemLeft" nowrap align="right" valign="top">xmlNode * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_entity.html#bccbbbc034522a6e42e6210c7283b5aa">WriteToEntityXML</a> (xmlNode *parentNode, const char *nodeName) const </td></tr> |
---|
| 124 | |
---|
| 125 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the top entity XML node for the entity. <a href="#bccbbbc034522a6e42e6210c7283b5aa"></a><br></td></tr> |
---|
| 126 | <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.html#b82692555f17ba8ba2e1d33ab50318a4">WriteToExtraXML</a> (xmlNode *entityNode) const </td></tr> |
---|
| 127 | |
---|
| 128 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the extra information for the entity. <a href="#b82692555f17ba8ba2e1d33ab50318a4"></a><br></td></tr> |
---|
| 129 | <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.html#c1d7dc557e79f42de2b9f951ff3cffcc">Clone</a> (<a class="el" href="class_f_c_d_entity.html">FCDEntity</a> *clone)</td></tr> |
---|
| 130 | |
---|
| 131 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Copies the entity information into a cloned entity. <a href="#c1d7dc557e79f42de2b9f951ff3cffcc"></a><br></td></tr> |
---|
| 132 | </table> |
---|
| 133 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 134 | A COLLADA entity. |
---|
| 135 | <p> |
---|
| 136 | A COLLADA entity is an object contained within a COLLADA library. As such, it is based on the <a class="el" href="class_f_c_d_object_with_id.html">FCDObjectWithId</a> class so that it can be accessed by other entities, such as the scene graph.<p> |
---|
| 137 | The entity adds to the <a class="el" href="class_f_c_d_object_with_id.html">FCDObjectWithId</a> class: a name, an extra tree and an optional note, as well as a way to identity the type of the entity, in order to up-cast it to its correct class. |
---|
| 138 | <p> |
---|
| 139 | <hr><h2>Member Enumeration Documentation</h2> |
---|
| 140 | <a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7"></a><!-- doxytag: member="FCDEntity::Type" ref="9301a4bd5f4d4190ec13e40db4effdd7" args="" --><p> |
---|
| 141 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 142 | <tr> |
---|
| 143 | <td class="mdRow"> |
---|
| 144 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 145 | <tr> |
---|
| 146 | <td class="md" nowrap valign="top">enum <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">FCDEntity::Type</a> </td> |
---|
| 147 | </tr> |
---|
| 148 | </table> |
---|
| 149 | </td> |
---|
| 150 | </tr> |
---|
| 151 | </table> |
---|
| 152 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 153 | <tr> |
---|
| 154 | <td> |
---|
| 155 | |
---|
| 156 | </td> |
---|
| 157 | <td> |
---|
| 158 | |
---|
| 159 | <p> |
---|
| 160 | The types of entity classes. |
---|
| 161 | <p> |
---|
| 162 | Each type corresponds directly to one class that contains the <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> class as a parent, so you can up-cast <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> pointers. <dl compact><dt><b>Enumerator: </b></dt><dd> |
---|
| 163 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 164 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7d3c81776d7cbf8bc30f5a92aa1cdc6af"></a><!-- doxytag: member="ENTITY" ref="9301a4bd5f4d4190ec13e40db4effdd7d3c81776d7cbf8bc30f5a92aa1cdc6af" args="" -->ENTITY</em> </td><td> |
---|
| 165 | A generic entity (<a class="el" href="class_f_c_d_entity.html">FCDEntity</a>). |
---|
| 166 | <p> |
---|
| 167 | Should never be used. </td></tr> |
---|
| 168 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7d056f9a0c0836aa9add7e10969736fd5"></a><!-- doxytag: member="ANIMATION" ref="9301a4bd5f4d4190ec13e40db4effdd7d056f9a0c0836aa9add7e10969736fd5" args="" -->ANIMATION</em> </td><td> |
---|
| 169 | An animation (<a class="el" href="class_f_c_d_animation.html">FCDAnimation</a>). </td></tr> |
---|
| 170 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd771cf4ef98b4af310de2fca7cfd3c6b63"></a><!-- doxytag: member="ANIMATION_CLIP" ref="9301a4bd5f4d4190ec13e40db4effdd771cf4ef98b4af310de2fca7cfd3c6b63" args="" -->ANIMATION_CLIP</em> </td><td> |
---|
| 171 | An animation clip (FCDAnimationClip). </td></tr> |
---|
| 172 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7079dc3be01f63d3552374a7717f23f8f"></a><!-- doxytag: member="CAMERA" ref="9301a4bd5f4d4190ec13e40db4effdd7079dc3be01f63d3552374a7717f23f8f" args="" -->CAMERA</em> </td><td> |
---|
| 173 | A camera (<a class="el" href="class_f_c_d_camera.html">FCDCamera</a>). </td></tr> |
---|
| 174 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7eaff98f940446b32b452289b0a79de71"></a><!-- doxytag: member="LIGHT" ref="9301a4bd5f4d4190ec13e40db4effdd7eaff98f940446b32b452289b0a79de71" args="" -->LIGHT</em> </td><td> |
---|
| 175 | A light (<a class="el" href="class_f_c_d_light.html">FCDLight</a>). </td></tr> |
---|
| 176 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd79ad49c80c980e901cfefb18e037fce81"></a><!-- doxytag: member="IMAGE" ref="9301a4bd5f4d4190ec13e40db4effdd79ad49c80c980e901cfefb18e037fce81" args="" -->IMAGE</em> </td><td> |
---|
| 177 | An image (<a class="el" href="class_f_c_d_image.html">FCDImage</a>). </td></tr> |
---|
| 178 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7f1bcc6219cca12b1a3c805d5dac7a581"></a><!-- doxytag: member="TEXTURE" ref="9301a4bd5f4d4190ec13e40db4effdd7f1bcc6219cca12b1a3c805d5dac7a581" args="" -->TEXTURE</em> </td><td> |
---|
| 179 | A texture (<a class="el" href="class_f_c_d_texture.html">FCDTexture</a>). |
---|
| 180 | <p> |
---|
| 181 | Used for COLLADA 1.3 backward compatibility only! </td></tr> |
---|
| 182 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7f0658dd0aa3b5a1b0c5e3dc44c5d763c"></a><!-- doxytag: member="MATERIAL" ref="9301a4bd5f4d4190ec13e40db4effdd7f0658dd0aa3b5a1b0c5e3dc44c5d763c" args="" -->MATERIAL</em> </td><td> |
---|
| 183 | A visual material definition (<a class="el" href="class_f_c_d_material.html">FCDMaterial</a>). </td></tr> |
---|
| 184 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd725776f0c3122d297fd3b6026618d50af"></a><!-- doxytag: member="EFFECT" ref="9301a4bd5f4d4190ec13e40db4effdd725776f0c3122d297fd3b6026618d50af" args="" -->EFFECT</em> </td><td> |
---|
| 185 | An effect definition (<a class="el" href="class_f_c_d_effect.html">FCDEffect</a>). </td></tr> |
---|
| 186 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd799b17e5e6e7e9cdcb353bad7ff811c85"></a><!-- doxytag: member="GEOMETRY" ref="9301a4bd5f4d4190ec13e40db4effdd799b17e5e6e7e9cdcb353bad7ff811c85" args="" -->GEOMETRY</em> </td><td> |
---|
| 187 | A geometric object (<a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a>). |
---|
| 188 | <p> |
---|
| 189 | Includes splines and meshes. </td></tr> |
---|
| 190 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7d1448b2688394292605bed327a679afe"></a><!-- doxytag: member="CONTROLLER" ref="9301a4bd5f4d4190ec13e40db4effdd7d1448b2688394292605bed327a679afe" args="" -->CONTROLLER</em> </td><td> |
---|
| 191 | A geometric controller (<a class="el" href="class_f_c_d_controller.html">FCDController</a>). |
---|
| 192 | <p> |
---|
| 193 | Includes skins and morphers. </td></tr> |
---|
| 194 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7d56e9eb11f4aa44893f27411ac9a2455"></a><!-- doxytag: member="SCENE_NODE" ref="9301a4bd5f4d4190ec13e40db4effdd7d56e9eb11f4aa44893f27411ac9a2455" args="" -->SCENE_NODE</em> </td><td> |
---|
| 195 | A visual scene node (<a class="el" href="class_f_c_d_scene_node.html">FCDSceneNode</a>). </td></tr> |
---|
| 196 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7026283951793084a7a849e508857d603"></a><!-- doxytag: member="PHYSICS_RIGID_CONSTRAINT" ref="9301a4bd5f4d4190ec13e40db4effdd7026283951793084a7a849e508857d603" args="" -->PHYSICS_RIGID_CONSTRAINT</em> </td><td> |
---|
| 197 | A physics rigid constraint (FCDPhysicsRigidConstraint). </td></tr> |
---|
| 198 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7e754a84e2c8b4c525e8207e0a971b89c"></a><!-- doxytag: member="PHYSICS_MATERIAL" ref="9301a4bd5f4d4190ec13e40db4effdd7e754a84e2c8b4c525e8207e0a971b89c" args="" -->PHYSICS_MATERIAL</em> </td><td> |
---|
| 199 | A physics material definiton (FCDPhysicsMaterial). </td></tr> |
---|
| 200 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd79bc7a8ae178d5f9cb06111b4d51240d0"></a><!-- doxytag: member="PHYSICS_RIGID_BODY" ref="9301a4bd5f4d4190ec13e40db4effdd79bc7a8ae178d5f9cb06111b4d51240d0" args="" -->PHYSICS_RIGID_BODY</em> </td><td> |
---|
| 201 | A physics rigid body (FCDPhysicsRigidBody). </td></tr> |
---|
| 202 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7d4b1f4af3fdb3f4b7a0188437749baf7"></a><!-- doxytag: member="PHYSICS_SHAPE" ref="9301a4bd5f4d4190ec13e40db4effdd7d4b1f4af3fdb3f4b7a0188437749baf7" args="" -->PHYSICS_SHAPE</em> </td><td> |
---|
| 203 | A physics shape (FCDPhysicsShape). </td></tr> |
---|
| 204 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd784bd56ee18a6f6e1118f89078714a761"></a><!-- doxytag: member="PHYSICS_ANALYTICAL_GEOMETRY" ref="9301a4bd5f4d4190ec13e40db4effdd784bd56ee18a6f6e1118f89078714a761" args="" -->PHYSICS_ANALYTICAL_GEOMETRY</em> </td><td> |
---|
| 205 | A physics analytical geometric object (FCDPhysicsAnalyticalGeometry). </td></tr> |
---|
| 206 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd7cc96ac70dd041d7bf674e18c11d628af"></a><!-- doxytag: member="PHYSICS_MODEL" ref="9301a4bd5f4d4190ec13e40db4effdd7cc96ac70dd041d7bf674e18c11d628af" args="" -->PHYSICS_MODEL</em> </td><td> |
---|
| 207 | A physics model (FCDPhysicsModel). </td></tr> |
---|
| 208 | <tr><td valign="top"><em><a class="anchor" name="9301a4bd5f4d4190ec13e40db4effdd73f3aa51d0684a57da181845722e8cc1f"></a><!-- doxytag: member="PHYSICS_SCENE_NODE" ref="9301a4bd5f4d4190ec13e40db4effdd73f3aa51d0684a57da181845722e8cc1f" args="" -->PHYSICS_SCENE_NODE</em> </td><td> |
---|
| 209 | A physics scene node (FCDPhysicsSceneNode). </td></tr> |
---|
| 210 | </table> |
---|
| 211 | </dl> |
---|
| 212 | </td> |
---|
| 213 | </tr> |
---|
| 214 | </table> |
---|
| 215 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 216 | <a class="anchor" name="d302a33b87642d93072c49b385ab93a0"></a><!-- doxytag: member="FCDEntity::FCDEntity" ref="d302a33b87642d93072c49b385ab93a0" args="(FCDocument *document, const char *baseId="GenericEntity")" --><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">FCDEntity::FCDEntity </td> |
---|
| 223 | <td class="md" valign="top">( </td> |
---|
| 224 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 225 | <td class="mdname" nowrap> <em>document</em>, </td> |
---|
| 226 | </tr> |
---|
| 227 | <tr> |
---|
| 228 | <td class="md" nowrap align="right"></td> |
---|
| 229 | <td class="md"></td> |
---|
| 230 | <td class="md" nowrap>const char * </td> |
---|
| 231 | <td class="mdname" nowrap> <em>baseId</em> = <code>"GenericEntity"</code></td> |
---|
| 232 | </tr> |
---|
| 233 | <tr> |
---|
| 234 | <td class="md"></td> |
---|
| 235 | <td class="md">) </td> |
---|
| 236 | <td class="md" colspan="2"></td> |
---|
| 237 | </tr> |
---|
| 238 | </table> |
---|
| 239 | </td> |
---|
| 240 | </tr> |
---|
| 241 | </table> |
---|
| 242 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 243 | <tr> |
---|
| 244 | <td> |
---|
| 245 | |
---|
| 246 | </td> |
---|
| 247 | <td> |
---|
| 248 | |
---|
| 249 | <p> |
---|
| 250 | Constructor: do not use directly. |
---|
| 251 | <p> |
---|
| 252 | Instead, create objects of the up-classes. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 253 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 254 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the entity. </td></tr> |
---|
| 255 | <tr><td valign="top"></td><td valign="top"><em>baseId</em> </td><td>The prefix COLLADA id to be used if no COLLADA id is provided. </td></tr> |
---|
| 256 | </table> |
---|
| 257 | </dl> |
---|
| 258 | </td> |
---|
| 259 | </tr> |
---|
| 260 | </table> |
---|
| 261 | <a class="anchor" name="0f1748712f4532d1a32cc2adc73e04f1"></a><!-- doxytag: member="FCDEntity::~FCDEntity" ref="0f1748712f4532d1a32cc2adc73e04f1" args="()" --><p> |
---|
| 262 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 263 | <tr> |
---|
| 264 | <td class="mdRow"> |
---|
| 265 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 266 | <tr> |
---|
| 267 | <td class="md" nowrap valign="top">virtual FCDEntity::~FCDEntity </td> |
---|
| 268 | <td class="md" valign="top">( </td> |
---|
| 269 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 270 | <td class="md" valign="top"> ) </td> |
---|
| 271 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 272 | </tr> |
---|
| 273 | </table> |
---|
| 274 | </td> |
---|
| 275 | </tr> |
---|
| 276 | </table> |
---|
| 277 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 278 | <tr> |
---|
| 279 | <td> |
---|
| 280 | |
---|
| 281 | </td> |
---|
| 282 | <td> |
---|
| 283 | |
---|
| 284 | <p> |
---|
| 285 | Destructor: do not use directly. |
---|
| 286 | <p> |
---|
| 287 | Instead, release objects through their libraries or their parent entities. </td> |
---|
| 288 | </tr> |
---|
| 289 | </table> |
---|
| 290 | <hr><h2>Member Function Documentation</h2> |
---|
| 291 | <a class="anchor" name="c1d7dc557e79f42de2b9f951ff3cffcc"></a><!-- doxytag: member="FCDEntity::Clone" ref="c1d7dc557e79f42de2b9f951ff3cffcc" args="(FCDEntity *clone)" --><p> |
---|
| 292 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 293 | <tr> |
---|
| 294 | <td class="mdRow"> |
---|
| 295 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 296 | <tr> |
---|
| 297 | <td class="md" nowrap valign="top">void FCDEntity::Clone </td> |
---|
| 298 | <td class="md" valign="top">( </td> |
---|
| 299 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_entity.html">FCDEntity</a> * </td> |
---|
| 300 | <td class="mdname1" valign="top" nowrap> <em>clone</em> </td> |
---|
| 301 | <td class="md" valign="top"> ) </td> |
---|
| 302 | <td class="md" nowrap><code> [protected]</code></td> |
---|
| 303 | </tr> |
---|
| 304 | </table> |
---|
| 305 | </td> |
---|
| 306 | </tr> |
---|
| 307 | </table> |
---|
| 308 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 309 | <tr> |
---|
| 310 | <td> |
---|
| 311 | |
---|
| 312 | </td> |
---|
| 313 | <td> |
---|
| 314 | |
---|
| 315 | <p> |
---|
| 316 | [INTERNAL] Copies the entity information into a cloned entity. |
---|
| 317 | <p> |
---|
| 318 | This function should be used by all up-classes when cloning an entity to copy the COLLADA id and the other entity-level information into a clone. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 319 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 320 | <tr><td valign="top"></td><td valign="top"><em>clone</em> </td><td>The cloned entity. </td></tr> |
---|
| 321 | </table> |
---|
| 322 | </dl> |
---|
| 323 | </td> |
---|
| 324 | </tr> |
---|
| 325 | </table> |
---|
| 326 | <a class="anchor" name="90832c3838b2eaf5e5b346052ec2331e"></a><!-- doxytag: member="FCDEntity::FindDaeId" ref="90832c3838b2eaf5e5b346052ec2331e" args="(const string &daeId)" --><p> |
---|
| 327 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 328 | <tr> |
---|
| 329 | <td class="mdRow"> |
---|
| 330 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 331 | <tr> |
---|
| 332 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html">FCDEntity</a>* FCDEntity::FindDaeId </td> |
---|
| 333 | <td class="md" valign="top">( </td> |
---|
| 334 | <td class="md" nowrap valign="top">const string & </td> |
---|
| 335 | <td class="mdname1" valign="top" nowrap> <em>daeId</em> </td> |
---|
| 336 | <td class="md" valign="top"> ) </td> |
---|
| 337 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 338 | </tr> |
---|
| 339 | </table> |
---|
| 340 | </td> |
---|
| 341 | </tr> |
---|
| 342 | </table> |
---|
| 343 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 344 | <tr> |
---|
| 345 | <td> |
---|
| 346 | |
---|
| 347 | </td> |
---|
| 348 | <td> |
---|
| 349 | |
---|
| 350 | <p> |
---|
| 351 | Retrieves the child entity that has the given COLLADA id. |
---|
| 352 | <p> |
---|
| 353 | This function is only useful for entities that are hierarchical: visual/physics scene nodes and animations. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 354 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 355 | <tr><td valign="top"></td><td valign="top"><em>daeId</em> </td><td>A COLLADA id. </td></tr> |
---|
| 356 | </table> |
---|
| 357 | </dl> |
---|
| 358 | <dl compact><dt><b>Returns:</b></dt><dd>The child entity with the given id. This pointer will be NULL if no child entity matches the given id. </dd></dl> |
---|
| 359 | |
---|
| 360 | <p> |
---|
| 361 | Reimplemented in <a class="el" href="class_f_c_d_animation.html#4e6f0b0bed8af740da705b3d90716b04">FCDAnimation</a>, and <a class="el" href="class_f_c_d_scene_node.html#bb12a38d1f2c6c38b719dff8f21d9cd5">FCDSceneNode</a>. </td> |
---|
| 362 | </tr> |
---|
| 363 | </table> |
---|
| 364 | <a class="anchor" name="2f05f99564ddf44896602ef020a3b5c1"></a><!-- doxytag: member="FCDEntity::GetExtra" ref="2f05f99564ddf44896602ef020a3b5c1" args="()" --><p> |
---|
| 365 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 366 | <tr> |
---|
| 367 | <td class="mdRow"> |
---|
| 368 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 369 | <tr> |
---|
| 370 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_extra.html">FCDExtra</a>* FCDEntity::GetExtra </td> |
---|
| 371 | <td class="md" valign="top">( </td> |
---|
| 372 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 373 | <td class="md" valign="top"> ) </td> |
---|
| 374 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 375 | </tr> |
---|
| 376 | </table> |
---|
| 377 | </td> |
---|
| 378 | </tr> |
---|
| 379 | </table> |
---|
| 380 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 381 | <tr> |
---|
| 382 | <td> |
---|
| 383 | |
---|
| 384 | </td> |
---|
| 385 | <td> |
---|
| 386 | |
---|
| 387 | <p> |
---|
| 388 | Retrieves the extra information tree for this entity. |
---|
| 389 | <p> |
---|
| 390 | The prefered way to save extra information in <a class="el" href="namespace_f_collada.html">FCollada</a> is at the entity level. Use this extra information tree to store any information you want exported and imported back. <dl compact><dt><b>Returns:</b></dt><dd>The extra information tree. </dd></dl> |
---|
| 391 | </td> |
---|
| 392 | </tr> |
---|
| 393 | </table> |
---|
| 394 | <a class="anchor" name="35cfd66b81c3cdf9024077f36e076db3"></a><!-- doxytag: member="FCDEntity::GetName" ref="35cfd66b81c3cdf9024077f36e076db3" args="() const " --><p> |
---|
| 395 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 396 | <tr> |
---|
| 397 | <td class="mdRow"> |
---|
| 398 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 399 | <tr> |
---|
| 400 | <td class="md" nowrap valign="top">const fstring& FCDEntity::GetName </td> |
---|
| 401 | <td class="md" valign="top">( </td> |
---|
| 402 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 403 | <td class="md" valign="top"> ) </td> |
---|
| 404 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 405 | </tr> |
---|
| 406 | </table> |
---|
| 407 | </td> |
---|
| 408 | </tr> |
---|
| 409 | </table> |
---|
| 410 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 411 | <tr> |
---|
| 412 | <td> |
---|
| 413 | |
---|
| 414 | </td> |
---|
| 415 | <td> |
---|
| 416 | |
---|
| 417 | <p> |
---|
| 418 | Retrieves the name of the entity. |
---|
| 419 | <p> |
---|
| 420 | This value has no direct use in COLLADA but is useful to track the user-friendly name of an entity. <dl compact><dt><b>Returns:</b></dt><dd>The name. </dd></dl> |
---|
| 421 | </td> |
---|
| 422 | </tr> |
---|
| 423 | </table> |
---|
| 424 | <a class="anchor" name="6fd8e55a6281c971d63711b24d8f02db"></a><!-- doxytag: member="FCDEntity::GetNote" ref="6fd8e55a6281c971d63711b24d8f02db" args="() const " --><p> |
---|
| 425 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 426 | <tr> |
---|
| 427 | <td class="mdRow"> |
---|
| 428 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 429 | <tr> |
---|
| 430 | <td class="md" nowrap valign="top">const fstring& FCDEntity::GetNote </td> |
---|
| 431 | <td class="md" valign="top">( </td> |
---|
| 432 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 433 | <td class="md" valign="top"> ) </td> |
---|
| 434 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 435 | </tr> |
---|
| 436 | </table> |
---|
| 437 | </td> |
---|
| 438 | </tr> |
---|
| 439 | </table> |
---|
| 440 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 441 | <tr> |
---|
| 442 | <td> |
---|
| 443 | |
---|
| 444 | </td> |
---|
| 445 | <td> |
---|
| 446 | |
---|
| 447 | <p> |
---|
| 448 | Retrieves the user-defined note for this entity. |
---|
| 449 | <p> |
---|
| 450 | This value is a simpler way, than the extra tree, to store user-defined information that does not belong in COLLADA. <dl compact><dt><b>Returns:</b></dt><dd>The user-defined note. </dd></dl> |
---|
| 451 | </td> |
---|
| 452 | </tr> |
---|
| 453 | </table> |
---|
| 454 | <a class="anchor" name="4865b5a1ea13ba0a7aa786bc969e6ea7"></a><!-- doxytag: member="FCDEntity::GetPostProcessCmds" ref="4865b5a1ea13ba0a7aa786bc969e6ea7" args="()" --><p> |
---|
| 455 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 456 | <tr> |
---|
| 457 | <td class="mdRow"> |
---|
| 458 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 459 | <tr> |
---|
| 460 | <td class="md" nowrap valign="top"><a class="el" href="classvector.html">StringList</a>& FCDEntity::GetPostProcessCmds </td> |
---|
| 461 | <td class="md" valign="top">( </td> |
---|
| 462 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 463 | <td class="md" valign="top"> ) </td> |
---|
| 464 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 465 | </tr> |
---|
| 466 | </table> |
---|
| 467 | </td> |
---|
| 468 | </tr> |
---|
| 469 | </table> |
---|
| 470 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 471 | <tr> |
---|
| 472 | <td> |
---|
| 473 | |
---|
| 474 | </td> |
---|
| 475 | <td> |
---|
| 476 | |
---|
| 477 | <p> |
---|
| 478 | <dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>Retrieves the like of post-processing commands. Used only in ColladaMaya and should be taken out. </dd></dl> |
---|
| 479 | <dl compact><dt><b>Returns:</b></dt><dd>The list of post-processing commands. </dd></dl> |
---|
| 480 | </td> |
---|
| 481 | </tr> |
---|
| 482 | </table> |
---|
| 483 | <a class="anchor" name="bfd4312a7124f92364c1e6517c7e60ba"></a><!-- doxytag: member="FCDEntity::GetType" ref="bfd4312a7124f92364c1e6517c7e60ba" args="() const " --><p> |
---|
| 484 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 485 | <tr> |
---|
| 486 | <td class="mdRow"> |
---|
| 487 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 488 | <tr> |
---|
| 489 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> FCDEntity::GetType </td> |
---|
| 490 | <td class="md" valign="top">( </td> |
---|
| 491 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 492 | <td class="md" valign="top"> ) </td> |
---|
| 493 | <td class="md" nowrap> const<code> [inline, virtual]</code></td> |
---|
| 494 | </tr> |
---|
| 495 | </table> |
---|
| 496 | </td> |
---|
| 497 | </tr> |
---|
| 498 | </table> |
---|
| 499 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 500 | <tr> |
---|
| 501 | <td> |
---|
| 502 | |
---|
| 503 | </td> |
---|
| 504 | <td> |
---|
| 505 | |
---|
| 506 | <p> |
---|
| 507 | Retrieves the entity class type for an entity. |
---|
| 508 | <p> |
---|
| 509 | You can use the entity class type of up-cast an entity pointer to the correct up-class. This function should be overwritten by all up-classes. <dl compact><dt><b>Returns:</b></dt><dd>The entity class type. </dd></dl> |
---|
| 510 | |
---|
| 511 | <p> |
---|
| 512 | Reimplemented in <a class="el" href="class_f_c_d_animation.html#91e3239617da238768340a8bf62b4132">FCDAnimation</a>, <a class="el" href="class_f_c_d_camera.html#a07c99de0148e39b46e33733852ef229">FCDCamera</a>, <a class="el" href="class_f_c_d_controller.html#2ff5b14d564dba7be26d3b8544bec93c">FCDController</a>, <a class="el" href="class_f_c_d_effect.html#b6106f67f33a4cb049ea17a1970bbfbe">FCDEffect</a>, <a class="el" href="class_f_c_d_geometry.html#220b50045d5a815dce0c1be69e06f926">FCDGeometry</a>, <a class="el" href="class_f_c_d_image.html#137caaacfc6ee0f82a4f654e142f23ea">FCDImage</a>, <a class="el" href="class_f_c_d_light.html#846e07aee92d19dd745a98462a9ffd74">FCDLight</a>, <a class="el" href="class_f_c_d_material.html#eeaf2e7f96a1b3efc7daac490b1e5e8f">FCDMaterial</a>, <a class="el" href="class_f_c_d_scene_node.html#5dad40efa762d2cb7b3df38288c7f5aa">FCDSceneNode</a>, and <a class="el" href="class_f_c_d_texture.html#e102500d840fa145c37cd05aa2f2d6c0">FCDTexture</a>. </td> |
---|
| 513 | </tr> |
---|
| 514 | </table> |
---|
| 515 | <a class="anchor" name="8026453fbf365692639dfdeda0dca56c"></a><!-- doxytag: member="FCDEntity::HasNote" ref="8026453fbf365692639dfdeda0dca56c" args="() const " --><p> |
---|
| 516 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 517 | <tr> |
---|
| 518 | <td class="mdRow"> |
---|
| 519 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 520 | <tr> |
---|
| 521 | <td class="md" nowrap valign="top">bool FCDEntity::HasNote </td> |
---|
| 522 | <td class="md" valign="top">( </td> |
---|
| 523 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 524 | <td class="md" valign="top"> ) </td> |
---|
| 525 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 526 | </tr> |
---|
| 527 | </table> |
---|
| 528 | </td> |
---|
| 529 | </tr> |
---|
| 530 | </table> |
---|
| 531 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 532 | <tr> |
---|
| 533 | <td> |
---|
| 534 | |
---|
| 535 | </td> |
---|
| 536 | <td> |
---|
| 537 | |
---|
| 538 | <p> |
---|
| 539 | Retrieves whether the entity has a user-defined note. |
---|
| 540 | <p> |
---|
| 541 | This value is a simpler way, than the extra tree, to store user-defined information that does not belong in COLLADA. <dl compact><dt><b>Returns:</b></dt><dd>Whether the entity has an user-defined note. </dd></dl> |
---|
| 542 | </td> |
---|
| 543 | </tr> |
---|
| 544 | </table> |
---|
| 545 | <a class="anchor" name="8e32fcc93de76acc4b606db7b5b83890"></a><!-- doxytag: member="FCDEntity::LoadFromXML" ref="8e32fcc93de76acc4b606db7b5b83890" args="(xmlNode *entityNode)" --><p> |
---|
| 546 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 547 | <tr> |
---|
| 548 | <td class="mdRow"> |
---|
| 549 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 550 | <tr> |
---|
| 551 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDEntity::LoadFromXML </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>entityNode</em> </td> |
---|
| 555 | <td class="md" valign="top"> ) </td> |
---|
| 556 | <td class="md" nowrap><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] Reads in the entity from a given COLLADA XML tree node. |
---|
| 571 | <p> |
---|
| 572 | This function should be overwritten by all up-classes. <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>entityNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
| 575 | </table> |
---|
| 576 | </dl> |
---|
| 577 | <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 entity. </dd></dl> |
---|
| 578 | |
---|
| 579 | <p> |
---|
| 580 | Reimplemented in <a class="el" href="class_f_c_d_animation.html#86215ba4422bac9a7267286f5bd6af8b">FCDAnimation</a>, <a class="el" href="class_f_c_d_camera.html#ebab35f1778fdc318896978b615d3ddb">FCDCamera</a>, <a class="el" href="class_f_c_d_controller.html#ee1a9db915a1b34ae6207d7215a751b4">FCDController</a>, <a class="el" href="class_f_c_d_effect.html#f7724b736d7d2fff3a3d94e16accf030">FCDEffect</a>, <a class="el" href="class_f_c_d_geometry.html#92a713bfe6e15e1629047007db7ad755">FCDGeometry</a>, <a class="el" href="class_f_c_d_image.html#99c1724e2dd75e6d877951e95ffebdc4">FCDImage</a>, <a class="el" href="class_f_c_d_light.html#d35cbe86393f360df9928be24482ba05">FCDLight</a>, <a class="el" href="class_f_c_d_material.html#9c14aec6b095e0a263635a41f037f331">FCDMaterial</a>, <a class="el" href="class_f_c_d_scene_node.html#1f24b3efe031d6195c2523d36ec127d7">FCDSceneNode</a>, and <a class="el" href="class_f_c_d_texture.html#f7eee6d6b67bfb5fabf46125579eac7b">FCDTexture</a>. </td> |
---|
| 581 | </tr> |
---|
| 582 | </table> |
---|
| 583 | <a class="anchor" name="1babd49b4bd5c3165932d8c390dae61e"></a><!-- doxytag: member="FCDEntity::SetName" ref="1babd49b4bd5c3165932d8c390dae61e" args="(const fstring &_name)" --><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="md" nowrap valign="top">void FCDEntity::SetName </td> |
---|
| 590 | <td class="md" valign="top">( </td> |
---|
| 591 | <td class="md" nowrap valign="top">const fstring & </td> |
---|
| 592 | <td class="mdname1" valign="top" nowrap> <em>_name</em> </td> |
---|
| 593 | <td class="md" valign="top"> ) </td> |
---|
| 594 | <td class="md" nowrap></td> |
---|
| 595 | </tr> |
---|
| 596 | </table> |
---|
| 597 | </td> |
---|
| 598 | </tr> |
---|
| 599 | </table> |
---|
| 600 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 601 | <tr> |
---|
| 602 | <td> |
---|
| 603 | |
---|
| 604 | </td> |
---|
| 605 | <td> |
---|
| 606 | |
---|
| 607 | <p> |
---|
| 608 | Sets the name of the entity. |
---|
| 609 | <p> |
---|
| 610 | This value has no direct use in COLLADA but is useful to track the user-friendly name of an entity. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 611 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 612 | <tr><td valign="top"></td><td valign="top"><em>_name</em> </td><td>The name. </td></tr> |
---|
| 613 | </table> |
---|
| 614 | </dl> |
---|
| 615 | </td> |
---|
| 616 | </tr> |
---|
| 617 | </table> |
---|
| 618 | <a class="anchor" name="8589906fc686e63486db9bc8e899f794"></a><!-- doxytag: member="FCDEntity::SetNote" ref="8589906fc686e63486db9bc8e899f794" args="(const fstring &_note)" --><p> |
---|
| 619 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 620 | <tr> |
---|
| 621 | <td class="mdRow"> |
---|
| 622 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 623 | <tr> |
---|
| 624 | <td class="md" nowrap valign="top">void FCDEntity::SetNote </td> |
---|
| 625 | <td class="md" valign="top">( </td> |
---|
| 626 | <td class="md" nowrap valign="top">const fstring & </td> |
---|
| 627 | <td class="mdname1" valign="top" nowrap> <em>_note</em> </td> |
---|
| 628 | <td class="md" valign="top"> ) </td> |
---|
| 629 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 630 | </tr> |
---|
| 631 | </table> |
---|
| 632 | </td> |
---|
| 633 | </tr> |
---|
| 634 | </table> |
---|
| 635 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 636 | <tr> |
---|
| 637 | <td> |
---|
| 638 | |
---|
| 639 | </td> |
---|
| 640 | <td> |
---|
| 641 | |
---|
| 642 | <p> |
---|
| 643 | Sets the user-defined note for this entity. |
---|
| 644 | <p> |
---|
| 645 | This value is a simpler way, than the extra tree, to store user-defined information that does not belong in COLLADA. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 646 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 647 | <tr><td valign="top"></td><td valign="top"><em>_note</em> </td><td>The user-defined note. </td></tr> |
---|
| 648 | </table> |
---|
| 649 | </dl> |
---|
| 650 | </td> |
---|
| 651 | </tr> |
---|
| 652 | </table> |
---|
| 653 | <a class="anchor" name="bccbbbc034522a6e42e6210c7283b5aa"></a><!-- doxytag: member="FCDEntity::WriteToEntityXML" ref="bccbbbc034522a6e42e6210c7283b5aa" args="(xmlNode *parentNode, const char *nodeName) const " --><p> |
---|
| 654 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 655 | <tr> |
---|
| 656 | <td class="mdRow"> |
---|
| 657 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 658 | <tr> |
---|
| 659 | <td class="md" nowrap valign="top">xmlNode* FCDEntity::WriteToEntityXML </td> |
---|
| 660 | <td class="md" valign="top">( </td> |
---|
| 661 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 662 | <td class="mdname" nowrap> <em>parentNode</em>, </td> |
---|
| 663 | </tr> |
---|
| 664 | <tr> |
---|
| 665 | <td class="md" nowrap align="right"></td> |
---|
| 666 | <td class="md"></td> |
---|
| 667 | <td class="md" nowrap>const char * </td> |
---|
| 668 | <td class="mdname" nowrap> <em>nodeName</em></td> |
---|
| 669 | </tr> |
---|
| 670 | <tr> |
---|
| 671 | <td class="md"></td> |
---|
| 672 | <td class="md">) </td> |
---|
| 673 | <td class="md" colspan="2"> const<code> [protected]</code></td> |
---|
| 674 | </tr> |
---|
| 675 | </table> |
---|
| 676 | </td> |
---|
| 677 | </tr> |
---|
| 678 | </table> |
---|
| 679 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 680 | <tr> |
---|
| 681 | <td> |
---|
| 682 | |
---|
| 683 | </td> |
---|
| 684 | <td> |
---|
| 685 | |
---|
| 686 | <p> |
---|
| 687 | [INTERNAL] Writes out the top entity XML node for the entity. |
---|
| 688 | <p> |
---|
| 689 | This function should be used by all up-classes within the WriteToXML overwritting function to create the top XML node, as it will write out the name and COLLADA id of the entity. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 690 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 691 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the entity. </td></tr> |
---|
| 692 | <tr><td valign="top"></td><td valign="top"><em>nodeName</em> </td><td>The COLLADA XML node name for the top entity XML node. </td></tr> |
---|
| 693 | </table> |
---|
| 694 | </dl> |
---|
| 695 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
| 696 | </td> |
---|
| 697 | </tr> |
---|
| 698 | </table> |
---|
| 699 | <a class="anchor" name="b82692555f17ba8ba2e1d33ab50318a4"></a><!-- doxytag: member="FCDEntity::WriteToExtraXML" ref="b82692555f17ba8ba2e1d33ab50318a4" args="(xmlNode *entityNode) const " --><p> |
---|
| 700 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 701 | <tr> |
---|
| 702 | <td class="mdRow"> |
---|
| 703 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 704 | <tr> |
---|
| 705 | <td class="md" nowrap valign="top">void FCDEntity::WriteToExtraXML </td> |
---|
| 706 | <td class="md" valign="top">( </td> |
---|
| 707 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 708 | <td class="mdname1" valign="top" nowrap> <em>entityNode</em> </td> |
---|
| 709 | <td class="md" valign="top"> ) </td> |
---|
| 710 | <td class="md" nowrap> const<code> [protected]</code></td> |
---|
| 711 | </tr> |
---|
| 712 | </table> |
---|
| 713 | </td> |
---|
| 714 | </tr> |
---|
| 715 | </table> |
---|
| 716 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 717 | <tr> |
---|
| 718 | <td> |
---|
| 719 | |
---|
| 720 | </td> |
---|
| 721 | <td> |
---|
| 722 | |
---|
| 723 | <p> |
---|
| 724 | [INTERNAL] Writes out the extra information for the entity. |
---|
| 725 | <p> |
---|
| 726 | This function should be used by all up-classes within the WriteToXML overwritting function, at the very end, to write the user-defined note and the extra tree to the COLLADA document. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 727 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 728 | <tr><td valign="top"></td><td valign="top"><em>entityNode</em> </td><td>The created element XML tree node returned by the WriteToEntityXML function. </td></tr> |
---|
| 729 | </table> |
---|
| 730 | </dl> |
---|
| 731 | </td> |
---|
| 732 | </tr> |
---|
| 733 | </table> |
---|
| 734 | <a class="anchor" name="b27f0c175c3f8fd7064cde48bcf1d7a0"></a><!-- doxytag: member="FCDEntity::WriteToXML" ref="b27f0c175c3f8fd7064cde48bcf1d7a0" args="(xmlNode *parentNode) const " --><p> |
---|
| 735 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 736 | <tr> |
---|
| 737 | <td class="mdRow"> |
---|
| 738 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 739 | <tr> |
---|
| 740 | <td class="md" nowrap valign="top">virtual xmlNode* FCDEntity::WriteToXML </td> |
---|
| 741 | <td class="md" valign="top">( </td> |
---|
| 742 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 743 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
| 744 | <td class="md" valign="top"> ) </td> |
---|
| 745 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 746 | </tr> |
---|
| 747 | </table> |
---|
| 748 | </td> |
---|
| 749 | </tr> |
---|
| 750 | </table> |
---|
| 751 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 752 | <tr> |
---|
| 753 | <td> |
---|
| 754 | |
---|
| 755 | </td> |
---|
| 756 | <td> |
---|
| 757 | |
---|
| 758 | <p> |
---|
| 759 | [INTERNAL] Writes out the entity to the given COLLADA XML tree node. |
---|
| 760 | <p> |
---|
| 761 | This function should be overwritten by all up-classes. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 762 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 763 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the entity. </td></tr> |
---|
| 764 | </table> |
---|
| 765 | </dl> |
---|
| 766 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
| 767 | |
---|
| 768 | <p> |
---|
| 769 | Reimplemented in <a class="el" href="class_f_c_d_animation.html#5380e6861a3e70ba3f580412e4badfa1">FCDAnimation</a>, <a class="el" href="class_f_c_d_camera.html#484c6439adab10baa2dbf558f99bd934">FCDCamera</a>, <a class="el" href="class_f_c_d_controller.html#5efadecf3bde08473bff01158a6bf5bb">FCDController</a>, <a class="el" href="class_f_c_d_effect.html#ac88481b0ad514d0a5ddeeedaef5aecb">FCDEffect</a>, <a class="el" href="class_f_c_d_geometry.html#86db49ab6648957309de6db9581981c1">FCDGeometry</a>, <a class="el" href="class_f_c_d_image.html#d894beaf27b521c96e5bbe982ab7e2f2">FCDImage</a>, <a class="el" href="class_f_c_d_light.html#6bd043e068522f2cc3411d0dfe6feea2">FCDLight</a>, <a class="el" href="class_f_c_d_material.html#6a7dd4f4a4d3b422f4177cf0a531014c">FCDMaterial</a>, and <a class="el" href="class_f_c_d_scene_node.html#bb247124a836a1bb99d015d7de8d6943">FCDSceneNode</a>. </td> |
---|
| 770 | </tr> |
---|
| 771 | </table> |
---|
| 772 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 773 | <li>FCDocument/<a class="el" href="_f_c_d_entity_8h-source.html">FCDEntity.h</a></ul> |
---|
| 774 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:42 2006 for FCollada by |
---|
| 775 | <a href="http://www.doxygen.org/index.html"> |
---|
| 776 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 777 | </body> |
---|
| 778 | </html> |
---|