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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ArchiveManager 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::ArchiveManager Class Reference</h1>This class manages the available <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> plugins. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ArchiveManager:
16<p><center><img src="classOgre_1_1ArchiveManager.png" usemap="#Ogre::ArchiveManager_map" border="0" alt=""></center>
17<map name="Ogre::ArchiveManager_map">
18<area href="classOgre_1_1Singleton.html" alt="Ogre::Singleton< ArchiveManager >" shape="rect" coords="0,0,219,24">
19</map>
20<a href="classOgre_1_1ArchiveManager-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_1ArchiveManager.html#Ogre_1_1ArchiveManagera0">ArchiveManager</a> ()</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor - should never get called by a client app.  <a href="#Ogre_1_1ArchiveManagera0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagera1">~ArchiveManager</a> ()</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor.  <a href="#Ogre_1_1ArchiveManagera1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1Archive.html">Archive</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagera2">load</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;archiveType)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Opens an archive for file reading.  <a href="#Ogre_1_1ArchiveManagera2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagera3">unload</a> (<a class="el" href="classOgre_1_1Archive.html">Archive</a> *arch)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unloads an archive.  <a href="#Ogre_1_1ArchiveManagera3"></a><br><br></td></tr>
35<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagera4">unload</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename)</td></tr>
36
37<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unloads an archive by name.  <a href="#Ogre_1_1ArchiveManagera4"></a><br><br></td></tr>
38<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagera5">addArchiveFactory</a> (<a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> *factory)</td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Adds a new <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> to the list of available factories.  <a href="#Ogre_1_1ArchiveManagera5"></a><br><br></td></tr>
41<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagere0">getSingleton</a> (void)</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1ArchiveManagere0"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagere1">getSingletonPtr</a> (void)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1ArchiveManagere1"></a><br><br></td></tr>
48<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
49<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a426">String</a>,<br>
50 <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx0">ArchiveFactoryMap</a></td></tr>
51
52<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a426">String</a>,<br>
53 <a class="el" href="classOgre_1_1Archive.html">Archive</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx1">ArchiveMap</a></td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Currently loaded archives.  <a href="#Ogre_1_1ArchiveManagerx1"></a><br><br></td></tr>
56<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
57<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx0">ArchiveFactoryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerp0">mArchFactories</a></td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Factories available to create archives, indexed by archive type (String identifier e.g. 'Zip').  <a href="#Ogre_1_1ArchiveManagerp0"></a><br><br></td></tr>
60<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx1">ArchiveMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerp1">mArchives</a></td></tr>
61
62<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
63<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a></td></tr>
64
65</table>
66<hr><a name="_details"></a><h2>Detailed Description</h2>
67This class manages the available <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> plugins.
68<p>
69
70<p>
71Definition at line <a class="el" href="OgreArchiveManager_8h-source.html#l00037">37</a> of file <a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a>.<hr><h2>Member Typedef Documentation</h2>
72<a class="anchor" name="Ogre_1_1ArchiveManagerx0" doxytag="Ogre::ArchiveManager::ArchiveFactoryMap" ></a><p>
73<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
74  <tr>
75    <td class="mdRow">
76      <table cellpadding="0" cellspacing="0" border="0">
77        <tr>
78          <td class="md" nowrap valign="top"> typedef std::map&lt;<a class="el" href="namespaceOgre.html#a426">String</a>, <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a>*&gt; <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx0">Ogre::ArchiveManager::ArchiveFactoryMap</a><code> [protected]</code>
79      </table>
80    </td>
81  </tr>
82</table>
83<table cellspacing=5 cellpadding=0 border=0>
84  <tr>
85    <td>
86      &nbsp;
87    </td>
88    <td>
89
90<p>
91
92<p>
93Definition at line <a class="el" href="OgreArchiveManager_8h-source.html#l00040">40</a> of file <a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a>.    </td>
94  </tr>
95</table>
96<a class="anchor" name="Ogre_1_1ArchiveManagerx1" doxytag="Ogre::ArchiveManager::ArchiveMap" ></a><p>
97<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
98  <tr>
99    <td class="mdRow">
100      <table cellpadding="0" cellspacing="0" border="0">
101        <tr>
102          <td class="md" nowrap valign="top"> typedef std::map&lt;<a class="el" href="namespaceOgre.html#a426">String</a>, <a class="el" href="classOgre_1_1Archive.html">Archive</a>*&gt; <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx1">Ogre::ArchiveManager::ArchiveMap</a><code> [protected]</code>
103      </table>
104    </td>
105  </tr>
106</table>
107<table cellspacing=5 cellpadding=0 border=0>
108  <tr>
109    <td>
110      &nbsp;
111    </td>
112    <td>
113
114<p>
115Currently loaded archives.
116<p>
117
118<p>
119Definition at line <a class="el" href="OgreArchiveManager_8h-source.html#l00044">44</a> of file <a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a>.    </td>
120  </tr>
121</table>
122<hr><h2>Constructor &amp; Destructor Documentation</h2>
123<a class="anchor" name="Ogre_1_1ArchiveManagera0" doxytag="Ogre::ArchiveManager::ArchiveManager" ></a><p>
124<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
125  <tr>
126    <td class="mdRow">
127      <table cellpadding="0" cellspacing="0" border="0">
128        <tr>
129          <td class="md" nowrap valign="top"> Ogre::ArchiveManager::ArchiveManager </td>
130          <td class="md" valign="top">(&nbsp;</td>
131          <td class="mdname1" valign="top" nowrap>          </td>
132          <td class="md" valign="top">&nbsp;)&nbsp;</td>
133          <td class="md" nowrap></td>
134        </tr>
135
136      </table>
137    </td>
138  </tr>
139</table>
140<table cellspacing=5 cellpadding=0 border=0>
141  <tr>
142    <td>
143      &nbsp;
144    </td>
145    <td>
146
147<p>
148Default constructor - should never get called by a client app.
149<p>
150
151<p>
152Definition at line <a class="el" href="OgreArchiveManager_8h-source.html#l00050">50</a> of file <a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a>.    </td>
153  </tr>
154</table>
155<a class="anchor" name="Ogre_1_1ArchiveManagera1" doxytag="Ogre::ArchiveManager::~ArchiveManager" ></a><p>
156<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
157  <tr>
158    <td class="mdRow">
159      <table cellpadding="0" cellspacing="0" border="0">
160        <tr>
161          <td class="md" nowrap valign="top"> virtual Ogre::ArchiveManager::~<a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> </td>
162          <td class="md" valign="top">(&nbsp;</td>
163          <td class="mdname1" valign="top" nowrap>          </td>
164          <td class="md" valign="top">&nbsp;)&nbsp;</td>
165          <td class="md" nowrap><code> [virtual]</code></td>
166        </tr>
167
168      </table>
169    </td>
170  </tr>
171</table>
172<table cellspacing=5 cellpadding=0 border=0>
173  <tr>
174    <td>
175      &nbsp;
176    </td>
177    <td>
178
179<p>
180Default destructor.
181<p>
182    </td>
183  </tr>
184</table>
185<hr><h2>Member Function Documentation</h2>
186<a class="anchor" name="Ogre_1_1ArchiveManagera5" doxytag="Ogre::ArchiveManager::addArchiveFactory" ></a><p>
187<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
188  <tr>
189    <td class="mdRow">
190      <table cellpadding="0" cellspacing="0" border="0">
191        <tr>
192          <td class="md" nowrap valign="top"> void Ogre::ArchiveManager::addArchiveFactory </td>
193          <td class="md" valign="top">(&nbsp;</td>
194          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> *&nbsp;</td>
195          <td class="mdname1" valign="top" nowrap> <em>factory</em>          </td>
196          <td class="md" valign="top">&nbsp;)&nbsp;</td>
197          <td class="md" nowrap></td>
198        </tr>
199
200      </table>
201    </td>
202  </tr>
203</table>
204<table cellspacing=5 cellpadding=0 border=0>
205  <tr>
206    <td>
207      &nbsp;
208    </td>
209    <td>
210
211<p>
212Adds a new <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> to the list of available factories.
213<p>
214<dl compact><dt><b>Remarks:</b></dt><dd>Plugin developers who add new archive codecs need to call this after defining their <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> subclass and <a class="el" href="classOgre_1_1Archive.html">Archive</a> subclasses for their archive type. </dd></dl>
215    </td>
216  </tr>
217</table>
218<a class="anchor" name="Ogre_1_1ArchiveManagere0" doxytag="Ogre::ArchiveManager::getSingleton" ></a><p>
219<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
220  <tr>
221    <td class="mdRow">
222      <table cellpadding="0" cellspacing="0" border="0">
223        <tr>
224          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a>&amp; Ogre::ArchiveManager::getSingleton </td>
225          <td class="md" valign="top">(&nbsp;</td>
226          <td class="md" nowrap valign="top">void&nbsp;</td>
227          <td class="mdname1" valign="top" nowrap>          </td>
228          <td class="md" valign="top">&nbsp;)&nbsp;</td>
229          <td class="md" nowrap><code> [static]</code></td>
230        </tr>
231
232      </table>
233    </td>
234  </tr>
235</table>
236<table cellspacing=5 cellpadding=0 border=0>
237  <tr>
238    <td>
239      &nbsp;
240    </td>
241    <td>
242
243<p>
244Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
245<p>
246<dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl>
247<dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl>
248
249<p>
250Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone0">Ogre::Singleton&lt; ArchiveManager &gt;</a>.    </td>
251  </tr>
252</table>
253<a class="anchor" name="Ogre_1_1ArchiveManagere1" doxytag="Ogre::ArchiveManager::getSingletonPtr" ></a><p>
254<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
255  <tr>
256    <td class="mdRow">
257      <table cellpadding="0" cellspacing="0" border="0">
258        <tr>
259          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a>* Ogre::ArchiveManager::getSingletonPtr </td>
260          <td class="md" valign="top">(&nbsp;</td>
261          <td class="md" nowrap valign="top">void&nbsp;</td>
262          <td class="mdname1" valign="top" nowrap>          </td>
263          <td class="md" valign="top">&nbsp;)&nbsp;</td>
264          <td class="md" nowrap><code> [static]</code></td>
265        </tr>
266
267      </table>
268    </td>
269  </tr>
270</table>
271<table cellspacing=5 cellpadding=0 border=0>
272  <tr>
273    <td>
274      &nbsp;
275    </td>
276    <td>
277
278<p>
279Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
280<p>
281<dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl>
282<dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl>
283
284<p>
285Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone1">Ogre::Singleton&lt; ArchiveManager &gt;</a>.    </td>
286  </tr>
287</table>
288<a class="anchor" name="Ogre_1_1ArchiveManagera2" doxytag="Ogre::ArchiveManager::load" ></a><p>
289<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
290  <tr>
291    <td class="mdRow">
292      <table cellpadding="0" cellspacing="0" border="0">
293        <tr>
294          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1Archive.html">Archive</a>* Ogre::ArchiveManager::load </td>
295          <td class="md" valign="top">(&nbsp;</td>
296          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
297          <td class="mdname" nowrap> <em>filename</em>, </td>
298        </tr>
299        <tr>
300          <td class="md" nowrap align="right"></td>
301          <td></td>
302          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
303          <td class="mdname" nowrap> <em>archiveType</em></td>
304        </tr>
305        <tr>
306          <td></td>
307          <td class="md">)&nbsp;</td>
308          <td class="md" colspan="2"></td>
309        </tr>
310
311      </table>
312    </td>
313  </tr>
314</table>
315<table cellspacing=5 cellpadding=0 border=0>
316  <tr>
317    <td>
318      &nbsp;
319    </td>
320    <td>
321
322<p>
323Opens an archive for file reading.
324<p>
325<dl compact><dt><b>Remarks:</b></dt><dd>The archives are created using class factories within extension libraries. </dd></dl>
326<dl compact><dt><b>Parameters:</b></dt><dd>
327  <table border="0" cellspacing="2" cellpadding="0">
328    <tr><td valign=top><em>filename</em>&nbsp;</td><td>The filename that will be opened </td></tr>
329    <tr><td valign=top><em>refLibrary</em>&nbsp;</td><td>The library that contains the data-handling code </td></tr>
330  </table>
331</dl>
332<dl compact><dt><b>Returns:</b></dt><dd>If the function succeeds, a valid pointer to an <a class="el" href="classOgre_1_1Archive.html">Archive</a> object is returened. </dd></dl>
333<dl compact><dt><b></b></dt><dd>If the function fails, an exception is thrown. </dd></dl>
334    </td>
335  </tr>
336</table>
337<a class="anchor" name="Ogre_1_1ArchiveManagera4" doxytag="Ogre::ArchiveManager::unload" ></a><p>
338<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
339  <tr>
340    <td class="mdRow">
341      <table cellpadding="0" cellspacing="0" border="0">
342        <tr>
343          <td class="md" nowrap valign="top"> void Ogre::ArchiveManager::unload </td>
344          <td class="md" valign="top">(&nbsp;</td>
345          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
346          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
347          <td class="md" valign="top">&nbsp;)&nbsp;</td>
348          <td class="md" nowrap></td>
349        </tr>
350
351      </table>
352    </td>
353  </tr>
354</table>
355<table cellspacing=5 cellpadding=0 border=0>
356  <tr>
357    <td>
358      &nbsp;
359    </td>
360    <td>
361
362<p>
363Unloads an archive by name.
364<p>
365<dl compact><dt><b>Remarks:</b></dt><dd>You must ensure that this archive is not being used before removing it.</dd></dl>
366    </td>
367  </tr>
368</table>
369<a class="anchor" name="Ogre_1_1ArchiveManagera3" doxytag="Ogre::ArchiveManager::unload" ></a><p>
370<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
371  <tr>
372    <td class="mdRow">
373      <table cellpadding="0" cellspacing="0" border="0">
374        <tr>
375          <td class="md" nowrap valign="top"> void Ogre::ArchiveManager::unload </td>
376          <td class="md" valign="top">(&nbsp;</td>
377          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Archive.html">Archive</a> *&nbsp;</td>
378          <td class="mdname1" valign="top" nowrap> <em>arch</em>          </td>
379          <td class="md" valign="top">&nbsp;)&nbsp;</td>
380          <td class="md" nowrap></td>
381        </tr>
382
383      </table>
384    </td>
385  </tr>
386</table>
387<table cellspacing=5 cellpadding=0 border=0>
388  <tr>
389    <td>
390      &nbsp;
391    </td>
392    <td>
393
394<p>
395Unloads an archive.
396<p>
397<dl compact><dt><b>Remarks:</b></dt><dd>You must ensure that this archive is not being used before removing it.</dd></dl>
398    </td>
399  </tr>
400</table>
401<hr><h2>Member Data Documentation</h2>
402<a class="anchor" name="Ogre_1_1ArchiveManagerp0" doxytag="Ogre::ArchiveManager::mArchFactories" ></a><p>
403<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
404  <tr>
405    <td class="mdRow">
406      <table cellpadding="0" cellspacing="0" border="0">
407        <tr>
408          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx0">ArchiveFactoryMap</a> <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerp0">Ogre::ArchiveManager::mArchFactories</a><code> [protected]</code>
409      </table>
410    </td>
411  </tr>
412</table>
413<table cellspacing=5 cellpadding=0 border=0>
414  <tr>
415    <td>
416      &nbsp;
417    </td>
418    <td>
419
420<p>
421Factories available to create archives, indexed by archive type (String identifier e.g. 'Zip').
422<p>
423
424<p>
425Definition at line <a class="el" href="OgreArchiveManager_8h-source.html#l00042">42</a> of file <a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a>.    </td>
426  </tr>
427</table>
428<a class="anchor" name="Ogre_1_1ArchiveManagerp1" doxytag="Ogre::ArchiveManager::mArchives" ></a><p>
429<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
430  <tr>
431    <td class="mdRow">
432      <table cellpadding="0" cellspacing="0" border="0">
433        <tr>
434          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerx1">ArchiveMap</a> <a class="el" href="classOgre_1_1ArchiveManager.html#Ogre_1_1ArchiveManagerp1">Ogre::ArchiveManager::mArchives</a><code> [protected]</code>
435      </table>
436    </td>
437  </tr>
438</table>
439<table cellspacing=5 cellpadding=0 border=0>
440  <tr>
441    <td>
442      &nbsp;
443    </td>
444    <td>
445
446<p>
447
448<p>
449Definition at line <a class="el" href="OgreArchiveManager_8h-source.html#l00045">45</a> of file <a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a>.    </td>
450  </tr>
451</table>
452<a class="anchor" name="Ogre_1_1Singletont0" doxytag="Ogre::ArchiveManager::ms_Singleton" ></a><p>
453<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
454  <tr>
455    <td class="mdRow">
456      <table cellpadding="0" cellspacing="0" border="0">
457        <tr>
458          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a> * <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; <a class="el" href="classOgre_1_1ArchiveManager.html">ArchiveManager</a>  &gt;::<a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a><code> [static, protected, inherited]</code>
459      </table>
460    </td>
461  </tr>
462</table>
463<table cellspacing=5 cellpadding=0 border=0>
464  <tr>
465    <td>
466      &nbsp;
467    </td>
468    <td>
469
470<p>
471
472<p>
473Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00054">54</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
474  </tr>
475</table>
476<hr>The documentation for this class was generated from the following file:<ul>
477<li><a class="el" href="OgreArchiveManager_8h-source.html">OgreArchiveManager.h</a></ul>
478<hr>
479<p>
480Copyright &copy; 2000-2005 by The OGRE Team<br />
481<!--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/>
482This 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/>
483                <!--/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#">
484                <Work rdf:about="">
485                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
486        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
487                </Work>
488                <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> -->
489
490Last modified Sun Feb 12 13:00:06 2006
491</p>
492</body>
493</html>
Note: See TracBrowser for help on using the repository browser.