source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1UserDefinedObject.html @ 657

Revision 657, 11.8 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::UserDefinedObject class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::UserDefinedObject Class Reference</h1>This class is designed to be subclassed by OGRE users, to allow them to associate their own application objects with <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> instances in the engine. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreUserDefinedObject_8h-source.html">OgreUserDefinedObject.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::UserDefinedObject:
16<p><center><img src="classOgre_1_1UserDefinedObject.png" usemap="#Ogre::UserDefinedObject_map" border="0" alt=""></center>
17<map name="Ogre::UserDefinedObject_map">
18<area href="classOgreRefApp_1_1ApplicationObject.html" alt="OgreRefApp::ApplicationObject" shape="rect" coords="398,56,587,80">
19<area href="classOgreRefApp_1_1Ball.html" alt="OgreRefApp::Ball" shape="rect" coords="0,112,189,136">
20<area href="classOgreRefApp_1_1Box.html" alt="OgreRefApp::Box" shape="rect" coords="199,112,388,136">
21<area href="classOgreRefApp_1_1CollideCamera.html" alt="OgreRefApp::CollideCamera" shape="rect" coords="398,112,587,136">
22<area href="classOgreRefApp_1_1FinitePlane.html" alt="OgreRefApp::FinitePlane" shape="rect" coords="597,112,786,136">
23<area href="classOgreRefApp_1_1OgreHead.html" alt="OgreRefApp::OgreHead" shape="rect" coords="796,112,985,136">
24</map>
25<a href="classOgre_1_1UserDefinedObject-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
26<tr><td></td></tr>
27<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1UserDefinedObject.html#Ogre_1_1UserDefinedObjecta0">UserDefinedObject</a> ()</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Standard constructor.  <a href="#Ogre_1_1UserDefinedObjecta0"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1UserDefinedObject.html#Ogre_1_1UserDefinedObjecta1">~UserDefinedObject</a> ()</td></tr>
32
33<tr><td class="memItemLeft" nowrap align=right valign=top>virtual long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1UserDefinedObject.html#Ogre_1_1UserDefinedObjecta2">getTypeID</a> (void) const </td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a number identifying the type of user defined object.  <a href="#Ogre_1_1UserDefinedObjecta2"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1UserDefinedObject.html#Ogre_1_1UserDefinedObjecta3">getTypeName</a> (void) const </td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return a string identifying the type of user defined object.  <a href="#Ogre_1_1UserDefinedObjecta3"></a><br><br></td></tr>
39</table>
40<hr><a name="_details"></a><h2>Detailed Description</h2>
41This class is designed to be subclassed by OGRE users, to allow them to associate their own application objects with <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> instances in the engine.
42<p>
43<dl compact><dt><b>Remarks:</b></dt><dd>It's always been suggested that an OGRE application would likley comprise a number of game objects which would keep pointers to OGRE objects in order to maintain the link. However, in some cases it would be very useful to be able to navigate directly from an OGRE instance back to a custom application object. This abstract class exists for this purpose; MovableObjects hold a pointer to a <a class="el" href="classOgre_1_1UserDefinedObject.html">UserDefinedObject</a> instance, which application writers subclass in order to include their own attributes. Your game objects themselves may be subclasses of this class, or your subclasses may merely be a link between them. </dd></dl>
44<dl compact><dt><b></b></dt><dd>Because OGRE never uses instances of this object itself, there is very little definition to this class; the application is expected to add all the detail it wants. However, as a hint, and for debugging purposes, this class does define a 'type id', which it is recommended you use to differentiate between your subclasses, if you have more than one type. </dd></dl>
45
46<p>
47
48<p>
49Definition at line <a class="el" href="OgreUserDefinedObject_8h-source.html#l00052">52</a> of file <a class="el" href="OgreUserDefinedObject_8h-source.html">OgreUserDefinedObject.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
50<a class="anchor" name="Ogre_1_1UserDefinedObjecta0" doxytag="Ogre::UserDefinedObject::UserDefinedObject" ></a><p>
51<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
52  <tr>
53    <td class="mdRow">
54      <table cellpadding="0" cellspacing="0" border="0">
55        <tr>
56          <td class="md" nowrap valign="top"> Ogre::UserDefinedObject::UserDefinedObject </td>
57          <td class="md" valign="top">(&nbsp;</td>
58          <td class="mdname1" valign="top" nowrap>          </td>
59          <td class="md" valign="top">&nbsp;)&nbsp;</td>
60          <td class="md" nowrap></td>
61        </tr>
62
63      </table>
64    </td>
65  </tr>
66</table>
67<table cellspacing=5 cellpadding=0 border=0>
68  <tr>
69    <td>
70      &nbsp;
71    </td>
72    <td>
73
74<p>
75Standard constructor.
76<p>
77    </td>
78  </tr>
79</table>
80<a class="anchor" name="Ogre_1_1UserDefinedObjecta1" doxytag="Ogre::UserDefinedObject::~UserDefinedObject" ></a><p>
81<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
82  <tr>
83    <td class="mdRow">
84      <table cellpadding="0" cellspacing="0" border="0">
85        <tr>
86          <td class="md" nowrap valign="top"> virtual Ogre::UserDefinedObject::~<a class="el" href="classOgre_1_1UserDefinedObject.html">UserDefinedObject</a> </td>
87          <td class="md" valign="top">(&nbsp;</td>
88          <td class="mdname1" valign="top" nowrap>          </td>
89          <td class="md" valign="top">&nbsp;)&nbsp;</td>
90          <td class="md" nowrap><code> [virtual]</code></td>
91        </tr>
92
93      </table>
94    </td>
95  </tr>
96</table>
97<table cellspacing=5 cellpadding=0 border=0>
98  <tr>
99    <td>
100      &nbsp;
101    </td>
102    <td>
103
104<p>
105
106<p>
107Definition at line <a class="el" href="OgreUserDefinedObject_8h-source.html#l00057">57</a> of file <a class="el" href="OgreUserDefinedObject_8h-source.html">OgreUserDefinedObject.h</a>.    </td>
108  </tr>
109</table>
110<hr><h2>Member Function Documentation</h2>
111<a class="anchor" name="Ogre_1_1UserDefinedObjecta2" doxytag="Ogre::UserDefinedObject::getTypeID" ></a><p>
112<table class="mdTable" width="100%" 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"> virtual long Ogre::UserDefinedObject::getTypeID </td>
118          <td class="md" valign="top">(&nbsp;</td>
119          <td class="md" nowrap valign="top">void&nbsp;</td>
120          <td class="mdname1" valign="top" nowrap>          </td>
121          <td class="md" valign="top">&nbsp;)&nbsp;</td>
122          <td class="md" nowrap> const<code> [virtual]</code></td>
123        </tr>
124
125      </table>
126    </td>
127  </tr>
128</table>
129<table cellspacing=5 cellpadding=0 border=0>
130  <tr>
131    <td>
132      &nbsp;
133    </td>
134    <td>
135
136<p>
137Return a number identifying the type of user defined object.
138<p>
139<dl compact><dt><b>Remarks:</b></dt><dd>Can be used to differentiate between different types of object which you attach to OGRE <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> instances. Recommend you override this in your classes if you use more than one type of object. </dd></dl>
140<dl compact><dt><b></b></dt><dd>Alternatively, you can override the getTypeName method and use that instead; that version is a litle more friendly and easier to scope, but obviously slightly less efficient. You choose which you prefer. </dd></dl>
141    </td>
142  </tr>
143</table>
144<a class="anchor" name="Ogre_1_1UserDefinedObjecta3" doxytag="Ogre::UserDefinedObject::getTypeName" ></a><p>
145<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
146  <tr>
147    <td class="mdRow">
148      <table cellpadding="0" cellspacing="0" border="0">
149        <tr>
150          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::UserDefinedObject::getTypeName </td>
151          <td class="md" valign="top">(&nbsp;</td>
152          <td class="md" nowrap valign="top">void&nbsp;</td>
153          <td class="mdname1" valign="top" nowrap>          </td>
154          <td class="md" valign="top">&nbsp;)&nbsp;</td>
155          <td class="md" nowrap> const<code> [virtual]</code></td>
156        </tr>
157
158      </table>
159    </td>
160  </tr>
161</table>
162<table cellspacing=5 cellpadding=0 border=0>
163  <tr>
164    <td>
165      &nbsp;
166    </td>
167    <td>
168
169<p>
170Return a string identifying the type of user defined object.
171<p>
172<dl compact><dt><b>Remarks:</b></dt><dd>Can be used to differentiate between different types of object which you attach to OGRE <a class="el" href="classOgre_1_1MovableObject.html">MovableObject</a> instances. Recommend you override this in your classes if you use more than one type of object. </dd></dl>
173<dl compact><dt><b></b></dt><dd>Alternatively, you can override the getTypeID method and use that instead; that version is a litle more efficient, but obviously slightly less easy to read. You choose which you prefer. </dd></dl>
174    </td>
175  </tr>
176</table>
177<hr>The documentation for this class was generated from the following file:<ul>
178<li><a class="el" href="OgreUserDefinedObject_8h-source.html">OgreUserDefinedObject.h</a></ul>
179<hr>
180<p>
181Copyright &copy; 2000-2005 by The OGRE Team<br />
182<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
183This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
184                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
185                <Work rdf:about="">
186                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
187        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
188                </Work>
189                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
190
191Last modified Sun Feb 12 13:04:50 2006
192</p>
193</body>
194</html>
Note: See TracBrowser for help on using the repository browser.