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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::ParticleSystemRenderer 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::ParticleSystemRenderer Class Reference</h1>Abstract class defining the interface required to be implemented by classes which provide rendering capability to <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> instances. 
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::ParticleSystemRenderer:
16<p><center><img src="classOgre_1_1ParticleSystemRenderer.png" usemap="#Ogre::ParticleSystemRenderer_map" border="0" alt=""></center>
17<map name="Ogre::ParticleSystemRenderer_map">
18<area href="classOgre_1_1StringInterface.html" alt="Ogre::StringInterface" shape="rect" coords="0,0,193,24">
19<area href="classOgre_1_1BillboardParticleRenderer.html" alt="Ogre::BillboardParticleRenderer" shape="rect" coords="0,112,193,136">
20</map>
21<a href="classOgre_1_1ParticleSystemRenderer-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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera0">ParticleSystemRenderer</a> ()</td></tr>
25
26<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#Ogre_1_1ParticleSystemRenderera0"></a><br><br></td></tr>
27<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera1">~ParticleSystemRenderer</a> ()</td></tr>
28
29<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#Ogre_1_1ParticleSystemRenderera1"></a><br><br></td></tr>
30<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_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera2">getType</a> (void) const=0</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the type of this renderer - must be implemented by subclasses.  <a href="#Ogre_1_1ParticleSystemRenderera2"></a><br><br></td></tr>
33<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera3">_updateRenderQueue</a> (<a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *queue, std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt; &amp;currentParticles, bool cullIndividually)=0</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema31">ParticleSystem::_updateRenderQueue</a>.  <a href="#Ogre_1_1ParticleSystemRenderera3"></a><br><br></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera4">_setMaterial</a> (<a class="el" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;mat)=0</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the material this renderer must use; called by <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.  <a href="#Ogre_1_1ParticleSystemRenderera4"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera5">_notifyCurrentCamera</a> (<a class="el" href="classOgre_1_1Camera.html">Camera</a> *cam)=0</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema27">ParticleSystem::_notifyCurrentCamera</a>.  <a href="#Ogre_1_1ParticleSystemRenderera5"></a><br><br></td></tr>
42<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera6">_notifyAttached</a> (<a class="el" href="classOgre_1_1Node.html">Node</a> *parent, bool isTagPoint=false)=0</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema28">ParticleSystem::_notifyAttached</a>.  <a href="#Ogre_1_1ParticleSystemRenderera6"></a><br><br></td></tr>
45<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera7">_notifyParticleRotated</a> (void)</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Optional callback notified when particles are rotated.  <a href="#Ogre_1_1ParticleSystemRenderera7"></a><br><br></td></tr>
48<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera8">_notifyParticleResized</a> (void)</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Optional callback notified when particles are resized individually.  <a href="#Ogre_1_1ParticleSystemRenderera8"></a><br><br></td></tr>
51<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera9">_notifyParticleQuota</a> (size_t quota)=0</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells the renderer that the particle quota has changed.  <a href="#Ogre_1_1ParticleSystemRenderera9"></a><br><br></td></tr>
54<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera10">_notifyDefaultDimensions</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> width, <a class="el" href="namespaceOgre.html#a420">Real</a> height)=0</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tells the renderer that the particle default size has changed.  <a href="#Ogre_1_1ParticleSystemRenderera10"></a><br><br></td></tr>
57<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera11">_createVisualData</a> (void)</td></tr>
58
59<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> instance for attachment to a particle.  <a href="#Ogre_1_1ParticleSystemRenderera11"></a><br><br></td></tr>
60<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera12">_destroyVisualData</a> (<a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *vis)</td></tr>
61
62<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> instance.  <a href="#Ogre_1_1ParticleSystemRenderera12"></a><br><br></td></tr>
63<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera13">setRenderQueueGroup</a> (<a class="el" href="namespaceOgre.html#a669">RenderQueueGroupID</a> queueID)=0</td></tr>
64
65<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets which render queue group this renderer should target with it's output.  <a href="#Ogre_1_1ParticleSystemRenderera13"></a><br><br></td></tr>
66<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea44">getParamDictionary</a> (void)</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter dictionary for this class.  <a href="#Ogre_1_1Texturea44"></a><br><br></td></tr>
69<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea45">getParamDictionary</a> (void) const </td></tr>
70
71<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a518">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">getParameters</a> (void) const </td></tr>
72
73<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1Texturea46"></a><br><br></td></tr>
74<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">setParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;value)</td></tr>
75
76<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter setting method.  <a href="#Ogre_1_1Texturea47"></a><br><br></td></tr>
77<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea48">setParameterList</a> (const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;paramList)</td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic multiple parameter setting method.  <a href="#Ogre_1_1Texturea48"></a><br><br></td></tr>
80<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea49">getParameter</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;name) const </td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter retrieval method.  <a href="#Ogre_1_1Texturea49"></a><br><br></td></tr>
83<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea50">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const </td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for copying this object's parameters to another object.  <a href="#Ogre_1_1Texturea50"></a><br><br></td></tr>
86<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
87<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturee0">cleanupDictionary</a> ()</td></tr>
88
89<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.  <a href="#Ogre_1_1Texturee0"></a><br><br></td></tr>
90<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
91<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Textureb6">createParamDictionary</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;className)</td></tr>
92
93<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Internal method for creating a parameter dictionary for the class, if it does not already exist.  <a href="#Ogre_1_1Textureb6"></a><br><br></td></tr>
94<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
95<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a426">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">mParamDictName</a></td></tr>
96
97<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Class name for this instance to be used as a lookup (must be initialised by subclasses).  <a href="#Ogre_1_1Texturep26"></a><br><br></td></tr>
98<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
99<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">msDictionary</a></td></tr>
100
101<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dictionary of parameters.  <a href="#Ogre_1_1Texturet0"></a><br><br></td></tr>
102</table>
103<hr><a name="_details"></a><h2>Detailed Description</h2>
104Abstract class defining the interface required to be implemented by classes which provide rendering capability to <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a> instances.
105<p>
106
107<p>
108Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00038">38</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
109<a class="anchor" name="Ogre_1_1ParticleSystemRenderera0" doxytag="Ogre::ParticleSystemRenderer::ParticleSystemRenderer" ></a><p>
110<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
111  <tr>
112    <td class="mdRow">
113      <table cellpadding="0" cellspacing="0" border="0">
114        <tr>
115          <td class="md" nowrap valign="top"> Ogre::ParticleSystemRenderer::ParticleSystemRenderer </td>
116          <td class="md" valign="top">(&nbsp;</td>
117          <td class="mdname1" valign="top" nowrap>          </td>
118          <td class="md" valign="top">&nbsp;)&nbsp;</td>
119          <td class="md" nowrap></td>
120        </tr>
121
122      </table>
123    </td>
124  </tr>
125</table>
126<table cellspacing=5 cellpadding=0 border=0>
127  <tr>
128    <td>
129      &nbsp;
130    </td>
131    <td>
132
133<p>
134Constructor.
135<p>
136
137<p>
138Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00042">42</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
139  </tr>
140</table>
141<a class="anchor" name="Ogre_1_1ParticleSystemRenderera1" doxytag="Ogre::ParticleSystemRenderer::~ParticleSystemRenderer" ></a><p>
142<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
143  <tr>
144    <td class="mdRow">
145      <table cellpadding="0" cellspacing="0" border="0">
146        <tr>
147          <td class="md" nowrap valign="top"> virtual Ogre::ParticleSystemRenderer::~<a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a> </td>
148          <td class="md" valign="top">(&nbsp;</td>
149          <td class="mdname1" valign="top" nowrap>          </td>
150          <td class="md" valign="top">&nbsp;)&nbsp;</td>
151          <td class="md" nowrap><code> [virtual]</code></td>
152        </tr>
153
154      </table>
155    </td>
156  </tr>
157</table>
158<table cellspacing=5 cellpadding=0 border=0>
159  <tr>
160    <td>
161      &nbsp;
162    </td>
163    <td>
164
165<p>
166Destructor.
167<p>
168
169<p>
170Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00044">44</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
171  </tr>
172</table>
173<hr><h2>Member Function Documentation</h2>
174<a class="anchor" name="Ogre_1_1ParticleSystemRenderera11" doxytag="Ogre::ParticleSystemRenderer::_createVisualData" ></a><p>
175<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
176  <tr>
177    <td class="mdRow">
178      <table cellpadding="0" cellspacing="0" border="0">
179        <tr>
180          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a>* Ogre::ParticleSystemRenderer::_createVisualData </td>
181          <td class="md" valign="top">(&nbsp;</td>
182          <td class="md" nowrap valign="top">void&nbsp;</td>
183          <td class="mdname1" valign="top" nowrap>          </td>
184          <td class="md" valign="top">&nbsp;)&nbsp;</td>
185          <td class="md" nowrap><code> [virtual]</code></td>
186        </tr>
187
188      </table>
189    </td>
190  </tr>
191</table>
192<table cellspacing=5 cellpadding=0 border=0>
193  <tr>
194    <td>
195      &nbsp;
196    </td>
197    <td>
198
199<p>
200Create a new <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> instance for attachment to a particle.
201<p>
202<dl compact><dt><b>Remarks:</b></dt><dd>If this renderer needs additional data in each particle, then this should be held in an instance of a subclass of <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a>, and this method should be overridden to return a new instance of it. The default behaviour is to return null.</dd></dl>
203
204<p>
205Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00078">78</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
206  </tr>
207</table>
208<a class="anchor" name="Ogre_1_1ParticleSystemRenderera12" doxytag="Ogre::ParticleSystemRenderer::_destroyVisualData" ></a><p>
209<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
210  <tr>
211    <td class="mdRow">
212      <table cellpadding="0" cellspacing="0" border="0">
213        <tr>
214          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_destroyVisualData </td>
215          <td class="md" valign="top">(&nbsp;</td>
216          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *&nbsp;</td>
217          <td class="mdname1" valign="top" nowrap> <em>vis</em>          </td>
218          <td class="md" valign="top">&nbsp;)&nbsp;</td>
219          <td class="md" nowrap><code> [virtual]</code></td>
220        </tr>
221
222      </table>
223    </td>
224  </tr>
225</table>
226<table cellspacing=5 cellpadding=0 border=0>
227  <tr>
228    <td>
229      &nbsp;
230    </td>
231    <td>
232
233<p>
234Destroy a <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> instance.
235<p>
236<dl compact><dt><b>Remarks:</b></dt><dd>If this renderer needs additional data in each particle, then this should be held in an instance of a subclass of <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a>, and this method should be overridden to destroy an instance of it. The default behaviour is to do nothing.</dd></dl>
237
238<p>
239Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00086">86</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
240  </tr>
241</table>
242<a class="anchor" name="Ogre_1_1ParticleSystemRenderera6" doxytag="Ogre::ParticleSystemRenderer::_notifyAttached" ></a><p>
243<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
244  <tr>
245    <td class="mdRow">
246      <table cellpadding="0" cellspacing="0" border="0">
247        <tr>
248          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyAttached </td>
249          <td class="md" valign="top">(&nbsp;</td>
250          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Node.html">Node</a> *&nbsp;</td>
251          <td class="mdname" nowrap> <em>parent</em>, </td>
252        </tr>
253        <tr>
254          <td class="md" nowrap align="right"></td>
255          <td></td>
256          <td class="md" nowrap>bool&nbsp;</td>
257          <td class="mdname" nowrap> <em>isTagPoint</em> = false</td>
258        </tr>
259        <tr>
260          <td></td>
261          <td class="md">)&nbsp;</td>
262          <td class="md" colspan="2"><code> [pure virtual]</code></td>
263        </tr>
264
265      </table>
266    </td>
267  </tr>
268</table>
269<table cellspacing=5 cellpadding=0 border=0>
270  <tr>
271    <td>
272      &nbsp;
273    </td>
274    <td>
275
276<p>
277Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema28">ParticleSystem::_notifyAttached</a>.
278<p>
279
280<p>
281Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera15">Ogre::BillboardParticleRenderer</a>.    </td>
282  </tr>
283</table>
284<a class="anchor" name="Ogre_1_1ParticleSystemRenderera5" doxytag="Ogre::ParticleSystemRenderer::_notifyCurrentCamera" ></a><p>
285<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
286  <tr>
287    <td class="mdRow">
288      <table cellpadding="0" cellspacing="0" border="0">
289        <tr>
290          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyCurrentCamera </td>
291          <td class="md" valign="top">(&nbsp;</td>
292          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Camera.html">Camera</a> *&nbsp;</td>
293          <td class="mdname1" valign="top" nowrap> <em>cam</em>          </td>
294          <td class="md" valign="top">&nbsp;)&nbsp;</td>
295          <td class="md" nowrap><code> [pure virtual]</code></td>
296        </tr>
297
298      </table>
299    </td>
300  </tr>
301</table>
302<table cellspacing=5 cellpadding=0 border=0>
303  <tr>
304    <td>
305      &nbsp;
306    </td>
307    <td>
308
309<p>
310Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema27">ParticleSystem::_notifyCurrentCamera</a>.
311<p>
312
313<p>
314Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera11">Ogre::BillboardParticleRenderer</a>.    </td>
315  </tr>
316</table>
317<a class="anchor" name="Ogre_1_1ParticleSystemRenderera10" doxytag="Ogre::ParticleSystemRenderer::_notifyDefaultDimensions" ></a><p>
318<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
319  <tr>
320    <td class="mdRow">
321      <table cellpadding="0" cellspacing="0" border="0">
322        <tr>
323          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyDefaultDimensions </td>
324          <td class="md" valign="top">(&nbsp;</td>
325          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
326          <td class="mdname" nowrap> <em>width</em>, </td>
327        </tr>
328        <tr>
329          <td class="md" nowrap align="right"></td>
330          <td></td>
331          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
332          <td class="mdname" nowrap> <em>height</em></td>
333        </tr>
334        <tr>
335          <td></td>
336          <td class="md">)&nbsp;</td>
337          <td class="md" colspan="2"><code> [pure virtual]</code></td>
338        </tr>
339
340      </table>
341    </td>
342  </tr>
343</table>
344<table cellspacing=5 cellpadding=0 border=0>
345  <tr>
346    <td>
347      &nbsp;
348    </td>
349    <td>
350
351<p>
352Tells the renderer that the particle default size has changed.
353<p>
354
355<p>
356Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera16">Ogre::BillboardParticleRenderer</a>.    </td>
357  </tr>
358</table>
359<a class="anchor" name="Ogre_1_1ParticleSystemRenderera9" doxytag="Ogre::ParticleSystemRenderer::_notifyParticleQuota" ></a><p>
360<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
361  <tr>
362    <td class="mdRow">
363      <table cellpadding="0" cellspacing="0" border="0">
364        <tr>
365          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyParticleQuota </td>
366          <td class="md" valign="top">(&nbsp;</td>
367          <td class="md" nowrap valign="top">size_t&nbsp;</td>
368          <td class="mdname1" valign="top" nowrap> <em>quota</em>          </td>
369          <td class="md" valign="top">&nbsp;)&nbsp;</td>
370          <td class="md" nowrap><code> [pure virtual]</code></td>
371        </tr>
372
373      </table>
374    </td>
375  </tr>
376</table>
377<table cellspacing=5 cellpadding=0 border=0>
378  <tr>
379    <td>
380      &nbsp;
381    </td>
382    <td>
383
384<p>
385Tells the renderer that the particle quota has changed.
386<p>
387
388<p>
389Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera14">Ogre::BillboardParticleRenderer</a>.    </td>
390  </tr>
391</table>
392<a class="anchor" name="Ogre_1_1ParticleSystemRenderera8" doxytag="Ogre::ParticleSystemRenderer::_notifyParticleResized" ></a><p>
393<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
394  <tr>
395    <td class="mdRow">
396      <table cellpadding="0" cellspacing="0" border="0">
397        <tr>
398          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyParticleResized </td>
399          <td class="md" valign="top">(&nbsp;</td>
400          <td class="md" nowrap valign="top">void&nbsp;</td>
401          <td class="mdname1" valign="top" nowrap>          </td>
402          <td class="md" valign="top">&nbsp;)&nbsp;</td>
403          <td class="md" nowrap><code> [virtual]</code></td>
404        </tr>
405
406      </table>
407    </td>
408  </tr>
409</table>
410<table cellspacing=5 cellpadding=0 border=0>
411  <tr>
412    <td>
413      &nbsp;
414    </td>
415    <td>
416
417<p>
418Optional callback notified when particles are resized individually.
419<p>
420
421<p>
422Reimplemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera13">Ogre::BillboardParticleRenderer</a>.
423<p>
424Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00066">66</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
425  </tr>
426</table>
427<a class="anchor" name="Ogre_1_1ParticleSystemRenderera7" doxytag="Ogre::ParticleSystemRenderer::_notifyParticleRotated" ></a><p>
428<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
429  <tr>
430    <td class="mdRow">
431      <table cellpadding="0" cellspacing="0" border="0">
432        <tr>
433          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyParticleRotated </td>
434          <td class="md" valign="top">(&nbsp;</td>
435          <td class="md" nowrap valign="top">void&nbsp;</td>
436          <td class="mdname1" valign="top" nowrap>          </td>
437          <td class="md" valign="top">&nbsp;)&nbsp;</td>
438          <td class="md" nowrap><code> [virtual]</code></td>
439        </tr>
440
441      </table>
442    </td>
443  </tr>
444</table>
445<table cellspacing=5 cellpadding=0 border=0>
446  <tr>
447    <td>
448      &nbsp;
449    </td>
450    <td>
451
452<p>
453Optional callback notified when particles are rotated.
454<p>
455
456<p>
457Reimplemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera12">Ogre::BillboardParticleRenderer</a>.
458<p>
459Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00064">64</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
460  </tr>
461</table>
462<a class="anchor" name="Ogre_1_1ParticleSystemRenderera4" doxytag="Ogre::ParticleSystemRenderer::_setMaterial" ></a><p>
463<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
464  <tr>
465    <td class="mdRow">
466      <table cellpadding="0" cellspacing="0" border="0">
467        <tr>
468          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_setMaterial </td>
469          <td class="md" valign="top">(&nbsp;</td>
470          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;&nbsp;</td>
471          <td class="mdname1" valign="top" nowrap> <em>mat</em>          </td>
472          <td class="md" valign="top">&nbsp;)&nbsp;</td>
473          <td class="md" nowrap><code> [pure virtual]</code></td>
474        </tr>
475
476      </table>
477    </td>
478  </tr>
479</table>
480<table cellspacing=5 cellpadding=0 border=0>
481  <tr>
482    <td>
483      &nbsp;
484    </td>
485    <td>
486
487<p>
488Sets the material this renderer must use; called by <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.
489<p>
490
491<p>
492Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera10">Ogre::BillboardParticleRenderer</a>.    </td>
493  </tr>
494</table>
495<a class="anchor" name="Ogre_1_1ParticleSystemRenderera3" doxytag="Ogre::ParticleSystemRenderer::_updateRenderQueue" ></a><p>
496<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
497  <tr>
498    <td class="mdRow">
499      <table cellpadding="0" cellspacing="0" border="0">
500        <tr>
501          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_updateRenderQueue </td>
502          <td class="md" valign="top">(&nbsp;</td>
503          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *&nbsp;</td>
504          <td class="mdname" nowrap> <em>queue</em>, </td>
505        </tr>
506        <tr>
507          <td class="md" nowrap align="right"></td>
508          <td></td>
509          <td class="md" nowrap>std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt; &amp;&nbsp;</td>
510          <td class="mdname" nowrap> <em>currentParticles</em>, </td>
511        </tr>
512        <tr>
513          <td class="md" nowrap align="right"></td>
514          <td></td>
515          <td class="md" nowrap>bool&nbsp;</td>
516          <td class="mdname" nowrap> <em>cullIndividually</em></td>
517        </tr>
518        <tr>
519          <td></td>
520          <td class="md">)&nbsp;</td>
521          <td class="md" colspan="2"><code> [pure virtual]</code></td>
522        </tr>
523
524      </table>
525    </td>
526  </tr>
527</table>
528<table cellspacing=5 cellpadding=0 border=0>
529  <tr>
530    <td>
531      &nbsp;
532    </td>
533    <td>
534
535<p>
536Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema31">ParticleSystem::_updateRenderQueue</a>.
537<p>
538<dl compact><dt><b>Remarks:</b></dt><dd>The subclass must update the render queue using whichever <a class="el" href="classOgre_1_1Renderable.html">Renderable</a> instance(s) it wishes. </dd></dl>
539
540<p>
541Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera9">Ogre::BillboardParticleRenderer</a>.    </td>
542  </tr>
543</table>
544<a class="anchor" name="Ogre_1_1Texturee0" doxytag="Ogre::ParticleSystemRenderer::cleanupDictionary" ></a><p>
545<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
546  <tr>
547    <td class="mdRow">
548      <table cellpadding="0" cellspacing="0" border="0">
549        <tr>
550          <td class="md" nowrap valign="top"> void Ogre::StringInterface::cleanupDictionary </td>
551          <td class="md" valign="top">(&nbsp;</td>
552          <td class="mdname1" valign="top" nowrap>          </td>
553          <td class="md" valign="top">&nbsp;)&nbsp;</td>
554          <td class="md" nowrap><code> [static, inherited]</code></td>
555        </tr>
556
557      </table>
558    </td>
559  </tr>
560</table>
561<table cellspacing=5 cellpadding=0 border=0>
562  <tr>
563    <td>
564      &nbsp;
565    </td>
566    <td>
567
568<p>
569Cleans up the static 'msDictionary' required to reset <a class="el" href="namespaceOgre.html">Ogre</a>, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the <a class="el" href="classOgre_1_1ResourceManager.html">ResourceManager</a> implementers (e.g.
570<p>
571<a class="el" href="classOgre_1_1MaterialManager.html">MaterialManager</a>) initializes.     </td>
572  </tr>
573</table>
574<a class="anchor" name="Ogre_1_1Texturea50" doxytag="Ogre::ParticleSystemRenderer::copyParametersTo" ></a><p>
575<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
576  <tr>
577    <td class="mdRow">
578      <table cellpadding="0" cellspacing="0" border="0">
579        <tr>
580          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
581          <td class="md" valign="top">(&nbsp;</td>
582          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *&nbsp;</td>
583          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
584          <td class="md" valign="top">&nbsp;)&nbsp;</td>
585          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
586        </tr>
587
588      </table>
589    </td>
590  </tr>
591</table>
592<table cellspacing=5 cellpadding=0 border=0>
593  <tr>
594    <td>
595      &nbsp;
596    </td>
597    <td>
598
599<p>
600Method for copying this object's parameters to another object.
601<p>
602<dl compact><dt><b>Remarks:</b></dt><dd>This method takes the values of all the object's parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. </dd></dl>
603<dl compact><dt><b></b></dt><dd>Any unrecognised parameters will be ignored as with setParameter method. </dd></dl>
604<dl compact><dt><b>Parameters:</b></dt><dd>
605  <table border="0" cellspacing="2" cellpadding="0">
606    <tr><td valign=top><em>dest</em>&nbsp;</td><td>Pointer to object to have it's parameters set the same as this object. </td></tr>
607  </table>
608</dl>
609
610<p>
611Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00296">296</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
612<p>
613References <a class="el" href="OgreStringInterface_8h-source.html#l00084">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">Ogre::StringInterface::setParameter()</a>.    </td>
614  </tr>
615</table>
616<a class="anchor" name="Ogre_1_1Textureb6" doxytag="Ogre::ParticleSystemRenderer::createParamDictionary" ></a><p>
617<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
618  <tr>
619    <td class="mdRow">
620      <table cellpadding="0" cellspacing="0" border="0">
621        <tr>
622          <td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
623          <td class="md" valign="top">(&nbsp;</td>
624          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
625          <td class="mdname1" valign="top" nowrap> <em>className</em>          </td>
626          <td class="md" valign="top">&nbsp;)&nbsp;</td>
627          <td class="md" nowrap><code> [protected, inherited]</code></td>
628        </tr>
629
630      </table>
631    </td>
632  </tr>
633</table>
634<table cellspacing=5 cellpadding=0 border=0>
635  <tr>
636    <td>
637      &nbsp;
638    </td>
639    <td>
640
641<p>
642Internal method for creating a parameter dictionary for the class, if it does not already exist.
643<p>
644<dl compact><dt><b>Remarks:</b></dt><dd>This method will check to see if a parameter dictionary exist for this class yet, and if not will create one. NB you must supply the name of the class (RTTI is not used or performance). </dd></dl>
645<dl compact><dt><b>Parameters:</b></dt><dd>
646  <table border="0" cellspacing="2" cellpadding="0">
647    <tr><td valign=top><em>className</em>&nbsp;</td><td>the name of the class using the dictionary </td></tr>
648  </table>
649</dl>
650<dl compact><dt><b>Returns:</b></dt><dd>true if a new dictionary was created, false if it was already there </dd></dl>
651
652<p>
653Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00172">172</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
654<p>
655References <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
656  </tr>
657</table>
658<a class="anchor" name="Ogre_1_1Texturea45" doxytag="Ogre::ParticleSystemRenderer::getParamDictionary" ></a><p>
659<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
660  <tr>
661    <td class="mdRow">
662      <table cellpadding="0" cellspacing="0" border="0">
663        <tr>
664          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
665          <td class="md" valign="top">(&nbsp;</td>
666          <td class="md" nowrap valign="top">void&nbsp;</td>
667          <td class="mdname1" valign="top" nowrap>          </td>
668          <td class="md" valign="top">&nbsp;)&nbsp;</td>
669          <td class="md" nowrap> const<code> [inherited]</code></td>
670        </tr>
671
672      </table>
673    </td>
674  </tr>
675</table>
676<table cellspacing=5 cellpadding=0 border=0>
677  <tr>
678    <td>
679      &nbsp;
680    </td>
681    <td>
682
683<p>
684
685<p>
686Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00209">209</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
687  </tr>
688</table>
689<a class="anchor" name="Ogre_1_1Texturea44" doxytag="Ogre::ParticleSystemRenderer::getParamDictionary" ></a><p>
690<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
691  <tr>
692    <td class="mdRow">
693      <table cellpadding="0" cellspacing="0" border="0">
694        <tr>
695          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
696          <td class="md" valign="top">(&nbsp;</td>
697          <td class="md" nowrap valign="top">void&nbsp;</td>
698          <td class="mdname1" valign="top" nowrap>          </td>
699          <td class="md" valign="top">&nbsp;)&nbsp;</td>
700          <td class="md" nowrap><code> [inherited]</code></td>
701        </tr>
702
703      </table>
704    </td>
705  </tr>
706</table>
707<table cellspacing=5 cellpadding=0 border=0>
708  <tr>
709    <td>
710      &nbsp;
711    </td>
712    <td>
713
714<p>
715Retrieves the parameter dictionary for this class.
716<p>
717<dl compact><dt><b>Remarks:</b></dt><dd>Only valid to call this after createParamDictionary. </dd></dl>
718<dl compact><dt><b>Returns:</b></dt><dd>Pointer to <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a> shared by all instances of this class which you can add parameters to, retrieve parameters etc. </dd></dl>
719
720<p>
721Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00196">196</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
722  </tr>
723</table>
724<a class="anchor" name="Ogre_1_1Texturea49" doxytag="Ogre::ParticleSystemRenderer::getParameter" ></a><p>
725<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
726  <tr>
727    <td class="mdRow">
728      <table cellpadding="0" cellspacing="0" border="0">
729        <tr>
730          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a426">String</a> Ogre::StringInterface::getParameter </td>
731          <td class="md" valign="top">(&nbsp;</td>
732          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
733          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
734          <td class="md" valign="top">&nbsp;)&nbsp;</td>
735          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
736        </tr>
737
738      </table>
739    </td>
740  </tr>
741</table>
742<table cellspacing=5 cellpadding=0 border=0>
743  <tr>
744    <td>
745      &nbsp;
746    </td>
747    <td>
748
749<p>
750Generic parameter retrieval method.
751<p>
752<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with the name of a parameter to retrieve a string-format value of the parameter in question. If in doubt, check the parameter definition in the list returned from getParameters for the type of this parameter. If you like you can use <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> to convert this string back into a native type. </dd></dl>
753<dl compact><dt><b>Parameters:</b></dt><dd>
754  <table border="0" cellspacing="2" cellpadding="0">
755    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to get </td></tr>
756  </table>
757</dl>
758<dl compact><dt><b>Returns:</b></dt><dd>String value of parameter, blank if not found </dd></dl>
759
760<p>
761Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00265">265</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.
762<p>
763References <a class="el" href="classOgre_1_1ParamCommand.html#Ogre_1_1ParamCommanda0">Ogre::ParamCommand::doGet()</a>, <a class="el" href="OgreStringInterface_8h-source.html#l00090">Ogre::ParamDictionary::getParamCommand()</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00154">Ogre::String</a>.    </td>
764  </tr>
765</table>
766<a class="anchor" name="Ogre_1_1Texturea46" doxytag="Ogre::ParticleSystemRenderer::getParameters" ></a><p>
767<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
768  <tr>
769    <td class="mdRow">
770      <table cellpadding="0" cellspacing="0" border="0">
771        <tr>
772          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a518">ParameterList</a>&amp; Ogre::StringInterface::getParameters </td>
773          <td class="md" valign="top">(&nbsp;</td>
774          <td class="md" nowrap valign="top">void&nbsp;</td>
775          <td class="mdname1" valign="top" nowrap>          </td>
776          <td class="md" valign="top">&nbsp;)&nbsp;</td>
777          <td class="md" nowrap> const<code> [inherited]</code></td>
778        </tr>
779
780      </table>
781    </td>
782  </tr>
783</table>
784<table cellspacing=5 cellpadding=0 border=0>
785  <tr>
786    <td>
787      &nbsp;
788    </td>
789    <td>
790
791<p>
792Retrieves a list of parameters valid for this object.
793<p>
794<dl compact><dt><b>Returns:</b></dt><dd>A reference to a static list of <a class="el" href="classOgre_1_1ParameterDef.html">ParameterDef</a> objects. </dd></dl>
795    </td>
796  </tr>
797</table>
798<a class="anchor" name="Ogre_1_1ParticleSystemRenderera2" doxytag="Ogre::ParticleSystemRenderer::getType" ></a><p>
799<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
800  <tr>
801    <td class="mdRow">
802      <table cellpadding="0" cellspacing="0" border="0">
803        <tr>
804          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a426">String</a>&amp; Ogre::ParticleSystemRenderer::getType </td>
805          <td class="md" valign="top">(&nbsp;</td>
806          <td class="md" nowrap valign="top">void&nbsp;</td>
807          <td class="mdname1" valign="top" nowrap>          </td>
808          <td class="md" valign="top">&nbsp;)&nbsp;</td>
809          <td class="md" nowrap> const<code> [pure virtual]</code></td>
810        </tr>
811
812      </table>
813    </td>
814  </tr>
815</table>
816<table cellspacing=5 cellpadding=0 border=0>
817  <tr>
818    <td>
819      &nbsp;
820    </td>
821    <td>
822
823<p>
824Gets the type of this renderer - must be implemented by subclasses.
825<p>
826
827<p>
828Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera8">Ogre::BillboardParticleRenderer</a>.    </td>
829  </tr>
830</table>
831<a class="anchor" name="Ogre_1_1Texturea47" doxytag="Ogre::ParticleSystemRenderer::setParameter" ></a><p>
832<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
833  <tr>
834    <td class="mdRow">
835      <table cellpadding="0" cellspacing="0" border="0">
836        <tr>
837          <td class="md" nowrap valign="top"> virtual bool Ogre::StringInterface::setParameter </td>
838          <td class="md" valign="top">(&nbsp;</td>
839          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
840          <td class="mdname" nowrap> <em>name</em>, </td>
841        </tr>
842        <tr>
843          <td class="md" nowrap align="right"></td>
844          <td></td>
845          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
846          <td class="mdname" nowrap> <em>value</em></td>
847        </tr>
848        <tr>
849          <td></td>
850          <td class="md">)&nbsp;</td>
851          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
852        </tr>
853
854      </table>
855    </td>
856  </tr>
857</table>
858<table cellspacing=5 cellpadding=0 border=0>
859  <tr>
860    <td>
861      &nbsp;
862    </td>
863    <td>
864
865<p>
866Generic parameter setting method.
867<p>
868<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
869<dl compact><dt><b>Parameters:</b></dt><dd>
870  <table border="0" cellspacing="2" cellpadding="0">
871    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to set </td></tr>
872    <tr><td valign=top><em>value</em>&nbsp;</td><td>String value. Must be in the right format for the type specified in the parameter definition. See the <a class="el" href="classOgre_1_1StringConverter.html">StringConverter</a> class for more information. </td></tr>
873  </table>
874</dl>
875<dl compact><dt><b>Returns:</b></dt><dd>true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dd></dl>
876
877<p>
878Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">Ogre::StringInterface::copyParametersTo()</a>.    </td>
879  </tr>
880</table>
881<a class="anchor" name="Ogre_1_1Texturea48" doxytag="Ogre::ParticleSystemRenderer::setParameterList" ></a><p>
882<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
883  <tr>
884    <td class="mdRow">
885      <table cellpadding="0" cellspacing="0" border="0">
886        <tr>
887          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::setParameterList </td>
888          <td class="md" valign="top">(&nbsp;</td>
889          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a62">NameValuePairList</a> &amp;&nbsp;</td>
890          <td class="mdname1" valign="top" nowrap> <em>paramList</em>          </td>
891          <td class="md" valign="top">&nbsp;)&nbsp;</td>
892          <td class="md" nowrap><code> [virtual, inherited]</code></td>
893        </tr>
894
895      </table>
896    </td>
897  </tr>
898</table>
899<table cellspacing=5 cellpadding=0 border=0>
900  <tr>
901    <td>
902      &nbsp;
903    </td>
904    <td>
905
906<p>
907Generic multiple parameter setting method.
908<p>
909<dl compact><dt><b>Remarks:</b></dt><dd>Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea46">StringInterface::getParameters</a>. </dd></dl>
910<dl compact><dt><b>Parameters:</b></dt><dd>
911  <table border="0" cellspacing="2" cellpadding="0">
912    <tr><td valign=top><em>paramList</em>&nbsp;</td><td>Name/value pair list </td></tr>
913  </table>
914</dl>
915    </td>
916  </tr>
917</table>
918<a class="anchor" name="Ogre_1_1ParticleSystemRenderera13" doxytag="Ogre::ParticleSystemRenderer::setRenderQueueGroup" ></a><p>
919<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
920  <tr>
921    <td class="mdRow">
922      <table cellpadding="0" cellspacing="0" border="0">
923        <tr>
924          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::setRenderQueueGroup </td>
925          <td class="md" valign="top">(&nbsp;</td>
926          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a669">RenderQueueGroupID</a>&nbsp;</td>
927          <td class="mdname1" valign="top" nowrap> <em>queueID</em>          </td>
928          <td class="md" valign="top">&nbsp;)&nbsp;</td>
929          <td class="md" nowrap><code> [pure virtual]</code></td>
930        </tr>
931
932      </table>
933    </td>
934  </tr>
935</table>
936<table cellspacing=5 cellpadding=0 border=0>
937  <tr>
938    <td>
939      &nbsp;
940    </td>
941    <td>
942
943<p>
944Sets which render queue group this renderer should target with it's output.
945<p>
946
947<p>
948Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera17">Ogre::BillboardParticleRenderer</a>.    </td>
949  </tr>
950</table>
951<hr><h2>Member Data Documentation</h2>
952<a class="anchor" name="Ogre_1_1Texturep26" doxytag="Ogre::ParticleSystemRenderer::mParamDictName" ></a><p>
953<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
954  <tr>
955    <td class="mdRow">
956      <table cellpadding="0" cellspacing="0" border="0">
957        <tr>
958          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a426">String</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">Ogre::StringInterface::mParamDictName</a><code> [protected, inherited]</code>
959      </table>
960    </td>
961  </tr>
962</table>
963<table cellspacing=5 cellpadding=0 border=0>
964  <tr>
965    <td>
966      &nbsp;
967    </td>
968    <td>
969
970<p>
971Class name for this instance to be used as a lookup (must be initialised by subclasses).
972<p>
973
974<p>
975Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00160">160</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
976  </tr>
977</table>
978<a class="anchor" name="Ogre_1_1Texturet0" doxytag="Ogre::ParticleSystemRenderer::msDictionary" ></a><p>
979<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
980  <tr>
981    <td class="mdRow">
982      <table cellpadding="0" cellspacing="0" border="0">
983        <tr>
984          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a520">ParamDictionaryMap</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">Ogre::StringInterface::msDictionary</a><code> [static, protected, inherited]</code>
985      </table>
986    </td>
987  </tr>
988</table>
989<table cellspacing=5 cellpadding=0 border=0>
990  <tr>
991    <td>
992      &nbsp;
993    </td>
994    <td>
995
996<p>
997Dictionary of parameters.
998<p>
999
1000<p>
1001Definition at line <a class="el" href="OgreStringInterface_8h-source.html#l00157">157</a> of file <a class="el" href="OgreStringInterface_8h-source.html">OgreStringInterface.h</a>.    </td>
1002  </tr>
1003</table>
1004<hr>The documentation for this class was generated from the following file:<ul>
1005<li><a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a></ul>
1006<hr>
1007<p>
1008Copyright &copy; 2000-2005 by The OGRE Team<br />
1009<!--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/>
1010This 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/>
1011                <!--/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#">
1012                <Work rdf:about="">
1013                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1014        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1015                </Work>
1016                <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> -->
1017
1018Last modified Sun Feb 12 13:01:55 2006
1019</p>
1020</body>
1021</html>
Note: See TracBrowser for help on using the repository browser.