source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1SceneManagerFactory.html @ 692

Revision 692, 17.3 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::SceneManagerFactory 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::SceneManagerFactory Class Reference</h1>Class which will create instances of a given <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::SceneManagerFactory:
16<p><center><img src="classOgre_1_1SceneManagerFactory.png" usemap="#Ogre::SceneManagerFactory_map" border="0" alt=""></center>
17<map name="Ogre::SceneManagerFactory_map">
18<area href="classOgre_1_1BspSceneManagerFactory.html" alt="Ogre::BspSceneManagerFactory" shape="rect" coords="0,56,219,80">
19<area href="classOgre_1_1DefaultSceneManagerFactory.html" alt="Ogre::DefaultSceneManagerFactory" shape="rect" coords="229,56,448,80">
20<area href="classOgre_1_1OctreeSceneManagerFactory.html" alt="Ogre::OctreeSceneManagerFactory" shape="rect" coords="458,56,677,80">
21<area href="classOgre_1_1TerrainSceneManagerFactory.html" alt="Ogre::TerrainSceneManagerFactory" shape="rect" coords="687,56,906,80">
22</map>
23<a href="classOgre_1_1SceneManagerFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
24<tr><td></td></tr>
25<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1SceneManagerFactorya0">SceneManagerFactory</a> ()</td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1SceneManagerFactorya1">~SceneManagerFactory</a> ()</td></tr>
29
30<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="structOgre_1_1SceneManagerMetaData.html">SceneManagerMetaData</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactorya4">getMetaData</a> (void) const </td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get information about the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> type created by this factory.  <a href="#Ogre_1_1TerrainSceneManagerFactorya4"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1SceneManagerFactorya3">createInstance</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;instanceName)=0</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new instance of a <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>.  <a href="#Ogre_1_1SceneManagerFactorya3"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1SceneManagerFactorya4">destroyInstance</a> (<a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *instance)=0</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy an instance of a <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>.  <a href="#Ogre_1_1SceneManagerFactorya4"></a><br><br></td></tr>
39<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
40<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1SceneManagerFactoryb0">initMetaData</a> (void) const=0</td></tr>
41
42<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method to initialise the metadata, must be implemented.  <a href="#Ogre_1_1SceneManagerFactoryb0"></a><br><br></td></tr>
43<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
44<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="structOgre_1_1SceneManagerMetaData.html">SceneManagerMetaData</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactoryp1">mMetaData</a></td></tr>
45
46<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactoryp2">mMetaDataInit</a></td></tr>
47
48</table>
49<hr><a name="_details"></a><h2>Detailed Description</h2>
50Class which will create instances of a given <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>.
51<p>
52
53<p>
54Definition at line <a class="el" href="OgreSceneManager_8h-source.html#l02415">2415</a> of file <a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
55<a class="anchor" name="Ogre_1_1SceneManagerFactorya0" doxytag="Ogre::SceneManagerFactory::SceneManagerFactory" ></a><p>
56<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
57  <tr>
58    <td class="mdRow">
59      <table cellpadding="0" cellspacing="0" border="0">
60        <tr>
61          <td class="md" nowrap valign="top"> Ogre::SceneManagerFactory::SceneManagerFactory </td>
62          <td class="md" valign="top">(&nbsp;</td>
63          <td class="mdname1" valign="top" nowrap>          </td>
64          <td class="md" valign="top">&nbsp;)&nbsp;</td>
65          <td class="md" nowrap></td>
66        </tr>
67
68      </table>
69    </td>
70  </tr>
71</table>
72<table cellspacing=5 cellpadding=0 border=0>
73  <tr>
74    <td>
75      &nbsp;
76    </td>
77    <td>
78
79<p>
80
81<p>
82Definition at line <a class="el" href="OgreSceneManager_8h-source.html#l02423">2423</a> of file <a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a>.    </td>
83  </tr>
84</table>
85<a class="anchor" name="Ogre_1_1SceneManagerFactorya1" doxytag="Ogre::SceneManagerFactory::~SceneManagerFactory" ></a><p>
86<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
87  <tr>
88    <td class="mdRow">
89      <table cellpadding="0" cellspacing="0" border="0">
90        <tr>
91          <td class="md" nowrap valign="top"> virtual Ogre::SceneManagerFactory::~<a class="el" href="classOgre_1_1SceneManagerFactory.html">SceneManagerFactory</a> </td>
92          <td class="md" valign="top">(&nbsp;</td>
93          <td class="mdname1" valign="top" nowrap>          </td>
94          <td class="md" valign="top">&nbsp;)&nbsp;</td>
95          <td class="md" nowrap><code> [virtual]</code></td>
96        </tr>
97
98      </table>
99    </td>
100  </tr>
101</table>
102<table cellspacing=5 cellpadding=0 border=0>
103  <tr>
104    <td>
105      &nbsp;
106    </td>
107    <td>
108
109<p>
110
111<p>
112Definition at line <a class="el" href="OgreSceneManager_8h-source.html#l02424">2424</a> of file <a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a>.    </td>
113  </tr>
114</table>
115<hr><h2>Member Function Documentation</h2>
116<a class="anchor" name="Ogre_1_1SceneManagerFactorya3" doxytag="Ogre::SceneManagerFactory::createInstance" ></a><p>
117<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
118  <tr>
119    <td class="mdRow">
120      <table cellpadding="0" cellspacing="0" border="0">
121        <tr>
122          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>* Ogre::SceneManagerFactory::createInstance </td>
123          <td class="md" valign="top">(&nbsp;</td>
124          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
125          <td class="mdname1" valign="top" nowrap> <em>instanceName</em>          </td>
126          <td class="md" valign="top">&nbsp;)&nbsp;</td>
127          <td class="md" nowrap><code> [pure virtual]</code></td>
128        </tr>
129
130      </table>
131    </td>
132  </tr>
133</table>
134<table cellspacing=5 cellpadding=0 border=0>
135  <tr>
136    <td>
137      &nbsp;
138    </td>
139    <td>
140
141<p>
142Create a new instance of a <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>.
143<p>
144<dl compact><dt><b>Remarks:</b></dt><dd>Don't call directly, use <a class="el" href="classOgre_1_1SceneManagerEnumerator.html#Ogre_1_1SceneManagerEnumeratora6">SceneManagerEnumerator::createSceneManager</a>.</dd></dl>
145
146<p>
147Implemented in <a class="el" href="classOgre_1_1DefaultSceneManagerFactory.html#Ogre_1_1DefaultSceneManagerFactorya2">Ogre::DefaultSceneManagerFactory</a>, <a class="el" href="classOgre_1_1BspSceneManagerFactory.html#Ogre_1_1BspSceneManagerFactorya2">Ogre::BspSceneManagerFactory</a>, <a class="el" href="classOgre_1_1OctreeSceneManagerFactory.html#Ogre_1_1OctreeSceneManagerFactorya2">Ogre::OctreeSceneManagerFactory</a>, and <a class="el" href="classOgre_1_1TerrainSceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactorya2">Ogre::TerrainSceneManagerFactory</a>.    </td>
148  </tr>
149</table>
150<a class="anchor" name="Ogre_1_1SceneManagerFactorya4" doxytag="Ogre::SceneManagerFactory::destroyInstance" ></a><p>
151<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
152  <tr>
153    <td class="mdRow">
154      <table cellpadding="0" cellspacing="0" border="0">
155        <tr>
156          <td class="md" nowrap valign="top"> virtual void Ogre::SceneManagerFactory::destroyInstance </td>
157          <td class="md" valign="top">(&nbsp;</td>
158          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> *&nbsp;</td>
159          <td class="mdname1" valign="top" nowrap> <em>instance</em>          </td>
160          <td class="md" valign="top">&nbsp;)&nbsp;</td>
161          <td class="md" nowrap><code> [pure virtual]</code></td>
162        </tr>
163
164      </table>
165    </td>
166  </tr>
167</table>
168<table cellspacing=5 cellpadding=0 border=0>
169  <tr>
170    <td>
171      &nbsp;
172    </td>
173    <td>
174
175<p>
176Destroy an instance of a <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a>.
177<p>
178
179<p>
180Implemented in <a class="el" href="classOgre_1_1DefaultSceneManagerFactory.html#Ogre_1_1DefaultSceneManagerFactorya3">Ogre::DefaultSceneManagerFactory</a>, <a class="el" href="classOgre_1_1BspSceneManagerFactory.html#Ogre_1_1BspSceneManagerFactorya3">Ogre::BspSceneManagerFactory</a>, <a class="el" href="classOgre_1_1OctreeSceneManagerFactory.html#Ogre_1_1OctreeSceneManagerFactorya3">Ogre::OctreeSceneManagerFactory</a>, and <a class="el" href="classOgre_1_1TerrainSceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactorya3">Ogre::TerrainSceneManagerFactory</a>.    </td>
181  </tr>
182</table>
183<a class="anchor" name="Ogre_1_1TerrainSceneManagerFactorya4" doxytag="Ogre::SceneManagerFactory::getMetaData" ></a><p>
184<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
185  <tr>
186    <td class="mdRow">
187      <table cellpadding="0" cellspacing="0" border="0">
188        <tr>
189          <td class="md" nowrap valign="top"> virtual const <a class="el" href="structOgre_1_1SceneManagerMetaData.html">SceneManagerMetaData</a>&amp; Ogre::SceneManagerFactory::getMetaData </td>
190          <td class="md" valign="top">(&nbsp;</td>
191          <td class="md" nowrap valign="top">void&nbsp;</td>
192          <td class="mdname1" valign="top" nowrap>          </td>
193          <td class="md" valign="top">&nbsp;)&nbsp;</td>
194          <td class="md" nowrap> const<code> [virtual]</code></td>
195        </tr>
196
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>
209Get information about the <a class="el" href="classOgre_1_1SceneManager.html">SceneManager</a> type created by this factory.
210<p>
211
212<p>
213Definition at line <a class="el" href="OgreSceneManager_8h-source.html#l02426">2426</a> of file <a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a>.    </td>
214  </tr>
215</table>
216<a class="anchor" name="Ogre_1_1SceneManagerFactoryb0" doxytag="Ogre::SceneManagerFactory::initMetaData" ></a><p>
217<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
218  <tr>
219    <td class="mdRow">
220      <table cellpadding="0" cellspacing="0" border="0">
221        <tr>
222          <td class="md" nowrap valign="top"> virtual void Ogre::SceneManagerFactory::initMetaData </td>
223          <td class="md" valign="top">(&nbsp;</td>
224          <td class="md" nowrap valign="top">void&nbsp;</td>
225          <td class="mdname1" valign="top" nowrap>          </td>
226          <td class="md" valign="top">&nbsp;)&nbsp;</td>
227          <td class="md" nowrap> const<code> [protected, pure virtual]</code></td>
228        </tr>
229
230      </table>
231    </td>
232  </tr>
233</table>
234<table cellspacing=5 cellpadding=0 border=0>
235  <tr>
236    <td>
237      &nbsp;
238    </td>
239    <td>
240
241<p>
242Internal method to initialise the metadata, must be implemented.
243<p>
244
245<p>
246Implemented in <a class="el" href="classOgre_1_1DefaultSceneManagerFactory.html#Ogre_1_1DefaultSceneManagerFactoryb0">Ogre::DefaultSceneManagerFactory</a>, <a class="el" href="classOgre_1_1BspSceneManagerFactory.html#Ogre_1_1BspSceneManagerFactoryb0">Ogre::BspSceneManagerFactory</a>, <a class="el" href="classOgre_1_1OctreeSceneManagerFactory.html#Ogre_1_1OctreeSceneManagerFactoryb0">Ogre::OctreeSceneManagerFactory</a>, and <a class="el" href="classOgre_1_1TerrainSceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactoryb0">Ogre::TerrainSceneManagerFactory</a>.    </td>
247  </tr>
248</table>
249<hr><h2>Member Data Documentation</h2>
250<a class="anchor" name="Ogre_1_1TerrainSceneManagerFactoryp1" doxytag="Ogre::SceneManagerFactory::mMetaData" ></a><p>
251<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
252  <tr>
253    <td class="mdRow">
254      <table cellpadding="0" cellspacing="0" border="0">
255        <tr>
256          <td class="md" nowrap valign="top"> <a class="el" href="structOgre_1_1SceneManagerMetaData.html">SceneManagerMetaData</a> <a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactoryp1">Ogre::SceneManagerFactory::mMetaData</a><code> [mutable, protected]</code>
257      </table>
258    </td>
259  </tr>
260</table>
261<table cellspacing=5 cellpadding=0 border=0>
262  <tr>
263    <td>
264      &nbsp;
265    </td>
266    <td>
267
268<p>
269
270<p>
271Definition at line <a class="el" href="OgreSceneManager_8h-source.html#l02418">2418</a> of file <a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a>.    </td>
272  </tr>
273</table>
274<a class="anchor" name="Ogre_1_1TerrainSceneManagerFactoryp2" doxytag="Ogre::SceneManagerFactory::mMetaDataInit" ></a><p>
275<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
276  <tr>
277    <td class="mdRow">
278      <table cellpadding="0" cellspacing="0" border="0">
279        <tr>
280          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1SceneManagerFactory.html#Ogre_1_1TerrainSceneManagerFactoryp2">Ogre::SceneManagerFactory::mMetaDataInit</a><code> [mutable, protected]</code>
281      </table>
282    </td>
283  </tr>
284</table>
285<table cellspacing=5 cellpadding=0 border=0>
286  <tr>
287    <td>
288      &nbsp;
289    </td>
290    <td>
291
292<p>
293
294<p>
295Definition at line <a class="el" href="OgreSceneManager_8h-source.html#l02419">2419</a> of file <a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a>.    </td>
296  </tr>
297</table>
298<hr>The documentation for this class was generated from the following file:<ul>
299<li><a class="el" href="OgreSceneManager_8h-source.html">OgreSceneManager.h</a></ul>
300<hr>
301<p>
302Copyright &copy; 2000-2005 by The OGRE Team<br />
303<!--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/>
304This 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/>
305                <!--/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#">
306                <Work rdf:about="">
307                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
308        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
309                </Work>
310                <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> -->
311
312Last modified Sun Mar 12 14:43:28 2006
313</p>
314</body>
315</html>
Note: See TracBrowser for help on using the repository browser.