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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ArchiveFactory 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::ArchiveFactory Class Reference</h1>Abstract factory class, archive codec plugins can register concrete subclasses of this. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreArchiveFactory_8h-source.html">OgreArchiveFactory.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ArchiveFactory:
16<p><center><img src="classOgre_1_1ArchiveFactory.png" usemap="#Ogre::ArchiveFactory_map" border="0" alt=""></center>
17<map name="Ogre::ArchiveFactory_map">
18<area href="classOgre_1_1FactoryObj.html" alt="Ogre::FactoryObj< Archive >" shape="rect" coords="103,0,300,24">
19<area href="classOgre_1_1FileSystemArchiveFactory.html" alt="Ogre::FileSystemArchiveFactory" shape="rect" coords="0,112,197,136">
20<area href="classOgre_1_1ZipArchiveFactory.html" alt="Ogre::ZipArchiveFactory" shape="rect" coords="207,112,404,136">
21</map>
22<a href="classOgre_1_1ArchiveFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
23<tr><td></td></tr>
24<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
25<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_1FactoryObj.html#Ogre_1_1FactoryObja1">getType</a> () const =0</td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the factory type.  <a href="#Ogre_1_1FactoryObja1"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1Archive.html">Archive</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FactoryObj.html#Ogre_1_1FactoryObja2">createInstance</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name)=0</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new object.  <a href="#Ogre_1_1FactoryObja2"></a><br><br></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FactoryObj.html#Ogre_1_1FactoryObja3">destroyInstance</a> (<a class="el" href="classOgre_1_1Archive.html">Archive</a> *)=0</td></tr>
32
33<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroys an object which was created by this factory.  <a href="#Ogre_1_1FactoryObja3"></a><br><br></td></tr>
34</table>
35<hr><a name="_details"></a><h2>Detailed Description</h2>
36Abstract factory class, archive codec plugins can register concrete subclasses of this.
37<p>
38<dl compact><dt><b>Remarks:</b></dt><dd>All access to 'archives' (collections of files, compressed or just folders, maybe even remote) is managed via the abstract <a class="el" href="classOgre_1_1Archive.html">Archive</a> class. Plugins are expected to provide the implementation for the actual codec itself, but because a subclass of <a class="el" href="classOgre_1_1Archive.html">Archive</a> has to be created for every archive, a factory class is required to create the appropriate subclass. </dd></dl>
39<dl compact><dt><b></b></dt><dd>So archive plugins create a subclass of <a class="el" href="classOgre_1_1Archive.html">Archive</a> AND a subclass of <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> which creates instances of the <a class="el" href="classOgre_1_1Archive.html">Archive</a> subclass. See the 'Zip' and 'FileSystem' plugins for examples. Each <a class="el" href="classOgre_1_1Archive.html">Archive</a> and <a class="el" href="classOgre_1_1ArchiveFactory.html">ArchiveFactory</a> subclass pair deal with a single archive type (identified by a string). </dd></dl>
40
41<p>
42
43<p>
44Definition at line <a class="el" href="OgreArchiveFactory_8h-source.html#l00050">50</a> of file <a class="el" href="OgreArchiveFactory_8h-source.html">OgreArchiveFactory.h</a>.<hr><h2>Member Function Documentation</h2>
45<a class="anchor" name="Ogre_1_1FactoryObja2" doxytag="Ogre::ArchiveFactory::createInstance" ></a><p>
46<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
47  <tr>
48    <td class="mdRow">
49      <table cellpadding="0" cellspacing="0" border="0">
50        <tr>
51          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1Archive.html">Archive</a> * <a class="el" href="classOgre_1_1FactoryObj.html">Ogre::FactoryObj</a>&lt; <a class="el" href="classOgre_1_1Archive.html">Archive</a>  &gt;::createInstance </td>
52          <td class="md" valign="top">(&nbsp;</td>
53          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
54          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
55          <td class="md" valign="top">&nbsp;)&nbsp;</td>
56          <td class="md" nowrap><code> [pure virtual, inherited]</code></td>
57        </tr>
58
59      </table>
60    </td>
61  </tr>
62</table>
63<table cellspacing=5 cellpadding=0 border=0>
64  <tr>
65    <td>
66      &nbsp;
67    </td>
68    <td>
69
70<p>
71Creates a new object.
72<p>
73<dl compact><dt><b>Parameters:</b></dt><dd>
74  <table border="0" cellspacing="2" cellpadding="0">
75    <tr><td valign=top><em>name</em>&nbsp;</td><td>Name of the object to create </td></tr>
76  </table>
77</dl>
78<dl compact><dt><b>Returns:</b></dt><dd>An object created by the factory. The type of the object depends on the factory. </dd></dl>
79
80<p>
81Implemented in <a class="el" href="classOgre_1_1FileSystemArchiveFactory.html#Ogre_1_1FileSystemArchiveFactorya2">Ogre::FileSystemArchiveFactory</a>, and <a class="el" href="classOgre_1_1ZipArchiveFactory.html#Ogre_1_1ZipArchiveFactorya2">Ogre::ZipArchiveFactory</a>.    </td>
82  </tr>
83</table>
84<a class="anchor" name="Ogre_1_1FactoryObja3" doxytag="Ogre::ArchiveFactory::destroyInstance" ></a><p>
85<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
86  <tr>
87    <td class="mdRow">
88      <table cellpadding="0" cellspacing="0" border="0">
89        <tr>
90          <td class="md" nowrap valign="top"> virtual void <a class="el" href="classOgre_1_1FactoryObj.html">Ogre::FactoryObj</a>&lt; <a class="el" href="classOgre_1_1Archive.html">Archive</a>  &gt;::destroyInstance </td>
91          <td class="md" valign="top">(&nbsp;</td>
92          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Archive.html">Archive</a>  *&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> [pure virtual, inherited]</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>
110Destroys an object which was created by this factory.
111<p>
112<dl compact><dt><b>Parameters:</b></dt><dd>
113  <table border="0" cellspacing="2" cellpadding="0">
114    <tr><td valign=top><em>ptr</em>&nbsp;</td><td>Pointer to the object to destroy </td></tr>
115  </table>
116</dl>
117
118<p>
119Implemented in <a class="el" href="classOgre_1_1FileSystemArchiveFactory.html#Ogre_1_1FileSystemArchiveFactorya3">Ogre::FileSystemArchiveFactory</a>, and <a class="el" href="classOgre_1_1ZipArchiveFactory.html#Ogre_1_1ZipArchiveFactorya3">Ogre::ZipArchiveFactory</a>.    </td>
120  </tr>
121</table>
122<a class="anchor" name="Ogre_1_1FactoryObja1" doxytag="Ogre::ArchiveFactory::getType" ></a><p>
123<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
124  <tr>
125    <td class="mdRow">
126      <table cellpadding="0" cellspacing="0" border="0">
127        <tr>
128          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; <a class="el" href="classOgre_1_1FactoryObj.html">Ogre::FactoryObj</a>&lt; <a class="el" href="classOgre_1_1Archive.html">Archive</a>  &gt;::getType </td>
129          <td class="md" valign="top">(&nbsp;</td>
130          <td class="md" nowrap valign="top">void&nbsp;</td>
131          <td class="mdname1" valign="top" nowrap>          </td>
132          <td class="md" valign="top">&nbsp;)&nbsp;</td>
133          <td class="md" nowrap> const<code> [pure virtual, inherited]</code></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>
148Returns the factory type.
149<p>
150<dl compact><dt><b>Returns:</b></dt><dd>The factory type. </dd></dl>
151
152<p>
153Implemented in <a class="el" href="classOgre_1_1FileSystemArchiveFactory.html#Ogre_1_1FileSystemArchiveFactorya1">Ogre::FileSystemArchiveFactory</a>, and <a class="el" href="classOgre_1_1ZipArchiveFactory.html#Ogre_1_1ZipArchiveFactorya1">Ogre::ZipArchiveFactory</a>.    </td>
154  </tr>
155</table>
156<hr>The documentation for this class was generated from the following file:<ul>
157<li><a class="el" href="OgreArchiveFactory_8h-source.html">OgreArchiveFactory.h</a></ul>
158<hr>
159<p>
160Copyright &copy; 2000-2005 by The OGRE Team<br />
161<!--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/>
162This 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/>
163                <!--/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#">
164                <Work rdf:about="">
165                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
166        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
167                </Work>
168                <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> -->
169
170Last modified Sun Feb 12 13:00:06 2006
171</p>
172</body>
173</html>
Note: See TracBrowser for help on using the repository browser.