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

Revision 657, 9.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::ParticleSystemRendererFactory 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::ParticleSystemRendererFactory Class Reference</h1>Abstract class definition of a factory object for <a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::ParticleSystemRendererFactory:
16<p><center><img src="classOgre_1_1ParticleSystemRendererFactory.png" usemap="#Ogre::ParticleSystemRendererFactory_map" border="0" alt=""></center>
17<map name="Ogre::ParticleSystemRendererFactory_map">
18<area href="classOgre_1_1FactoryObj.html" alt="Ogre::FactoryObj< ParticleSystemRenderer >" shape="rect" coords="0,0,271,24">
19<area href="classOgre_1_1BillboardParticleRendererFactory.html" alt="Ogre::BillboardParticleRendererFactory" shape="rect" coords="0,112,271,136">
20</map>
21<a href="classOgre_1_1ParticleSystemRendererFactory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
22<tr><td></td></tr>
23<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
24<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>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the factory type.  <a href="#Ogre_1_1FactoryObja1"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</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>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new object.  <a href="#Ogre_1_1FactoryObja2"></a><br><br></td></tr>
30<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_1ParticleSystemRenderer.html">ParticleSystemRenderer</a> *)=0</td></tr>
31
32<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>
33</table>
34<hr><a name="_details"></a><h2>Detailed Description</h2>
35Abstract class definition of a factory object for <a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>.
36<p>
37
38<p>
39Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00097">97</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.<hr><h2>Member Function Documentation</h2>
40<a class="anchor" name="Ogre_1_1FactoryObja2" doxytag="Ogre::ParticleSystemRendererFactory::createInstance" ></a><p>
41<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
42  <tr>
43    <td class="mdRow">
44      <table cellpadding="0" cellspacing="0" border="0">
45        <tr>
46          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a> * <a class="el" href="classOgre_1_1FactoryObj.html">Ogre::FactoryObj</a>&lt; <a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>  &gt;::createInstance </td>
47          <td class="md" valign="top">(&nbsp;</td>
48          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
49          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
50          <td class="md" valign="top">&nbsp;)&nbsp;</td>
51          <td class="md" nowrap><code> [pure virtual, inherited]</code></td>
52        </tr>
53
54      </table>
55    </td>
56  </tr>
57</table>
58<table cellspacing=5 cellpadding=0 border=0>
59  <tr>
60    <td>
61      &nbsp;
62    </td>
63    <td>
64
65<p>
66Creates a new object.
67<p>
68<dl compact><dt><b>Parameters:</b></dt><dd>
69  <table border="0" cellspacing="2" cellpadding="0">
70    <tr><td valign=top><em>name</em>&nbsp;</td><td>Name of the object to create </td></tr>
71  </table>
72</dl>
73<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>
74
75<p>
76Implemented in <a class="el" href="classOgre_1_1BillboardParticleRendererFactory.html#Ogre_1_1BillboardParticleRendererFactorya1">Ogre::BillboardParticleRendererFactory</a>.    </td>
77  </tr>
78</table>
79<a class="anchor" name="Ogre_1_1FactoryObja3" doxytag="Ogre::ParticleSystemRendererFactory::destroyInstance" ></a><p>
80<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
81  <tr>
82    <td class="mdRow">
83      <table cellpadding="0" cellspacing="0" border="0">
84        <tr>
85          <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_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>  &gt;::destroyInstance </td>
86          <td class="md" valign="top">(&nbsp;</td>
87          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>  *&nbsp;</td>
88          <td class="mdname1" valign="top" nowrap>          </td>
89          <td class="md" valign="top">&nbsp;)&nbsp;</td>
90          <td class="md" nowrap><code> [pure virtual, inherited]</code></td>
91        </tr>
92
93      </table>
94    </td>
95  </tr>
96</table>
97<table cellspacing=5 cellpadding=0 border=0>
98  <tr>
99    <td>
100      &nbsp;
101    </td>
102    <td>
103
104<p>
105Destroys an object which was created by this factory.
106<p>
107<dl compact><dt><b>Parameters:</b></dt><dd>
108  <table border="0" cellspacing="2" cellpadding="0">
109    <tr><td valign=top><em>ptr</em>&nbsp;</td><td>Pointer to the object to destroy </td></tr>
110  </table>
111</dl>
112
113<p>
114Implemented in <a class="el" href="classOgre_1_1BillboardParticleRendererFactory.html#Ogre_1_1BillboardParticleRendererFactorya2">Ogre::BillboardParticleRendererFactory</a>.    </td>
115  </tr>
116</table>
117<a class="anchor" name="Ogre_1_1FactoryObja1" doxytag="Ogre::ParticleSystemRendererFactory::getType" ></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"> 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_1ParticleSystemRenderer.html">ParticleSystemRenderer</a>  &gt;::getType </td>
124          <td class="md" valign="top">(&nbsp;</td>
125          <td class="md" nowrap valign="top">void&nbsp;</td>
126          <td class="mdname1" valign="top" nowrap>          </td>
127          <td class="md" valign="top">&nbsp;)&nbsp;</td>
128          <td class="md" nowrap> const<code> [pure virtual, inherited]</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>
143Returns the factory type.
144<p>
145<dl compact><dt><b>Returns:</b></dt><dd>The factory type. </dd></dl>
146
147<p>
148Implemented in <a class="el" href="classOgre_1_1BillboardParticleRendererFactory.html#Ogre_1_1BillboardParticleRendererFactorya0">Ogre::BillboardParticleRendererFactory</a>.    </td>
149  </tr>
150</table>
151<hr>The documentation for this class was generated from the following file:<ul>
152<li><a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a></ul>
153<hr>
154<p>
155Copyright &copy; 2000-2005 by The OGRE Team<br />
156<!--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/>
157This 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/>
158                <!--/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#">
159                <Work rdf:about="">
160                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
161        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
162                </Work>
163                <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> -->
164
165Last modified Sun Feb 12 13:01:56 2006
166</p>
167</body>
168</html>
Note: See TracBrowser for help on using the repository browser.