[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: FCDObject 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>FCDObject 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="FCDObject" --><!-- doxytag: inherits="FUObject" -->A basic COLLADA document object. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_c_d_object_8h-source.html">FCDObject.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <p>Inheritance diagram for FCDObject: |
---|
| 33 | <p><center><img src="class_f_c_d_object.png" usemap="#FCDObject_map" border="0" alt=""></center> |
---|
| 34 | <map name="FCDObject_map"> |
---|
| 35 | <area href="class_f_u_object.html" alt="FUObject" shape="rect" coords="0,0,155,24"> |
---|
| 36 | <area href="class_f_c_d_animated.html" alt="FCDAnimated" shape="rect" coords="165,112,320,136"> |
---|
| 37 | <area href="class_f_c_d_animation_channel.html" alt="FCDAnimationChannel" shape="rect" coords="165,168,320,192"> |
---|
| 38 | <area href="class_f_c_d_animation_curve.html" alt="FCDAnimationCurve" shape="rect" coords="165,224,320,248"> |
---|
| 39 | <area href="class_f_c_d_animation_multi_curve.html" alt="FCDAnimationMultiCurve" shape="rect" coords="165,280,320,304"> |
---|
| 40 | <area href="class_f_c_d_effect_code.html" alt="FCDEffectCode" shape="rect" coords="165,336,320,360"> |
---|
| 41 | <area href="class_f_c_d_effect_parameter.html" alt="FCDEffectParameter" shape="rect" coords="165,392,320,416"> |
---|
| 42 | <area href="class_f_c_d_effect_parameter_list.html" alt="FCDEffectParameterList" shape="rect" coords="165,448,320,472"> |
---|
| 43 | <area href="class_f_c_d_effect_pass.html" alt="FCDEffectPass" shape="rect" coords="165,504,320,528"> |
---|
| 44 | <area href="class_f_c_d_effect_pass_shader.html" alt="FCDEffectPassShader" shape="rect" coords="165,560,320,584"> |
---|
| 45 | <area href="class_f_c_d_effect_profile.html" alt="FCDEffectProfile" shape="rect" coords="165,616,320,640"> |
---|
| 46 | <area href="class_f_c_d_effect_technique.html" alt="FCDEffectTechnique" shape="rect" coords="165,672,320,696"> |
---|
| 47 | <area href="class_f_c_d_e_node.html" alt="FCDENode" shape="rect" coords="165,728,320,752"> |
---|
| 48 | <area href="class_f_c_d_entity_instance.html" alt="FCDEntityInstance" shape="rect" coords="165,784,320,808"> |
---|
| 49 | <area href="class_f_c_d_extra.html" alt="FCDExtra" shape="rect" coords="165,840,320,864"> |
---|
| 50 | <area href="class_f_c_d_geometry_mesh.html" alt="FCDGeometryMesh" shape="rect" coords="165,896,320,920"> |
---|
| 51 | <area href="class_f_c_d_geometry_polygons.html" alt="FCDGeometryPolygons" shape="rect" coords="165,952,320,976"> |
---|
| 52 | <area href="class_f_c_d_geometry_spline.html" alt="FCDGeometrySpline" shape="rect" coords="165,1008,320,1032"> |
---|
| 53 | <area href="class_f_c_d_morph_controller.html" alt="FCDMorphController" shape="rect" coords="165,1064,320,1088"> |
---|
| 54 | <area href="class_f_c_d_morph_target.html" alt="FCDMorphTarget" shape="rect" coords="165,1120,320,1144"> |
---|
| 55 | <area href="class_f_c_d_object_with_id.html" alt="FCDObjectWithId" shape="rect" coords="165,1176,320,1200"> |
---|
| 56 | <area href="class_f_c_d_skin_controller.html" alt="FCDSkinController" shape="rect" coords="165,1232,320,1256"> |
---|
| 57 | <area href="class_f_c_d_transform.html" alt="FCDTransform" shape="rect" coords="165,1288,320,1312"> |
---|
| 58 | </map> |
---|
| 59 | <a href="class_f_c_d_object-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 60 | <tr><td></td></tr> |
---|
| 61 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 62 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_object.html#bb787f16c30ad2788684869045a99dd6">FCDObject</a> (<a class="el" href="class_f_c_document.html">FCDocument</a> *document)</td></tr> |
---|
| 63 | |
---|
| 64 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor: sets the COLLADA document object. <a href="#bb787f16c30ad2788684869045a99dd6"></a><br></td></tr> |
---|
| 65 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c0f02adcb9379f7336e64a0ec20ce7bf"></a><!-- doxytag: member="FCDObject::~FCDObject" ref="c0f02adcb9379f7336e64a0ec20ce7bf" args="()" --> |
---|
| 66 | virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_object.html#c0f02adcb9379f7336e64a0ec20ce7bf">~FCDObject</a> ()</td></tr> |
---|
| 67 | |
---|
| 68 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br></td></tr> |
---|
| 69 | <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_object.html#6c8a748e2691d69586ab87b46b01e072">GetDocument</a> ()</td></tr> |
---|
| 70 | |
---|
| 71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the COLLADA document which owns this object. <a href="#6c8a748e2691d69586ab87b46b01e072"></a><br></td></tr> |
---|
| 72 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1c1cd500d30d514cc8d3cadf1badeae4"></a><!-- doxytag: member="FCDObject::GetDocument" ref="1c1cd500d30d514cc8d3cadf1badeae4" args="() const " --> |
---|
| 73 | <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_object.html#1c1cd500d30d514cc8d3cadf1badeae4">GetDocument</a> () const </td></tr> |
---|
| 74 | |
---|
| 75 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 76 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_object.html#b77b02a9672a50cfe041bac026a26ea7">GetUserHandle</a> () const </td></tr> |
---|
| 77 | |
---|
| 78 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the object's user-specified handle. <a href="#b77b02a9672a50cfe041bac026a26ea7"></a><br></td></tr> |
---|
| 79 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_c_d_object.html#32714d741f0673992de087516a79b9e7">SetUserHandle</a> (void *handle)</td></tr> |
---|
| 80 | |
---|
| 81 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the object's user-specified handle. <a href="#32714d741f0673992de087516a79b9e7"></a><br></td></tr> |
---|
| 82 | </table> |
---|
| 83 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 84 | A basic COLLADA document object. |
---|
| 85 | <p> |
---|
| 86 | All the objects owned by the COLLADA document derive from this class. The <a class="el" href="class_f_c_document.html">FCDocument</a> object is accessible through this interface to all the object which it owns.<p> |
---|
| 87 | Space for an handle which has no meaning to <a class="el" href="namespace_f_collada.html">FCollada</a> is available in this base class, for our users. You can therefore attach your own objects to most <a class="el" href="namespace_f_collada.html">FCollada</a> objects. If you assign memory buffers to the user-specified handle, be aware that <a class="el" href="namespace_f_collada.html">FCollada</a> will make no attempt to release it. |
---|
| 88 | <p> |
---|
| 89 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 90 | <a class="anchor" name="bb787f16c30ad2788684869045a99dd6"></a><!-- doxytag: member="FCDObject::FCDObject" ref="bb787f16c30ad2788684869045a99dd6" args="(FCDocument *document)" --><p> |
---|
| 91 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 92 | <tr> |
---|
| 93 | <td class="mdRow"> |
---|
| 94 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 95 | <tr> |
---|
| 96 | <td class="md" nowrap valign="top">FCDObject::FCDObject </td> |
---|
| 97 | <td class="md" valign="top">( </td> |
---|
| 98 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a> * </td> |
---|
| 99 | <td class="mdname1" valign="top" nowrap> <em>document</em> </td> |
---|
| 100 | <td class="md" valign="top"> ) </td> |
---|
| 101 | <td class="md" nowrap></td> |
---|
| 102 | </tr> |
---|
| 103 | </table> |
---|
| 104 | </td> |
---|
| 105 | </tr> |
---|
| 106 | </table> |
---|
| 107 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 108 | <tr> |
---|
| 109 | <td> |
---|
| 110 | |
---|
| 111 | </td> |
---|
| 112 | <td> |
---|
| 113 | |
---|
| 114 | <p> |
---|
| 115 | Constructor: sets the COLLADA document object. |
---|
| 116 | <p> |
---|
| 117 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 118 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 119 | <tr><td valign="top"></td><td valign="top"><em>document</em> </td><td>The COLLADA document which owns this object. </td></tr> |
---|
| 120 | </table> |
---|
| 121 | </dl> |
---|
| 122 | </td> |
---|
| 123 | </tr> |
---|
| 124 | </table> |
---|
| 125 | <hr><h2>Member Function Documentation</h2> |
---|
| 126 | <a class="anchor" name="6c8a748e2691d69586ab87b46b01e072"></a><!-- doxytag: member="FCDObject::GetDocument" ref="6c8a748e2691d69586ab87b46b01e072" args="()" --><p> |
---|
| 127 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 128 | <tr> |
---|
| 129 | <td class="mdRow"> |
---|
| 130 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 131 | <tr> |
---|
| 132 | <td class="md" nowrap valign="top"><a class="el" href="class_f_c_document.html">FCDocument</a>* FCDObject::GetDocument </td> |
---|
| 133 | <td class="md" valign="top">( </td> |
---|
| 134 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 135 | <td class="md" valign="top"> ) </td> |
---|
| 136 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 137 | </tr> |
---|
| 138 | </table> |
---|
| 139 | </td> |
---|
| 140 | </tr> |
---|
| 141 | </table> |
---|
| 142 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 143 | <tr> |
---|
| 144 | <td> |
---|
| 145 | |
---|
| 146 | </td> |
---|
| 147 | <td> |
---|
| 148 | |
---|
| 149 | <p> |
---|
| 150 | Retrieves the COLLADA document which owns this object. |
---|
| 151 | <p> |
---|
| 152 | <dl compact><dt><b>Returns:</b></dt><dd>The COLLADA document. </dd></dl> |
---|
| 153 | </td> |
---|
| 154 | </tr> |
---|
| 155 | </table> |
---|
| 156 | <a class="anchor" name="b77b02a9672a50cfe041bac026a26ea7"></a><!-- doxytag: member="FCDObject::GetUserHandle" ref="b77b02a9672a50cfe041bac026a26ea7" args="() const " --><p> |
---|
| 157 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 158 | <tr> |
---|
| 159 | <td class="mdRow"> |
---|
| 160 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 161 | <tr> |
---|
| 162 | <td class="md" nowrap valign="top">void* FCDObject::GetUserHandle </td> |
---|
| 163 | <td class="md" valign="top">( </td> |
---|
| 164 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 165 | <td class="md" valign="top"> ) </td> |
---|
| 166 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 167 | </tr> |
---|
| 168 | </table> |
---|
| 169 | </td> |
---|
| 170 | </tr> |
---|
| 171 | </table> |
---|
| 172 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 173 | <tr> |
---|
| 174 | <td> |
---|
| 175 | |
---|
| 176 | </td> |
---|
| 177 | <td> |
---|
| 178 | |
---|
| 179 | <p> |
---|
| 180 | Retrieves the object's user-specified handle. |
---|
| 181 | <p> |
---|
| 182 | This handle is available for users and has no meaning to <a class="el" href="namespace_f_collada.html">FCollada</a>. <dl compact><dt><b>Returns:</b></dt><dd>The object user-specified handle. </dd></dl> |
---|
| 183 | </td> |
---|
| 184 | </tr> |
---|
| 185 | </table> |
---|
| 186 | <a class="anchor" name="32714d741f0673992de087516a79b9e7"></a><!-- doxytag: member="FCDObject::SetUserHandle" ref="32714d741f0673992de087516a79b9e7" args="(void *handle)" --><p> |
---|
| 187 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 188 | <tr> |
---|
| 189 | <td class="mdRow"> |
---|
| 190 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 191 | <tr> |
---|
| 192 | <td class="md" nowrap valign="top">void FCDObject::SetUserHandle </td> |
---|
| 193 | <td class="md" valign="top">( </td> |
---|
| 194 | <td class="md" nowrap valign="top">void * </td> |
---|
| 195 | <td class="mdname1" valign="top" nowrap> <em>handle</em> </td> |
---|
| 196 | <td class="md" valign="top"> ) </td> |
---|
| 197 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 198 | </tr> |
---|
| 199 | </table> |
---|
| 200 | </td> |
---|
| 201 | </tr> |
---|
| 202 | </table> |
---|
| 203 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 204 | <tr> |
---|
| 205 | <td> |
---|
| 206 | |
---|
| 207 | </td> |
---|
| 208 | <td> |
---|
| 209 | |
---|
| 210 | <p> |
---|
| 211 | Sets the object's user-specified handle. |
---|
| 212 | <p> |
---|
| 213 | This handle is available for users and has no meaning to <a class="el" href="namespace_f_collada.html">FCollada</a>. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 214 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 215 | <tr><td valign="top"></td><td valign="top"><em>handle</em> </td><td>The user-specified handle. </td></tr> |
---|
| 216 | </table> |
---|
| 217 | </dl> |
---|
| 218 | </td> |
---|
| 219 | </tr> |
---|
| 220 | </table> |
---|
| 221 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 222 | <li>FCDocument/<a class="el" href="_f_c_d_object_8h-source.html">FCDObject.h</a></ul> |
---|
| 223 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:43 2006 for FCollada by |
---|
| 224 | <a href="http://www.doxygen.org/index.html"> |
---|
| 225 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 226 | </body> |
---|
| 227 | </html> |
---|