[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: FCDController 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>FCDController Class Reference<br> |
---|
| 25 | <small> |
---|
| 26 | [<a class="el" href="group___f_c_d_geometry.html">COLLADA Document Geometry Entity</a>]</small> |
---|
| 27 | </h1><!-- doxytag: class="FCDController" --><!-- doxytag: inherits="FCDEntity" -->A generic COLLADA controller. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_c_d_controller_8h-source.html">FCDController.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <p>Inheritance diagram for FCDController: |
---|
| 33 | <p><center><img src="class_f_c_d_controller.png" usemap="#FCDController_map" border="0" alt=""></center> |
---|
| 34 | <map name="FCDController_map"> |
---|
| 35 | <area href="class_f_c_d_entity.html" alt="FCDEntity" shape="rect" coords="0,168,109,192"> |
---|
| 36 | <area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="0,112,109,136"> |
---|
| 37 | <area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,109,80"> |
---|
| 38 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,109,24"> |
---|
| 39 | </map> |
---|
| 40 | <a href="class_f_c_d_controller-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 41 | <tr><td></td></tr> |
---|
| 42 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 43 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#04573a2e038e54333ee86fcb3c18540c">FCDController</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
| 44 | |
---|
| 45 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: do not use directly. <a href="#04573a2e038e54333ee86fcb3c18540c"></a><br></td></tr> |
---|
| 46 | <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#7487659e2b1f2691551bfe0214c5c45d">~FCDController</a> ()</td></tr> |
---|
| 47 | |
---|
| 48 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor: do not use directly. <a href="#7487659e2b1f2691551bfe0214c5c45d"></a><br></td></tr> |
---|
| 49 | <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_controller.html#2ff5b14d564dba7be26d3b8544bec93c">GetType</a> () const </td></tr> |
---|
| 50 | |
---|
| 51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the entity class type. <a href="#2ff5b14d564dba7be26d3b8544bec93c"></a><br></td></tr> |
---|
| 52 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#47e50ce888468e74fb8919d4ba4c28af">HasSkinController</a> () const </td></tr> |
---|
| 53 | |
---|
| 54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether this controller is a skin controller. <a href="#47e50ce888468e74fb8919d4ba4c28af"></a><br></td></tr> |
---|
| 55 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#0b1ba93e37840d2828a84a050602ed22">HasMorphController</a> () const </td></tr> |
---|
| 56 | |
---|
| 57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether this controller is a morph controller. <a href="#0b1ba93e37840d2828a84a050602ed22"></a><br></td></tr> |
---|
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_skin_controller.html">FCDSkinController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#38ee749fe069c72add7d4c565288ce4e">CreateSkinController</a> ()</td></tr> |
---|
| 59 | |
---|
| 60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the type of this controller to a skin controller. <a href="#38ee749fe069c72add7d4c565288ce4e"></a><br></td></tr> |
---|
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#448ff15e64c4a2c88e89e372ee1a5f17">CreateMorphController</a> ()</td></tr> |
---|
| 62 | |
---|
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the type of this controller to a morph controller. <a href="#448ff15e64c4a2c88e89e372ee1a5f17"></a><br></td></tr> |
---|
| 64 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_skin_controller.html">FCDSkinController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#4088c1f8c04cd88fcafa1a82b2c9d587">GetSkinController</a> ()</td></tr> |
---|
| 65 | |
---|
| 66 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the skin controller. <a href="#4088c1f8c04cd88fcafa1a82b2c9d587"></a><br></td></tr> |
---|
| 67 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e53ae0573ac7e17cfa4718284f4ad7a7"></a><!-- doxytag: member="FCDController::GetSkinController" ref="e53ae0573ac7e17cfa4718284f4ad7a7" args="() const " --> |
---|
| 68 | const <a class="el" href="class_f_c_d_skin_controller.html">FCDSkinController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#e53ae0573ac7e17cfa4718284f4ad7a7">GetSkinController</a> () const </td></tr> |
---|
| 69 | |
---|
| 70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#6a7af0fbd38bb56cf3603e8674e4f445">GetMorphController</a> ()</td></tr> |
---|
| 72 | |
---|
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the morph controller. <a href="#6a7af0fbd38bb56cf3603e8674e4f445"></a><br></td></tr> |
---|
| 74 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="500f804426894dd04dcfd30657765305"></a><!-- doxytag: member="FCDController::GetMorphController" ref="500f804426894dd04dcfd30657765305" args="() const " --> |
---|
| 75 | const <a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#500f804426894dd04dcfd30657765305">GetMorphController</a> () const </td></tr> |
---|
| 76 | |
---|
| 77 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 78 | <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_controller.html#a1a9d7d644e011eeee20e1af57d11833">GetBaseTarget</a> ()</td></tr> |
---|
| 79 | |
---|
| 80 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the base target entity for this controller. <a href="#a1a9d7d644e011eeee20e1af57d11833"></a><br></td></tr> |
---|
| 81 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b03e9149e6c705e3e7a61dc0397e9f5c"></a><!-- doxytag: member="FCDController::GetBaseTarget" ref="b03e9149e6c705e3e7a61dc0397e9f5c" args="() const " --> |
---|
| 82 | 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_controller.html#b03e9149e6c705e3e7a61dc0397e9f5c">GetBaseTarget</a> () const </td></tr> |
---|
| 83 | |
---|
| 84 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 85 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#407cb338a97fee2bd37ebc7899ee40a8">GetBaseGeometry</a> ()</td></tr> |
---|
| 86 | |
---|
| 87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the base target geometry for this controller. <a href="#407cb338a97fee2bd37ebc7899ee40a8"></a><br></td></tr> |
---|
| 88 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="40e5d81b41f1ab831f45d5457c01b164"></a><!-- doxytag: member="FCDController::GetBaseGeometry" ref="40e5d81b41f1ab831f45d5457c01b164" args="() const " --> |
---|
| 89 | const <a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#40e5d81b41f1ab831f45d5457c01b164">GetBaseGeometry</a> () const </td></tr> |
---|
| 90 | |
---|
| 91 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 92 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const string & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_controller.html#4c4d583b681d3a1a91622b454d2afd60">GetTargetId</a> () const </td></tr> |
---|
| 93 | |
---|
| 94 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Retrieves the COLLADA id of the target entity. <a href="#4c4d583b681d3a1a91622b454d2afd60"></a><br></td></tr> |
---|
| 95 | <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_controller.html#ee1a9db915a1b34ae6207d7215a751b4">LoadFromXML</a> (xmlNode *controllerNode)</td></tr> |
---|
| 96 | |
---|
| 97 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Reads in the <controller> element from a given COLLADA XML tree node. <a href="#ee1a9db915a1b34ae6207d7215a751b4"></a><br></td></tr> |
---|
| 98 | <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_controller.html#5efadecf3bde08473bff01158a6bf5bb">WriteToXML</a> (xmlNode *parentNode) const </td></tr> |
---|
| 99 | |
---|
| 100 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Writes out the <controller> element to the given COLLADA XML tree node. <a href="#5efadecf3bde08473bff01158a6bf5bb"></a><br></td></tr> |
---|
| 101 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><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_controller.html#a12e795f66a6dab2f33e604eac4b778d">Link</a> ()</td></tr> |
---|
| 102 | |
---|
| 103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">[INTERNAL] Links the controller entities with their many targets/influences. <a href="#a12e795f66a6dab2f33e604eac4b778d"></a><br></td></tr> |
---|
| 104 | </table> |
---|
| 105 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 106 | A generic COLLADA controller. |
---|
| 107 | <p> |
---|
| 108 | A COLLADA controller is used to influence a mesh. COLLADA defines two types of controller: skins (<a class="el" href="class_f_c_d_skin_controller.html">FCDSkinController</a>) and morphers (<a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a>). |
---|
| 109 | <p> |
---|
| 110 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 111 | <a class="anchor" name="04573a2e038e54333ee86fcb3c18540c"></a><!-- doxytag: member="FCDController::FCDController" ref="04573a2e038e54333ee86fcb3c18540c" args="(FCDocument *document)" --><p> |
---|
| 112 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 113 | <tr> |
---|
| 114 | <td class="mdRow"> |
---|
| 115 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 116 | <tr> |
---|
| 117 | <td class="md" nowrap valign="top">FCDController::FCDController </td> |
---|
| 118 | <td class="md" valign="top">( </td> |
---|
| 119 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 120 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
| 121 | <td class="md" valign="top"> ) </td> |
---|
| 122 | <td class="md" nowrap></td> |
---|
| 123 | </tr> |
---|
| 124 | </table> |
---|
| 125 | </td> |
---|
| 126 | </tr> |
---|
| 127 | </table> |
---|
| 128 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 129 | <tr> |
---|
| 130 | <td> |
---|
| 131 | |
---|
| 132 | </td> |
---|
| 133 | <td> |
---|
| 134 | |
---|
| 135 | <p> |
---|
| 136 | Constructor: do not use directly. |
---|
| 137 | <p> |
---|
| 138 | Instead, use the <a class="el" href="class_f_c_d_library.html#a5cdcac5a447298d5e3816e4f8c864d0">FCDLibrary::AddEntity</a> function. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 139 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 140 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document that owns the controller. </td></tr> |
---|
| 141 | </table> |
---|
| 142 | </dl> |
---|
| 143 | </td> |
---|
| 144 | </tr> |
---|
| 145 | </table> |
---|
| 146 | <a class="anchor" name="7487659e2b1f2691551bfe0214c5c45d"></a><!-- doxytag: member="FCDController::~FCDController" ref="7487659e2b1f2691551bfe0214c5c45d" args="()" --><p> |
---|
| 147 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 148 | <tr> |
---|
| 149 | <td class="mdRow"> |
---|
| 150 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 151 | <tr> |
---|
| 152 | <td class="md" nowrap valign="top">virtual FCDController::~FCDController </td> |
---|
| 153 | <td class="md" valign="top">( </td> |
---|
| 154 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 155 | <td class="md" valign="top"> ) </td> |
---|
| 156 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 157 | </tr> |
---|
| 158 | </table> |
---|
| 159 | </td> |
---|
| 160 | </tr> |
---|
| 161 | </table> |
---|
| 162 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 163 | <tr> |
---|
| 164 | <td> |
---|
| 165 | |
---|
| 166 | </td> |
---|
| 167 | <td> |
---|
| 168 | |
---|
| 169 | <p> |
---|
| 170 | Destructor: do not use directly. |
---|
| 171 | <p> |
---|
| 172 | Instead, use the <a class="el" href="class_f_c_d_library.html#3fbfbcf4ade5b9c94d2ee2f59db5921d">FCDLibrary::ReleaseEntity</a> function. </td> |
---|
| 173 | </tr> |
---|
| 174 | </table> |
---|
| 175 | <hr><h2>Member Function Documentation</h2> |
---|
| 176 | <a class="anchor" name="448ff15e64c4a2c88e89e372ee1a5f17"></a><!-- doxytag: member="FCDController::CreateMorphController" ref="448ff15e64c4a2c88e89e372ee1a5f17" args="()" --><p> |
---|
| 177 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 178 | <tr> |
---|
| 179 | <td class="mdRow"> |
---|
| 180 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 181 | <tr> |
---|
| 182 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a>* FCDController::CreateMorphController </td> |
---|
| 183 | <td class="md" valign="top">( </td> |
---|
| 184 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 185 | <td class="md" valign="top"> ) </td> |
---|
| 186 | <td class="md" nowrap></td> |
---|
| 187 | </tr> |
---|
| 188 | </table> |
---|
| 189 | </td> |
---|
| 190 | </tr> |
---|
| 191 | </table> |
---|
| 192 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 193 | <tr> |
---|
| 194 | <td> |
---|
| 195 | |
---|
| 196 | </td> |
---|
| 197 | <td> |
---|
| 198 | |
---|
| 199 | <p> |
---|
| 200 | Sets the type of this controller to a morph controller. |
---|
| 201 | <p> |
---|
| 202 | This function will release any previously created morpher or skin. <dl compact><dt><b>Returns:</b></dt><dd>The new morph controller. </dd></dl> |
---|
| 203 | </td> |
---|
| 204 | </tr> |
---|
| 205 | </table> |
---|
| 206 | <a class="anchor" name="38ee749fe069c72add7d4c565288ce4e"></a><!-- doxytag: member="FCDController::CreateSkinController" ref="38ee749fe069c72add7d4c565288ce4e" args="()" --><p> |
---|
| 207 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 208 | <tr> |
---|
| 209 | <td class="mdRow"> |
---|
| 210 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 211 | <tr> |
---|
| 212 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_skin_controller.html">FCDSkinController</a>* FCDController::CreateSkinController </td> |
---|
| 213 | <td class="md" valign="top">( </td> |
---|
| 214 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 215 | <td class="md" valign="top"> ) </td> |
---|
| 216 | <td class="md" nowrap></td> |
---|
| 217 | </tr> |
---|
| 218 | </table> |
---|
| 219 | </td> |
---|
| 220 | </tr> |
---|
| 221 | </table> |
---|
| 222 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 223 | <tr> |
---|
| 224 | <td> |
---|
| 225 | |
---|
| 226 | </td> |
---|
| 227 | <td> |
---|
| 228 | |
---|
| 229 | <p> |
---|
| 230 | Sets the type of this controller to a skin controller. |
---|
| 231 | <p> |
---|
| 232 | This function will release any previously created morpher or skin. <dl compact><dt><b>Returns:</b></dt><dd>The new skin controller. </dd></dl> |
---|
| 233 | </td> |
---|
| 234 | </tr> |
---|
| 235 | </table> |
---|
| 236 | <a class="anchor" name="407cb338a97fee2bd37ebc7899ee40a8"></a><!-- doxytag: member="FCDController::GetBaseGeometry" ref="407cb338a97fee2bd37ebc7899ee40a8" args="()" --><p> |
---|
| 237 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 238 | <tr> |
---|
| 239 | <td class="mdRow"> |
---|
| 240 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 241 | <tr> |
---|
| 242 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_geometry.html">FCDGeometry</a>* FCDController::GetBaseGeometry </td> |
---|
| 243 | <td class="md" valign="top">( </td> |
---|
| 244 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 245 | <td class="md" valign="top"> ) </td> |
---|
| 246 | <td class="md" nowrap></td> |
---|
| 247 | </tr> |
---|
| 248 | </table> |
---|
| 249 | </td> |
---|
| 250 | </tr> |
---|
| 251 | </table> |
---|
| 252 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 253 | <tr> |
---|
| 254 | <td> |
---|
| 255 | |
---|
| 256 | </td> |
---|
| 257 | <td> |
---|
| 258 | |
---|
| 259 | <p> |
---|
| 260 | Retrieves the base target geometry for this controller. |
---|
| 261 | <p> |
---|
| 262 | Controllers can be chained together. This function allows you to retrieve the base target geometry, if there is one. <dl compact><dt><b>Returns:</b></dt><dd>The base target geometry. This pointer will be NULL if no base target is defined or if the base target entity is not a geometry. </dd></dl> |
---|
| 263 | </td> |
---|
| 264 | </tr> |
---|
| 265 | </table> |
---|
| 266 | <a class="anchor" name="a1a9d7d644e011eeee20e1af57d11833"></a><!-- doxytag: member="FCDController::GetBaseTarget" ref="a1a9d7d644e011eeee20e1af57d11833" args="()" --><p> |
---|
| 267 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 268 | <tr> |
---|
| 269 | <td class="mdRow"> |
---|
| 270 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 271 | <tr> |
---|
| 272 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_entity.html">FCDEntity</a>* FCDController::GetBaseTarget </td> |
---|
| 273 | <td class="md" valign="top">( </td> |
---|
| 274 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 275 | <td class="md" valign="top"> ) </td> |
---|
| 276 | <td class="md" nowrap></td> |
---|
| 277 | </tr> |
---|
| 278 | </table> |
---|
| 279 | </td> |
---|
| 280 | </tr> |
---|
| 281 | </table> |
---|
| 282 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 283 | <tr> |
---|
| 284 | <td> |
---|
| 285 | |
---|
| 286 | </td> |
---|
| 287 | <td> |
---|
| 288 | |
---|
| 289 | <p> |
---|
| 290 | Retrieves the base target entity for this controller. |
---|
| 291 | <p> |
---|
| 292 | The base target entity may be another controller or a geometry entity. To change the base target, use the <a class="el" href="class_f_c_d_morph_controller.html#11196ee1bd50c02cbd82e75397816272">FCDMorphController::SetBaseTarget</a> or the <a class="el" href="class_f_c_d_skin_controller.html#570337f366b9760bf1828620541c130b">FCDSkinController::SetTarget</a> functions. <dl compact><dt><b>Returns:</b></dt><dd>The base target entity. This pointer will be NULL if no base target is defined. </dd></dl> |
---|
| 293 | </td> |
---|
| 294 | </tr> |
---|
| 295 | </table> |
---|
| 296 | <a class="anchor" name="6a7af0fbd38bb56cf3603e8674e4f445"></a><!-- doxytag: member="FCDController::GetMorphController" ref="6a7af0fbd38bb56cf3603e8674e4f445" args="()" --><p> |
---|
| 297 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 298 | <tr> |
---|
| 299 | <td class="mdRow"> |
---|
| 300 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 301 | <tr> |
---|
| 302 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_d_morph_controller.html">FCDMorphController</a>* FCDController::GetMorphController </td> |
---|
| 303 | <td class="md" valign="top">( </td> |
---|
| 304 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 305 | <td class="md" valign="top"> ) </td> |
---|
| 306 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 307 | </tr> |
---|
| 308 | </table> |
---|
| 309 | </td> |
---|
| 310 | </tr> |
---|
| 311 | </table> |
---|
| 312 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 313 | <tr> |
---|
| 314 | <td> |
---|
| 315 | |
---|
| 316 | </td> |
---|
| 317 | <td> |
---|
| 318 | |
---|
| 319 | <p> |
---|
| 320 | Retrieves the morph controller. |
---|
| 321 | <p> |
---|
| 322 | This pointer is only valid for skins. To verify that this is a morpher, check the HasMorphController function. <dl compact><dt><b>Returns:</b></dt><dd>The morph controller. This pointer will be NULL, if the controller is not a morpher. </dd></dl> |
---|
| 323 | </td> |
---|
| 324 | </tr> |
---|
| 325 | </table> |
---|
| 326 | <a class="anchor" name="4088c1f8c04cd88fcafa1a82b2c9d587"></a><!-- doxytag: member="FCDController::GetSkinController" ref="4088c1f8c04cd88fcafa1a82b2c9d587" args="()" --><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"><a class="el" href="class_f_c_d_skin_controller.html">FCDSkinController</a>* FCDController::GetSkinController </td> |
---|
| 333 | <td class="md" valign="top">( </td> |
---|
| 334 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 335 | <td class="md" valign="top"> ) </td> |
---|
| 336 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 337 | </tr> |
---|
| 338 | </table> |
---|
| 339 | </td> |
---|
| 340 | </tr> |
---|
| 341 | </table> |
---|
| 342 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 343 | <tr> |
---|
| 344 | <td> |
---|
| 345 | |
---|
| 346 | </td> |
---|
| 347 | <td> |
---|
| 348 | |
---|
| 349 | <p> |
---|
| 350 | Retrieves the skin controller. |
---|
| 351 | <p> |
---|
| 352 | This pointer is only valid for skins. To verify that this is a skin, check the HasSkinController function. <dl compact><dt><b>Returns:</b></dt><dd>The skin controller. This pointer will be NULL, if the controller is not a skin. </dd></dl> |
---|
| 353 | </td> |
---|
| 354 | </tr> |
---|
| 355 | </table> |
---|
| 356 | <a class="anchor" name="4c4d583b681d3a1a91622b454d2afd60"></a><!-- doxytag: member="FCDController::GetTargetId" ref="4c4d583b681d3a1a91622b454d2afd60" args="() const " --><p> |
---|
| 357 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 358 | <tr> |
---|
| 359 | <td class="mdRow"> |
---|
| 360 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 361 | <tr> |
---|
| 362 | <td class="md" nowrap valign="top">const string& FCDController::GetTargetId </td> |
---|
| 363 | <td class="md" valign="top">( </td> |
---|
| 364 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 365 | <td class="md" valign="top"> ) </td> |
---|
| 366 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 367 | </tr> |
---|
| 368 | </table> |
---|
| 369 | </td> |
---|
| 370 | </tr> |
---|
| 371 | </table> |
---|
| 372 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 373 | <tr> |
---|
| 374 | <td> |
---|
| 375 | |
---|
| 376 | </td> |
---|
| 377 | <td> |
---|
| 378 | |
---|
| 379 | <p> |
---|
| 380 | [INTERNAL] Retrieves the COLLADA id of the target entity. |
---|
| 381 | <p> |
---|
| 382 | This value is only useful for COLLADA 1.3 backward compatibility. For more recent COLLADA documents, this value is unused. <dl compact><dt><b>Returns:</b></dt><dd>The COLLADA id of the target entity. </dd></dl> |
---|
| 383 | </td> |
---|
| 384 | </tr> |
---|
| 385 | </table> |
---|
| 386 | <a class="anchor" name="2ff5b14d564dba7be26d3b8544bec93c"></a><!-- doxytag: member="FCDController::GetType" ref="2ff5b14d564dba7be26d3b8544bec93c" args="() const " --><p> |
---|
| 387 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 388 | <tr> |
---|
| 389 | <td class="mdRow"> |
---|
| 390 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 391 | <tr> |
---|
| 392 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_c_d_entity.html#9301a4bd5f4d4190ec13e40db4effdd7">Type</a> FCDController::GetType </td> |
---|
| 393 | <td class="md" valign="top">( </td> |
---|
| 394 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 395 | <td class="md" valign="top"> ) </td> |
---|
| 396 | <td class="md" nowrap> const<code> [inline, 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 | Retrieves the entity class type. |
---|
| 411 | <p> |
---|
| 412 | This function is a part of the <a class="el" href="class_f_c_d_entity.html">FCDEntity</a> interface. <dl compact><dt><b>Returns:</b></dt><dd>The entity class type: CONTROLLER. </dd></dl> |
---|
| 413 | |
---|
| 414 | <p> |
---|
| 415 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#bfd4312a7124f92364c1e6517c7e60ba">FCDEntity</a>. </td> |
---|
| 416 | </tr> |
---|
| 417 | </table> |
---|
| 418 | <a class="anchor" name="0b1ba93e37840d2828a84a050602ed22"></a><!-- doxytag: member="FCDController::HasMorphController" ref="0b1ba93e37840d2828a84a050602ed22" args="() const " --><p> |
---|
| 419 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 420 | <tr> |
---|
| 421 | <td class="mdRow"> |
---|
| 422 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 423 | <tr> |
---|
| 424 | <td class="md" nowrap valign="top">bool FCDController::HasMorphController </td> |
---|
| 425 | <td class="md" valign="top">( </td> |
---|
| 426 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 427 | <td class="md" valign="top"> ) </td> |
---|
| 428 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 429 | </tr> |
---|
| 430 | </table> |
---|
| 431 | </td> |
---|
| 432 | </tr> |
---|
| 433 | </table> |
---|
| 434 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 435 | <tr> |
---|
| 436 | <td> |
---|
| 437 | |
---|
| 438 | </td> |
---|
| 439 | <td> |
---|
| 440 | |
---|
| 441 | <p> |
---|
| 442 | Retrieves whether this controller is a morph controller. |
---|
| 443 | <p> |
---|
| 444 | <dl compact><dt><b>Returns:</b></dt><dd>Whether this controller is a morph controller. </dd></dl> |
---|
| 445 | </td> |
---|
| 446 | </tr> |
---|
| 447 | </table> |
---|
| 448 | <a class="anchor" name="47e50ce888468e74fb8919d4ba4c28af"></a><!-- doxytag: member="FCDController::HasSkinController" ref="47e50ce888468e74fb8919d4ba4c28af" args="() const " --><p> |
---|
| 449 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 450 | <tr> |
---|
| 451 | <td class="mdRow"> |
---|
| 452 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 453 | <tr> |
---|
| 454 | <td class="md" nowrap valign="top">bool FCDController::HasSkinController </td> |
---|
| 455 | <td class="md" valign="top">( </td> |
---|
| 456 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 457 | <td class="md" valign="top"> ) </td> |
---|
| 458 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 459 | </tr> |
---|
| 460 | </table> |
---|
| 461 | </td> |
---|
| 462 | </tr> |
---|
| 463 | </table> |
---|
| 464 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 465 | <tr> |
---|
| 466 | <td> |
---|
| 467 | |
---|
| 468 | </td> |
---|
| 469 | <td> |
---|
| 470 | |
---|
| 471 | <p> |
---|
| 472 | Retrieves whether this controller is a skin controller. |
---|
| 473 | <p> |
---|
| 474 | <dl compact><dt><b>Returns:</b></dt><dd>Whether this controller is a skin controller. </dd></dl> |
---|
| 475 | </td> |
---|
| 476 | </tr> |
---|
| 477 | </table> |
---|
| 478 | <a class="anchor" name="a12e795f66a6dab2f33e604eac4b778d"></a><!-- doxytag: member="FCDController::Link" ref="a12e795f66a6dab2f33e604eac4b778d" args="()" --><p> |
---|
| 479 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 480 | <tr> |
---|
| 481 | <td class="mdRow"> |
---|
| 482 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 483 | <tr> |
---|
| 484 | <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> FCDController::Link </td> |
---|
| 485 | <td class="md" valign="top">( </td> |
---|
| 486 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 487 | <td class="md" valign="top"> ) </td> |
---|
| 488 | <td class="md" nowrap></td> |
---|
| 489 | </tr> |
---|
| 490 | </table> |
---|
| 491 | </td> |
---|
| 492 | </tr> |
---|
| 493 | </table> |
---|
| 494 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 495 | <tr> |
---|
| 496 | <td> |
---|
| 497 | |
---|
| 498 | </td> |
---|
| 499 | <td> |
---|
| 500 | |
---|
| 501 | <p> |
---|
| 502 | [INTERNAL] Links the controller entities with their many targets/influences. |
---|
| 503 | <p> |
---|
| 504 | This function is executed for all the controllers, after the scene graph has been imported. It is mainly used to link the skin and its bones. <dl compact><dt><b>Returns:</b></dt><dd>The status of the linkage. </dd></dl> |
---|
| 505 | </td> |
---|
| 506 | </tr> |
---|
| 507 | </table> |
---|
| 508 | <a class="anchor" name="ee1a9db915a1b34ae6207d7215a751b4"></a><!-- doxytag: member="FCDController::LoadFromXML" ref="ee1a9db915a1b34ae6207d7215a751b4" args="(xmlNode *controllerNode)" --><p> |
---|
| 509 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 510 | <tr> |
---|
| 511 | <td class="mdRow"> |
---|
| 512 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 513 | <tr> |
---|
| 514 | <td class="md" nowrap valign="top">virtual <a class="el" href="class_f_u_status.html">FUStatus</a> FCDController::LoadFromXML </td> |
---|
| 515 | <td class="md" valign="top">( </td> |
---|
| 516 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 517 | <td class="mdname1" valign="top" nowrap> <em>controllerNode</em> </td> |
---|
| 518 | <td class="md" valign="top"> ) </td> |
---|
| 519 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
| 520 | </tr> |
---|
| 521 | </table> |
---|
| 522 | </td> |
---|
| 523 | </tr> |
---|
| 524 | </table> |
---|
| 525 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 526 | <tr> |
---|
| 527 | <td> |
---|
| 528 | |
---|
| 529 | </td> |
---|
| 530 | <td> |
---|
| 531 | |
---|
| 532 | <p> |
---|
| 533 | [INTERNAL] Reads in the <controller> element from a given COLLADA XML tree node. |
---|
| 534 | <p> |
---|
| 535 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 536 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 537 | <tr><td valign="top"></td><td valign="top"><em>controllerNode</em> </td><td>The COLLADA XML tree node. </td></tr> |
---|
| 538 | </table> |
---|
| 539 | </dl> |
---|
| 540 | <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 controller. </dd></dl> |
---|
| 541 | |
---|
| 542 | <p> |
---|
| 543 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#8e32fcc93de76acc4b606db7b5b83890">FCDEntity</a>. </td> |
---|
| 544 | </tr> |
---|
| 545 | </table> |
---|
| 546 | <a class="anchor" name="5efadecf3bde08473bff01158a6bf5bb"></a><!-- doxytag: member="FCDController::WriteToXML" ref="5efadecf3bde08473bff01158a6bf5bb" args="(xmlNode *parentNode) const " --><p> |
---|
| 547 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 548 | <tr> |
---|
| 549 | <td class="mdRow"> |
---|
| 550 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 551 | <tr> |
---|
| 552 | <td class="md" nowrap valign="top">virtual xmlNode* FCDController::WriteToXML </td> |
---|
| 553 | <td class="md" valign="top">( </td> |
---|
| 554 | <td class="md" nowrap valign="top">xmlNode * </td> |
---|
| 555 | <td class="mdname1" valign="top" nowrap> <em>parentNode</em> </td> |
---|
| 556 | <td class="md" valign="top"> ) </td> |
---|
| 557 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
| 558 | </tr> |
---|
| 559 | </table> |
---|
| 560 | </td> |
---|
| 561 | </tr> |
---|
| 562 | </table> |
---|
| 563 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 564 | <tr> |
---|
| 565 | <td> |
---|
| 566 | |
---|
| 567 | </td> |
---|
| 568 | <td> |
---|
| 569 | |
---|
| 570 | <p> |
---|
| 571 | [INTERNAL] Writes out the <controller> element to the given COLLADA XML tree node. |
---|
| 572 | <p> |
---|
| 573 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 574 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 575 | <tr><td valign="top"></td><td valign="top"><em>parentNode</em> </td><td>The COLLADA XML parent node in which to insert the controller information. </td></tr> |
---|
| 576 | </table> |
---|
| 577 | </dl> |
---|
| 578 | <dl compact><dt><b>Returns:</b></dt><dd>The created element XML tree node. </dd></dl> |
---|
| 579 | |
---|
| 580 | <p> |
---|
| 581 | Reimplemented from <a class="el" href="class_f_c_d_entity.html#b27f0c175c3f8fd7064cde48bcf1d7a0">FCDEntity</a>. </td> |
---|
| 582 | </tr> |
---|
| 583 | </table> |
---|
| 584 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 585 | <li>FCDocument/<a class="el" href="_f_c_d_controller_8h-source.html">FCDController.h</a></ul> |
---|
| 586 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:41 2006 for FCollada by |
---|
| 587 | <a href="http://www.doxygen.org/index.html"> |
---|
| 588 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 589 | </body> |
---|
| 590 | </html> |
---|