source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1FactoryObj.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> TemplateOgre::FactoryObj&lt; T &gt; 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::FactoryObj&lt; T &gt; Class Template Reference</h1>Abstract factory class. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreFactoryObj_8h-source.html">OgreFactoryObj.h</a>&gt;</code>
14<p>
15<a href="classOgre_1_1FactoryObj-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
16<tr><td></td></tr>
17<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
18<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FactoryObj.html#Ogre_1_1FactoryObja0">~FactoryObj</a> ()</td></tr>
19
20<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>
21
22<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the factory type.  <a href="#Ogre_1_1FactoryObja1"></a><br><br></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>virtual T *&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>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new object.  <a href="#Ogre_1_1FactoryObja2"></a><br><br></td></tr>
26<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> (T *)=0</td></tr>
27
28<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>
29</table>
30<hr><a name="_details"></a><h2>Detailed Description</h2>
31<h3>template&lt;typename T&gt;<br>
32 class Ogre::FactoryObj&lt; T &gt;</h3>
33
34Abstract factory class.
35<p>
36Does nothing by itself, but derived classes can add functionality.
37<p>
38
39<p>
40Definition at line <a class="el" href="OgreFactoryObj_8h-source.html#l00035">35</a> of file <a class="el" href="OgreFactoryObj_8h-source.html">OgreFactoryObj.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
41<a class="anchor" name="Ogre_1_1FactoryObja0" doxytag="Ogre::FactoryObj::~FactoryObj" ></a><p>
42<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
43  <tr>
44    <td class="mdRow">
45      <table cellpadding="0" cellspacing="0" border="0">
46        <tr>
47          <td class="md" colspan="4">
48template&lt;typename T&gt; </td>
49        </tr>
50        <tr>
51          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1FactoryObj.html">Ogre::FactoryObj</a>&lt; T &gt;::~<a class="el" href="classOgre_1_1FactoryObj.html">FactoryObj</a> </td>
52          <td class="md" valign="top">(&nbsp;</td>
53          <td class="mdname1" valign="top" nowrap>          </td>
54          <td class="md" valign="top">&nbsp;)&nbsp;</td>
55          <td class="md" nowrap><code> [virtual]</code></td>
56        </tr>
57
58      </table>
59    </td>
60  </tr>
61</table>
62<table cellspacing=5 cellpadding=0 border=0>
63  <tr>
64    <td>
65      &nbsp;
66    </td>
67    <td>
68
69<p>
70
71<p>
72Definition at line <a class="el" href="OgreFactoryObj_8h-source.html#l00038">38</a> of file <a class="el" href="OgreFactoryObj_8h-source.html">OgreFactoryObj.h</a>.    </td>
73  </tr>
74</table>
75<hr><h2>Member Function Documentation</h2>
76<a class="anchor" name="Ogre_1_1FactoryObja2" doxytag="Ogre::FactoryObj::createInstance" ></a><p>
77<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
78  <tr>
79    <td class="mdRow">
80      <table cellpadding="0" cellspacing="0" border="0">
81        <tr>
82          <td class="md" colspan="4">
83template&lt;typename T&gt; </td>
84        </tr>
85        <tr>
86          <td class="md" nowrap valign="top"> virtual T* <a class="el" href="classOgre_1_1FactoryObj.html">Ogre::FactoryObj</a>&lt; T &gt;::createInstance </td>
87          <td class="md" valign="top">(&nbsp;</td>
88          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
89          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
90          <td class="md" valign="top">&nbsp;)&nbsp;</td>
91          <td class="md" nowrap><code> [pure virtual]</code></td>
92        </tr>
93
94      </table>
95    </td>
96  </tr>
97</table>
98<table cellspacing=5 cellpadding=0 border=0>
99  <tr>
100    <td>
101      &nbsp;
102    </td>
103    <td>
104
105<p>
106Creates a new object.
107<p>
108<dl compact><dt><b>Parameters:</b></dt><dd>
109  <table border="0" cellspacing="2" cellpadding="0">
110    <tr><td valign=top><em>name</em>&nbsp;</td><td>Name of the object to create </td></tr>
111  </table>
112</dl>
113<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>
114
115<p>
116Implemented in <a class="el" href="classOgre_1_1BillboardParticleRendererFactory.html#Ogre_1_1BillboardParticleRendererFactorya1">Ogre::BillboardParticleRendererFactory</a>, <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>
117  </tr>
118</table>
119<a class="anchor" name="Ogre_1_1FactoryObja3" doxytag="Ogre::FactoryObj::destroyInstance" ></a><p>
120<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
121  <tr>
122    <td class="mdRow">
123      <table cellpadding="0" cellspacing="0" border="0">
124        <tr>
125          <td class="md" colspan="4">
126template&lt;typename T&gt; </td>
127        </tr>
128        <tr>
129          <td class="md" nowrap valign="top"> virtual void <a class="el" href="classOgre_1_1FactoryObj.html">Ogre::FactoryObj</a>&lt; T &gt;::destroyInstance </td>
130          <td class="md" valign="top">(&nbsp;</td>
131          <td class="md" nowrap valign="top">T *&nbsp;</td>
132          <td class="mdname1" valign="top" nowrap>          </td>
133          <td class="md" valign="top">&nbsp;)&nbsp;</td>
134          <td class="md" nowrap><code> [pure virtual]</code></td>
135        </tr>
136
137      </table>
138    </td>
139  </tr>
140</table>
141<table cellspacing=5 cellpadding=0 border=0>
142  <tr>
143    <td>
144      &nbsp;
145    </td>
146    <td>
147
148<p>
149Destroys an object which was created by this factory.
150<p>
151<dl compact><dt><b>Parameters:</b></dt><dd>
152  <table border="0" cellspacing="2" cellpadding="0">
153    <tr><td valign=top><em>ptr</em>&nbsp;</td><td>Pointer to the object to destroy </td></tr>
154  </table>
155</dl>
156
157<p>
158Implemented in <a class="el" href="classOgre_1_1BillboardParticleRendererFactory.html#Ogre_1_1BillboardParticleRendererFactorya2">Ogre::BillboardParticleRendererFactory</a>, <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>
159  </tr>
160</table>
161<a class="anchor" name="Ogre_1_1FactoryObja1" doxytag="Ogre::FactoryObj::getType" ></a><p>
162<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
163  <tr>
164    <td class="mdRow">
165      <table cellpadding="0" cellspacing="0" border="0">
166        <tr>
167          <td class="md" colspan="4">
168template&lt;typename T&gt; </td>
169        </tr>
170        <tr>
171          <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; T &gt;::getType </td>
172          <td class="md" valign="top">(&nbsp;</td>
173          <td class="mdname1" valign="top" nowrap>          </td>
174          <td class="md" valign="top">&nbsp;)&nbsp;</td>
175          <td class="md" nowrap> const<code> [pure virtual]</code></td>
176        </tr>
177
178      </table>
179    </td>
180  </tr>
181</table>
182<table cellspacing=5 cellpadding=0 border=0>
183  <tr>
184    <td>
185      &nbsp;
186    </td>
187    <td>
188
189<p>
190Returns the factory type.
191<p>
192<dl compact><dt><b>Returns:</b></dt><dd>The factory type. </dd></dl>
193
194<p>
195Implemented in <a class="el" href="classOgre_1_1BillboardParticleRendererFactory.html#Ogre_1_1BillboardParticleRendererFactorya0">Ogre::BillboardParticleRendererFactory</a>, <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>
196  </tr>
197</table>
198<hr>The documentation for this class was generated from the following file:<ul>
199<li><a class="el" href="OgreFactoryObj_8h-source.html">OgreFactoryObj.h</a></ul>
200<hr>
201<p>
202Copyright &copy; 2000-2005 by The OGRE Team<br />
203<!--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/>
204This 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/>
205                <!--/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#">
206                <Work rdf:about="">
207                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
208        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
209                </Work>
210                <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> -->
211
212Last modified Sun Feb 12 13:00:27 2006
213</p>
214</body>
215</html>
Note: See TracBrowser for help on using the repository browser.