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

Revision 692, 17.1 KB checked in by mattausch, 18 years ago (diff)

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