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

Revision 964, 6.5 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: FUtils/FUObjectType.h File 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><a href="classes.html"><span>Classes</span></a></li>
14    <li id="current"><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="files.html"><span>File&nbsp;List</span></a></li>
20    <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
21  </ul></div>
22<h1>FUtils/FUObjectType.h File Reference</h1>This file contains the <a class="el" href="class_f_u_object_type.html">FUObjectType</a> class. <a href="#_details">More...</a>
23<p>
24
25<p>
26<a href="_f_u_object_type_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
27<tr><td></td></tr>
28<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
29<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_object_type.html">FUObjectType</a></td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An object type.  <a href="class_f_u_object_type.html#_details">More...</a><br></td></tr>
32<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
33<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_u_object_type_8h.html#8124b8a8706cd10260f8cd5a7bd8e691">DeclareObjectType</a></td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Declares the object type for an object class.  <a href="#8124b8a8706cd10260f8cd5a7bd8e691"></a><br></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="_f_u_object_type_8h.html#b802267a2825b27523642ca6b87a383e">ImplementObjectType</a>(ClassName, ParentClassName)&nbsp;&nbsp;&nbsp;<a class="el" href="class_f_u_object_type.html">FUObjectType</a> ClassName::__classType(ParentClassName::GetClassType(), #ClassName) \</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implements the object type for an object class.  <a href="#b802267a2825b27523642ca6b87a383e"></a><br></td></tr>
39</table>
40<hr><a name="_details"></a><h2>Detailed Description</h2>
41This file contains the <a class="el" href="class_f_u_object_type.html">FUObjectType</a> class.
42<p>
43<hr><h2>Define Documentation</h2>
44<a class="anchor" name="8124b8a8706cd10260f8cd5a7bd8e691"></a><!-- doxytag: member="FUObjectType.h::DeclareObjectType" ref="8124b8a8706cd10260f8cd5a7bd8e691" args="" --><p>
45<table class="mdTable" cellpadding="2" cellspacing="0">
46  <tr>
47    <td class="mdRow">
48      <table cellpadding="0" cellspacing="0" border="0">
49        <tr>
50          <td class="md" nowrap valign="top">#define DeclareObjectType          </td>
51        </tr>
52      </table>
53    </td>
54  </tr>
55</table>
56<table cellspacing="5" cellpadding="0" border="0">
57  <tr>
58    <td>
59      &nbsp;
60    </td>
61    <td>
62
63<p>
64<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">private</span>: \
65    <span class="keyword">static</span> <span class="keyword">class </span><a class="code" href="class_f_u_object_type.html">FUObjectType</a> __classType; \
66<span class="keyword">public</span>: \
67    <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="class_f_u_object_type.html">FUObjectType</a>&amp; GetClassType() { <span class="keywordflow">return</span> __classType; } \
68    <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="class_f_u_object_type.html">FUObjectType</a>&amp; GetObjectType()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> __classType; } \
69<span class="keyword">private</span>:
70</pre></div>Declares the object type for an object class.
71<p>
72Use this macro inside the class declarations of up-classes of the <a class="el" href="class_f_u_object.html">FUObject</a> class to easily implement RTTI.     </td>
73  </tr>
74</table>
75<a class="anchor" name="b802267a2825b27523642ca6b87a383e"></a><!-- doxytag: member="FUObjectType.h::ImplementObjectType" ref="b802267a2825b27523642ca6b87a383e" args="(ClassName, ParentClassName)" --><p>
76<table class="mdTable" cellpadding="2" cellspacing="0">
77  <tr>
78    <td class="mdRow">
79      <table cellpadding="0" cellspacing="0" border="0">
80        <tr>
81          <td class="md" nowrap valign="top">#define ImplementObjectType          </td>
82          <td class="md" valign="top">(&nbsp;</td>
83          <td class="md" nowrap valign="top">ClassName,         <tr>
84          <td class="md" nowrap align="right"></td>
85          <td class="md"></td>
86          <td class="md" nowrap>ParentClassName&nbsp;</td>
87          <td class="mdname1" valign="top" nowrap>          </td>
88          <td class="md" valign="top">&nbsp;)&nbsp;</td>
89          <td class="md" nowrap>&nbsp;&nbsp;&nbsp;<a class="el" href="class_f_u_object_type.html">FUObjectType</a> ClassName::__classType(ParentClassName::GetClassType(), #ClassName) \</td>
90        </tr>
91      </table>
92    </td>
93  </tr>
94</table>
95<table cellspacing="5" cellpadding="0" border="0">
96  <tr>
97    <td>
98      &nbsp;
99    </td>
100    <td>
101
102<p>
103Implements the object type for an object class.
104<p>
105Use this macro inside your code files only to create the objects necessary to support RTTI in your up-classes of the <a class="el" href="class_f_u_object.html">FUObject</a> class. <dl compact><dt><b>Parameters:</b></dt><dd>
106  <table border="0" cellspacing="2" cellpadding="0">
107    <tr><td valign="top"></td><td valign="top"><em>ClassName</em>&nbsp;</td><td>The name of the class. </td></tr>
108    <tr><td valign="top"></td><td valign="top"><em>ParentClassName</em>&nbsp;</td><td>The name of the down-class of the given class. </td></tr>
109  </table>
110</dl>
111    </td>
112  </tr>
113</table>
114<hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:40 2006 for FCollada by&nbsp;
115<a href="http://www.doxygen.org/index.html">
116<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address>
117</body>
118</html>
Note: See TracBrowser for help on using the repository browser.