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

Revision 964, 14.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: FUObjectType 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>FUObjectType Class Reference<br>
25<small>
26[<a class="el" href="group___f_utils.html">Utility Classes.</a>]</small>
27</h1><!-- doxytag: class="FUObjectType" -->An object type. 
28<a href="#_details">More...</a>
29<p>
30<code>#include &lt;<a class="el" href="_f_u_object_type_8h-source.html">FUObjectType.h</a>&gt;</code>
31<p>
32<a href="class_f_u_object_type-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
33<tr><td></td></tr>
34<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
35<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object_type.html#2720b7c1dc89ba2b04067fb54651cfb2">FUObjectType</a> (const char *typeName)</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Constructor: do not use directly.  <a href="#2720b7c1dc89ba2b04067fb54651cfb2"></a><br></td></tr>
38<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object_type.html#2ef2d00f85e58205470a634991bbd710">FUObjectType</a> (const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;parent, const char *typeName)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">[INTERNAL] Constructor: do not use directly.  <a href="#2ef2d00f85e58205470a634991bbd710"></a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">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_type.html#7b903f10975077d2d613a6cfe02762a8">GetParent</a> () const </td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the type of the down-class.  <a href="#7b903f10975077d2d613a6cfe02762a8"></a><br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object_type.html#c7bf4a03be4c6c482ca9e6df8771601b">Includes</a> (const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;otherType) const </td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether this object type includes a given object type.  <a href="#c7bf4a03be4c6c482ca9e6df8771601b"></a><br></td></tr>
47<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object_type.html#14945dfb834216b994e12e555c7e4ec6">operator==</a> (const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;otherType) const </td></tr>
48
49<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether a given object type is equivalent to this object type.  <a href="#14945dfb834216b994e12e555c7e4ec6"></a><br></td></tr>
50<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object_type.html#051455b488bf11ded50b271b261286dc">operator!=</a> (const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;otherType) const </td></tr>
51
52<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves whether a given object type is different from this object type.  <a href="#051455b488bf11ded50b271b261286dc"></a><br></td></tr>
53</table>
54<hr><a name="_details"></a><h2>Detailed Description</h2>
55An object type.
56<p>
57Used for RTTI-purpose and to easily allow up-classing of objects. Every object class should have one object type has a static member and available through the virtual <a class="el" href="class_f_u_object.html#f41252d8da713eae73cd7c1e9a95a9da">FUObject::GetObjectType</a> function. All <a class="el" href="class_f_u_object.html">FUObject</a> up-classes should use the DeclareObjectType macro.
58<p>
59<hr><h2>Constructor &amp; Destructor Documentation</h2>
60<a class="anchor" name="2720b7c1dc89ba2b04067fb54651cfb2"></a><!-- doxytag: member="FUObjectType::FUObjectType" ref="2720b7c1dc89ba2b04067fb54651cfb2" args="(const char *typeName)" --><p>
61<table class="mdTable" cellpadding="2" cellspacing="0">
62  <tr>
63    <td class="mdRow">
64      <table cellpadding="0" cellspacing="0" border="0">
65        <tr>
66          <td class="md" nowrap valign="top">FUObjectType::FUObjectType           </td>
67          <td class="md" valign="top">(&nbsp;</td>
68          <td class="md" nowrap valign="top">const char *&nbsp;</td>
69          <td class="mdname1" valign="top" nowrap> <em>typeName</em>          </td>
70          <td class="md" valign="top">&nbsp;)&nbsp;</td>
71          <td class="md" nowrap></td>
72        </tr>
73      </table>
74    </td>
75  </tr>
76</table>
77<table cellspacing="5" cellpadding="0" border="0">
78  <tr>
79    <td>
80      &nbsp;
81    </td>
82    <td>
83
84<p>
85[INTERNAL] Constructor: do not use directly.
86<p>
87Only the <a class="el" href="class_f_u_object.html">FUObject</a> class should use this constructor. All other class object types should use the constructor below. Use neither constructor directly: use the ImplementObjectType macro. <dl compact><dt><b>Parameters:</b></dt><dd>
88  <table border="0" cellspacing="2" cellpadding="0">
89    <tr><td valign="top"></td><td valign="top"><em>typeName</em>&nbsp;</td><td>The name of type. Used only in debug builds for debugging purposes. </td></tr>
90  </table>
91</dl>
92    </td>
93  </tr>
94</table>
95<a class="anchor" name="2ef2d00f85e58205470a634991bbd710"></a><!-- doxytag: member="FUObjectType::FUObjectType" ref="2ef2d00f85e58205470a634991bbd710" args="(const FUObjectType &amp;parent, const char *typeName)" --><p>
96<table class="mdTable" cellpadding="2" cellspacing="0">
97  <tr>
98    <td class="mdRow">
99      <table cellpadding="0" cellspacing="0" border="0">
100        <tr>
101          <td class="md" nowrap valign="top">FUObjectType::FUObjectType           </td>
102          <td class="md" valign="top">(&nbsp;</td>
103          <td class="md" nowrap valign="top">const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;&nbsp;</td>
104          <td class="mdname" nowrap> <em>parent</em>, </td>
105        </tr>
106        <tr>
107          <td class="md" nowrap align="right"></td>
108          <td class="md"></td>
109          <td class="md" nowrap>const char *&nbsp;</td>
110          <td class="mdname" nowrap> <em>typeName</em></td>
111        </tr>
112        <tr>
113          <td class="md"></td>
114          <td class="md">)&nbsp;</td>
115          <td class="md" colspan="2"></td>
116        </tr>
117      </table>
118    </td>
119  </tr>
120</table>
121<table cellspacing="5" cellpadding="0" border="0">
122  <tr>
123    <td>
124      &nbsp;
125    </td>
126    <td>
127
128<p>
129[INTERNAL] Constructor: do not use directly.
130<p>
131Use the ImplementObjectType macro. <dl compact><dt><b>Parameters:</b></dt><dd>
132  <table border="0" cellspacing="2" cellpadding="0">
133    <tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>The parent class object type. </td></tr>
134    <tr><td valign="top"></td><td valign="top"><em>typeName</em>&nbsp;</td><td>The name of type. Used only in debug builds for debugging purposes. </td></tr>
135  </table>
136</dl>
137    </td>
138  </tr>
139</table>
140<hr><h2>Member Function Documentation</h2>
141<a class="anchor" name="7b903f10975077d2d613a6cfe02762a8"></a><!-- doxytag: member="FUObjectType::GetParent" ref="7b903f10975077d2d613a6cfe02762a8" args="() const " --><p>
142<table class="mdTable" cellpadding="2" cellspacing="0">
143  <tr>
144    <td class="mdRow">
145      <table cellpadding="0" cellspacing="0" border="0">
146        <tr>
147          <td class="md" nowrap valign="top">const <a class="el" href="class_f_u_object_type.html">FUObjectType</a>&amp; FUObjectType::GetParent           </td>
148          <td class="md" valign="top">(&nbsp;</td>
149          <td class="mdname1" valign="top" nowrap>          </td>
150          <td class="md" valign="top">&nbsp;)&nbsp;</td>
151          <td class="md" nowrap> const<code> [inline]</code></td>
152        </tr>
153      </table>
154    </td>
155  </tr>
156</table>
157<table cellspacing="5" cellpadding="0" border="0">
158  <tr>
159    <td>
160      &nbsp;
161    </td>
162    <td>
163
164<p>
165Retrieves the type of the down-class.
166<p>
167<dl compact><dt><b>Returns:</b></dt><dd>The type of the down-class. The <a class="el" href="class_f_u_object.html">FUObject</a> class will return itself as the parent, so be careful when looping down. </dd></dl>
168    </td>
169  </tr>
170</table>
171<a class="anchor" name="c7bf4a03be4c6c482ca9e6df8771601b"></a><!-- doxytag: member="FUObjectType::Includes" ref="c7bf4a03be4c6c482ca9e6df8771601b" args="(const FUObjectType &amp;otherType) const " --><p>
172<table class="mdTable" cellpadding="2" cellspacing="0">
173  <tr>
174    <td class="mdRow">
175      <table cellpadding="0" cellspacing="0" border="0">
176        <tr>
177          <td class="md" nowrap valign="top">bool FUObjectType::Includes           </td>
178          <td class="md" valign="top">(&nbsp;</td>
179          <td class="md" nowrap valign="top">const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;&nbsp;</td>
180          <td class="mdname1" valign="top" nowrap> <em>otherType</em>          </td>
181          <td class="md" valign="top">&nbsp;)&nbsp;</td>
182          <td class="md" nowrap> const</td>
183        </tr>
184      </table>
185    </td>
186  </tr>
187</table>
188<table cellspacing="5" cellpadding="0" border="0">
189  <tr>
190    <td>
191      &nbsp;
192    </td>
193    <td>
194
195<p>
196Retrieves whether this object type includes a given object type.
197<p>
198This function allows you to verify if this object type is of a given object type or some up-class of the given object type. You should use this comparison function before up-casting an object. <dl compact><dt><b>Parameters:</b></dt><dd>
199  <table border="0" cellspacing="2" cellpadding="0">
200    <tr><td valign="top"></td><td valign="top"><em>otherType</em>&nbsp;</td><td>A second object type. </td></tr>
201  </table>
202</dl>
203<dl compact><dt><b>Returns:</b></dt><dd>Whether this object type includes the given object type. </dd></dl>
204    </td>
205  </tr>
206</table>
207<a class="anchor" name="051455b488bf11ded50b271b261286dc"></a><!-- doxytag: member="FUObjectType::operator!=" ref="051455b488bf11ded50b271b261286dc" args="(const FUObjectType &amp;otherType) const " --><p>
208<table class="mdTable" cellpadding="2" cellspacing="0">
209  <tr>
210    <td class="mdRow">
211      <table cellpadding="0" cellspacing="0" border="0">
212        <tr>
213          <td class="md" nowrap valign="top">bool FUObjectType::operator!=           </td>
214          <td class="md" valign="top">(&nbsp;</td>
215          <td class="md" nowrap valign="top">const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;&nbsp;</td>
216          <td class="mdname1" valign="top" nowrap> <em>otherType</em>          </td>
217          <td class="md" valign="top">&nbsp;)&nbsp;</td>
218          <td class="md" nowrap> const<code> [inline]</code></td>
219        </tr>
220      </table>
221    </td>
222  </tr>
223</table>
224<table cellspacing="5" cellpadding="0" border="0">
225  <tr>
226    <td>
227      &nbsp;
228    </td>
229    <td>
230
231<p>
232Retrieves whether a given object type is different from this object type.
233<p>
234<dl compact><dt><b>Parameters:</b></dt><dd>
235  <table border="0" cellspacing="2" cellpadding="0">
236    <tr><td valign="top"></td><td valign="top"><em>otherType</em>&nbsp;</td><td>A second object type. </td></tr>
237  </table>
238</dl>
239<dl compact><dt><b>Returns:</b></dt><dd>Whether the two object type are different. </dd></dl>
240    </td>
241  </tr>
242</table>
243<a class="anchor" name="14945dfb834216b994e12e555c7e4ec6"></a><!-- doxytag: member="FUObjectType::operator==" ref="14945dfb834216b994e12e555c7e4ec6" args="(const FUObjectType &amp;otherType) const " --><p>
244<table class="mdTable" cellpadding="2" cellspacing="0">
245  <tr>
246    <td class="mdRow">
247      <table cellpadding="0" cellspacing="0" border="0">
248        <tr>
249          <td class="md" nowrap valign="top">bool FUObjectType::operator==           </td>
250          <td class="md" valign="top">(&nbsp;</td>
251          <td class="md" nowrap valign="top">const <a class="el" href="class_f_u_object_type.html">FUObjectType</a> &amp;&nbsp;</td>
252          <td class="mdname1" valign="top" nowrap> <em>otherType</em>          </td>
253          <td class="md" valign="top">&nbsp;)&nbsp;</td>
254          <td class="md" nowrap> const<code> [inline]</code></td>
255        </tr>
256      </table>
257    </td>
258  </tr>
259</table>
260<table cellspacing="5" cellpadding="0" border="0">
261  <tr>
262    <td>
263      &nbsp;
264    </td>
265    <td>
266
267<p>
268Retrieves whether a given object type is equivalent to this object type.
269<p>
270<dl compact><dt><b>Parameters:</b></dt><dd>
271  <table border="0" cellspacing="2" cellpadding="0">
272    <tr><td valign="top"></td><td valign="top"><em>otherType</em>&nbsp;</td><td>A second object type. </td></tr>
273  </table>
274</dl>
275<dl compact><dt><b>Returns:</b></dt><dd>Whether the two object types are equivalent. </dd></dl>
276    </td>
277  </tr>
278</table>
279<hr>The documentation for this class was generated from the following file:<ul>
280<li>FUtils/<a class="el" href="_f_u_object_type_8h-source.html">FUObjectType.h</a></ul>
281<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by&nbsp;
282<a href="http://www.doxygen.org/index.html">
283<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
284</body>
285</html>
Note: See TracBrowser for help on using the repository browser.