source: NonGTP/FCollada/Documentation/class_f_u_object.html @ 964

Revision 964, 13.1 KB checked in by igarcia, 18 years ago (diff)
Line 
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: FUObject 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&nbsp;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&nbsp;Pages</span></a></li>
16  </ul></div>
17<div class="tabs">
18  <ul>
19    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
20    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
21    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
22    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
23  </ul></div>
24<h1>FUObject Class Reference<br>
25<small>
26[<a class="el" href="group___f_utils.html">Utility Classes.</a>]</small>
27</h1><!-- doxytag: class="FUObject" -->A contained object. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_u_object_8h-source.html">FUObject.h</a>&gt;</code>
31<p>
32<p>Inheritance diagram for FUObject:
33<p><center><img src="class_f_u_object.png" usemap="#FUObject_map" border="0" alt=""></center>
34<map name="FUObject_map">
35<area href="class_f_c_d_object.html" alt="FCDObject" shape="rect" coords="0,56,155,80">
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_u_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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object.html#97b667a791834d65e9c797d433682fbf">FUObject</a> (<a class="el" href="class_f_u_object_container.html">FUObjectContainer</a> *container)</td></tr>
63
64<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#97b667a791834d65e9c797d433682fbf"></a><br></td></tr>
65<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object.html#4dec1cc9b872769d4c3eece218278932">~FUObject</a> ()</td></tr>
66
67<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#4dec1cc9b872769d4c3eece218278932"></a><br></td></tr>
68<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object.html#f41252d8da713eae73cd7c1e9a95a9da">GetObjectType</a> () const </td></tr>
69
70<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type of the object class.  <a href="#f41252d8da713eae73cd7c1e9a95a9da"></a><br></td></tr>
71<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
72<tr><td class="memItemLeft" nowrap align="right" valign="top">static const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object.html#907d4f6d284b3ac4f8203d557af41668">GetClassType</a> ()</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type of the base object class.  <a href="#907d4f6d284b3ac4f8203d557af41668"></a><br></td></tr>
75<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
76<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_u_object_container.html">FUObjectContainer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object.html#59dae6757453a8aca0e1aa43c83a3b1b">GetContainer</a> ()</td></tr>
77
78<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the container of the object.  <a href="#59dae6757453a8aca0e1aa43c83a3b1b"></a><br></td></tr>
79<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c689ce547471884f39908e82ea154c55"></a><!-- doxytag: member="FUObject::GetContainer" ref="c689ce547471884f39908e82ea154c55" args="() const " -->
80const <a class="el" href="class_f_u_object_container.html">FUObjectContainer</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object.html#c689ce547471884f39908e82ea154c55">GetContainer</a> () const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">See above. <br></td></tr>
83</table>
84<hr><a name="_details"></a><h2>Detailed Description</h2>
85A contained object.
86<p>
87Each object holds a pointer to the container that contains it. This pointer is useful so that the container can be notified if the object gets released by someone else.
88<p>
89<hr><h2>Constructor &amp; Destructor Documentation</h2>
90<a class="anchor" name="97b667a791834d65e9c797d433682fbf"></a><!-- doxytag: member="FUObject::FUObject" ref="97b667a791834d65e9c797d433682fbf" args="(FUObjectContainer *container)" --><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">FUObject::FUObject           </td>
97          <td class="md" valign="top">(&nbsp;</td>
98          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_object_container.html">FUObjectContainer</a> *&nbsp;</td>
99          <td class="mdname1" valign="top" nowrap> <em>container</em>          </td>
100          <td class="md" valign="top">&nbsp;)&nbsp;</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      &nbsp;
111    </td>
112    <td>
113
114<p>
115Constructor.
116<p>
117Although it is not an abstract class, class is not meant to be used directly. This constructor informs the container of the object's creation. <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>container</em>&nbsp;</td><td>The container that contains this object. </td></tr>
120  </table>
121</dl>
122    </td>
123  </tr>
124</table>
125<a class="anchor" name="4dec1cc9b872769d4c3eece218278932"></a><!-- doxytag: member="FUObject::~FUObject" ref="4dec1cc9b872769d4c3eece218278932" args="()" --><p>
126<table class="mdTable" cellpadding="2" cellspacing="0">
127  <tr>
128    <td class="mdRow">
129      <table cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td class="md" nowrap valign="top">FUObject::~FUObject           </td>
132          <td class="md" valign="top">(&nbsp;</td>
133          <td class="mdname1" valign="top" nowrap>          </td>
134          <td class="md" valign="top">&nbsp;)&nbsp;</td>
135          <td class="md" nowrap></td>
136        </tr>
137      </table>
138    </td>
139  </tr>
140</table>
141<table cellspacing="5" cellpadding="0" border="0">
142  <tr>
143    <td>
144      &nbsp;
145    </td>
146    <td>
147
148<p>
149Destructor.
150<p>
151This function informs the container of this object's release.     </td>
152  </tr>
153</table>
154<hr><h2>Member Function Documentation</h2>
155<a class="anchor" name="907d4f6d284b3ac4f8203d557af41668"></a><!-- doxytag: member="FUObject::GetClassType" ref="907d4f6d284b3ac4f8203d557af41668" args="()" --><p>
156<table class="mdTable" cellpadding="2" cellspacing="0">
157  <tr>
158    <td class="mdRow">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top">static const <a class="el" href="class_f_u_object_type.html">FUObjectType</a>&amp; FUObject::GetClassType           </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="mdname1" valign="top" nowrap>          </td>
164          <td class="md" valign="top">&nbsp;)&nbsp;</td>
165          <td class="md" nowrap><code> [inline, static]</code></td>
166        </tr>
167      </table>
168    </td>
169  </tr>
170</table>
171<table cellspacing="5" cellpadding="0" border="0">
172  <tr>
173    <td>
174      &nbsp;
175    </td>
176    <td>
177
178<p>
179Retrieves the type of the base object class.
180<p>
181<dl compact><dt><b>Returns:</b></dt><dd>The type of the base object class. </dd></dl>
182    </td>
183  </tr>
184</table>
185<a class="anchor" name="59dae6757453a8aca0e1aa43c83a3b1b"></a><!-- doxytag: member="FUObject::GetContainer" ref="59dae6757453a8aca0e1aa43c83a3b1b" args="()" --><p>
186<table class="mdTable" cellpadding="2" cellspacing="0">
187  <tr>
188    <td class="mdRow">
189      <table cellpadding="0" cellspacing="0" border="0">
190        <tr>
191          <td class="md" nowrap valign="top"><a class="el" href="class_f_u_object_container.html">FUObjectContainer</a>* FUObject::GetContainer           </td>
192          <td class="md" valign="top">(&nbsp;</td>
193          <td class="mdname1" valign="top" nowrap>          </td>
194          <td class="md" valign="top">&nbsp;)&nbsp;</td>
195          <td class="md" nowrap><code> [inline, protected]</code></td>
196        </tr>
197      </table>
198    </td>
199  </tr>
200</table>
201<table cellspacing="5" cellpadding="0" border="0">
202  <tr>
203    <td>
204      &nbsp;
205    </td>
206    <td>
207
208<p>
209Retrieves the container of the object.
210<p>
211<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the container. </dd></dl>
212    </td>
213  </tr>
214</table>
215<a class="anchor" name="f41252d8da713eae73cd7c1e9a95a9da"></a><!-- doxytag: member="FUObject::GetObjectType" ref="f41252d8da713eae73cd7c1e9a95a9da" args="() const " --><p>
216<table class="mdTable" cellpadding="2" cellspacing="0">
217  <tr>
218    <td class="mdRow">
219      <table cellpadding="0" cellspacing="0" border="0">
220        <tr>
221          <td class="md" nowrap valign="top">virtual const <a class="el" href="class_f_u_object_type.html">FUObjectType</a>&amp; FUObject::GetObjectType           </td>
222          <td class="md" valign="top">(&nbsp;</td>
223          <td class="mdname1" valign="top" nowrap>          </td>
224          <td class="md" valign="top">&nbsp;)&nbsp;</td>
225          <td class="md" nowrap> const<code> [inline, virtual]</code></td>
226        </tr>
227      </table>
228    </td>
229  </tr>
230</table>
231<table cellspacing="5" cellpadding="0" border="0">
232  <tr>
233    <td>
234      &nbsp;
235    </td>
236    <td>
237
238<p>
239Retrieves the type of the object class.
240<p>
241<dl compact><dt><b>Returns:</b></dt><dd>The type of the base object class. </dd></dl>
242    </td>
243  </tr>
244</table>
245<hr>The documentation for this class was generated from the following file:<ul>
246<li>FUtils/<a class="el" href="_f_u_object_8h-source.html">FUObject.h</a></ul>
247<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by&nbsp;
248<a href="http://www.doxygen.org/index.html">
249<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
250</body>
251</html>
Note: See TracBrowser for help on using the repository browser.