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

Revision 692, 55.5 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
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#a471">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#a465">Real</a> width, <a class="el" href="namespaceOgre.html#a465">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#a457">uint8</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>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera14">setKeepParticlesInLocalSpace</a> (bool keepLocal)=0</td></tr>
67
68<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Setting carried over from <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.  <a href="#Ogre_1_1ParticleSystemRenderera14"></a><br><br></td></tr>
69<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a652">SortMode</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1ParticleSystemRenderer.html#Ogre_1_1ParticleSystemRenderera15">_getSortMode</a> (void) const=0</td></tr>
70
71<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the desired particles sort mode of this renderer.  <a href="#Ogre_1_1ParticleSystemRenderera15"></a><br><br></td></tr>
72<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_1Texturea45">getParamDictionary</a> (void)</td></tr>
73
74<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves the parameter dictionary for this class.  <a href="#Ogre_1_1Texturea45"></a><br><br></td></tr>
75<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_1Texturea46">getParamDictionary</a> (void) const </td></tr>
76
77<tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a563">ParameterList</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea47">getParameters</a> (void) const </td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a list of parameters valid for this object.  <a href="#Ogre_1_1Texturea47"></a><br><br></td></tr>
80<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_1Texturea48">setParameter</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name, const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;value)</td></tr>
81
82<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter setting method.  <a href="#Ogre_1_1Texturea48"></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_1Texturea49">setParameterList</a> (const <a class="el" href="namespaceOgre.html#a76">NameValuePairList</a> &amp;paramList)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic multiple parameter setting method.  <a href="#Ogre_1_1Texturea49"></a><br><br></td></tr>
86<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea50">getParameter</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;name) const </td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Generic parameter retrieval method.  <a href="#Ogre_1_1Texturea50"></a><br><br></td></tr>
89<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_1Texturea51">copyParametersTo</a> (<a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *dest) const </td></tr>
90
91<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Method for copying this object's parameters to another object.  <a href="#Ogre_1_1Texturea51"></a><br><br></td></tr>
92<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
93<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>
94
95<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>
96<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr>
97<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#a471">String</a> &amp;className)</td></tr>
98
99<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>
100<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
101<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">mParamDictName</a></td></tr>
102
103<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>
104<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
105<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a565">ParamDictionaryMap</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">msDictionary</a></td></tr>
106
107<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Dictionary of parameters.  <a href="#Ogre_1_1Texturet0"></a><br><br></td></tr>
108</table>
109<hr><a name="_details"></a><h2>Detailed Description</h2>
110Abstract 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.
111<p>
112
113<p>
114Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00039">39</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
115<a class="anchor" name="Ogre_1_1ParticleSystemRenderera0" doxytag="Ogre::ParticleSystemRenderer::ParticleSystemRenderer" ></a><p>
116<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
117  <tr>
118    <td class="mdRow">
119      <table cellpadding="0" cellspacing="0" border="0">
120        <tr>
121          <td class="md" nowrap valign="top"> Ogre::ParticleSystemRenderer::ParticleSystemRenderer </td>
122          <td class="md" valign="top">(&nbsp;</td>
123          <td class="mdname1" valign="top" nowrap>          </td>
124          <td class="md" valign="top">&nbsp;)&nbsp;</td>
125          <td class="md" nowrap></td>
126        </tr>
127
128      </table>
129    </td>
130  </tr>
131</table>
132<table cellspacing=5 cellpadding=0 border=0>
133  <tr>
134    <td>
135      &nbsp;
136    </td>
137    <td>
138
139<p>
140Constructor.
141<p>
142
143<p>
144Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00043">43</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
145  </tr>
146</table>
147<a class="anchor" name="Ogre_1_1ParticleSystemRenderera1" doxytag="Ogre::ParticleSystemRenderer::~ParticleSystemRenderer" ></a><p>
148<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
149  <tr>
150    <td class="mdRow">
151      <table cellpadding="0" cellspacing="0" border="0">
152        <tr>
153          <td class="md" nowrap valign="top"> virtual Ogre::ParticleSystemRenderer::~<a class="el" href="classOgre_1_1ParticleSystemRenderer.html">ParticleSystemRenderer</a> </td>
154          <td class="md" valign="top">(&nbsp;</td>
155          <td class="mdname1" valign="top" nowrap>          </td>
156          <td class="md" valign="top">&nbsp;)&nbsp;</td>
157          <td class="md" nowrap><code> [virtual]</code></td>
158        </tr>
159
160      </table>
161    </td>
162  </tr>
163</table>
164<table cellspacing=5 cellpadding=0 border=0>
165  <tr>
166    <td>
167      &nbsp;
168    </td>
169    <td>
170
171<p>
172Destructor.
173<p>
174
175<p>
176Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00045">45</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
177  </tr>
178</table>
179<hr><h2>Member Function Documentation</h2>
180<a class="anchor" name="Ogre_1_1ParticleSystemRenderera11" doxytag="Ogre::ParticleSystemRenderer::_createVisualData" ></a><p>
181<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
182  <tr>
183    <td class="mdRow">
184      <table cellpadding="0" cellspacing="0" border="0">
185        <tr>
186          <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a>* Ogre::ParticleSystemRenderer::_createVisualData </td>
187          <td class="md" valign="top">(&nbsp;</td>
188          <td class="md" nowrap valign="top">void&nbsp;</td>
189          <td class="mdname1" valign="top" nowrap>          </td>
190          <td class="md" valign="top">&nbsp;)&nbsp;</td>
191          <td class="md" nowrap><code> [virtual]</code></td>
192        </tr>
193
194      </table>
195    </td>
196  </tr>
197</table>
198<table cellspacing=5 cellpadding=0 border=0>
199  <tr>
200    <td>
201      &nbsp;
202    </td>
203    <td>
204
205<p>
206Create a new <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> instance for attachment to a particle.
207<p>
208<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>
209
210<p>
211Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00079">79</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
212  </tr>
213</table>
214<a class="anchor" name="Ogre_1_1ParticleSystemRenderera12" doxytag="Ogre::ParticleSystemRenderer::_destroyVisualData" ></a><p>
215<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
216  <tr>
217    <td class="mdRow">
218      <table cellpadding="0" cellspacing="0" border="0">
219        <tr>
220          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_destroyVisualData </td>
221          <td class="md" valign="top">(&nbsp;</td>
222          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> *&nbsp;</td>
223          <td class="mdname1" valign="top" nowrap> <em>vis</em>          </td>
224          <td class="md" valign="top">&nbsp;)&nbsp;</td>
225          <td class="md" nowrap><code> [virtual]</code></td>
226        </tr>
227
228      </table>
229    </td>
230  </tr>
231</table>
232<table cellspacing=5 cellpadding=0 border=0>
233  <tr>
234    <td>
235      &nbsp;
236    </td>
237    <td>
238
239<p>
240Destroy a <a class="el" href="classOgre_1_1ParticleVisualData.html">ParticleVisualData</a> instance.
241<p>
242<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>
243
244<p>
245Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00087">87</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
246  </tr>
247</table>
248<a class="anchor" name="Ogre_1_1ParticleSystemRenderera15" doxytag="Ogre::ParticleSystemRenderer::_getSortMode" ></a><p>
249<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
250  <tr>
251    <td class="mdRow">
252      <table cellpadding="0" cellspacing="0" border="0">
253        <tr>
254          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a652">SortMode</a> Ogre::ParticleSystemRenderer::_getSortMode </td>
255          <td class="md" valign="top">(&nbsp;</td>
256          <td class="md" nowrap valign="top">void&nbsp;</td>
257          <td class="mdname1" valign="top" nowrap>          </td>
258          <td class="md" valign="top">&nbsp;)&nbsp;</td>
259          <td class="md" nowrap> const<code> [pure virtual]</code></td>
260        </tr>
261
262      </table>
263    </td>
264  </tr>
265</table>
266<table cellspacing=5 cellpadding=0 border=0>
267  <tr>
268    <td>
269      &nbsp;
270    </td>
271    <td>
272
273<p>
274Gets the desired particles sort mode of this renderer.
275<p>
276
277<p>
278Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera27">Ogre::BillboardParticleRenderer</a>.    </td>
279  </tr>
280</table>
281<a class="anchor" name="Ogre_1_1ParticleSystemRenderera6" doxytag="Ogre::ParticleSystemRenderer::_notifyAttached" ></a><p>
282<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
283  <tr>
284    <td class="mdRow">
285      <table cellpadding="0" cellspacing="0" border="0">
286        <tr>
287          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyAttached </td>
288          <td class="md" valign="top">(&nbsp;</td>
289          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Node.html">Node</a> *&nbsp;</td>
290          <td class="mdname" nowrap> <em>parent</em>, </td>
291        </tr>
292        <tr>
293          <td class="md" nowrap align="right"></td>
294          <td></td>
295          <td class="md" nowrap>bool&nbsp;</td>
296          <td class="mdname" nowrap> <em>isTagPoint</em> = false</td>
297        </tr>
298        <tr>
299          <td></td>
300          <td class="md">)&nbsp;</td>
301          <td class="md" colspan="2"><code> [pure virtual]</code></td>
302        </tr>
303
304      </table>
305    </td>
306  </tr>
307</table>
308<table cellspacing=5 cellpadding=0 border=0>
309  <tr>
310    <td>
311      &nbsp;
312    </td>
313    <td>
314
315<p>
316Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema28">ParticleSystem::_notifyAttached</a>.
317<p>
318
319<p>
320Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera23">Ogre::BillboardParticleRenderer</a>.    </td>
321  </tr>
322</table>
323<a class="anchor" name="Ogre_1_1ParticleSystemRenderera5" doxytag="Ogre::ParticleSystemRenderer::_notifyCurrentCamera" ></a><p>
324<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
325  <tr>
326    <td class="mdRow">
327      <table cellpadding="0" cellspacing="0" border="0">
328        <tr>
329          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyCurrentCamera </td>
330          <td class="md" valign="top">(&nbsp;</td>
331          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1Camera.html">Camera</a> *&nbsp;</td>
332          <td class="mdname1" valign="top" nowrap> <em>cam</em>          </td>
333          <td class="md" valign="top">&nbsp;)&nbsp;</td>
334          <td class="md" nowrap><code> [pure virtual]</code></td>
335        </tr>
336
337      </table>
338    </td>
339  </tr>
340</table>
341<table cellspacing=5 cellpadding=0 border=0>
342  <tr>
343    <td>
344      &nbsp;
345    </td>
346    <td>
347
348<p>
349Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema27">ParticleSystem::_notifyCurrentCamera</a>.
350<p>
351
352<p>
353Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera19">Ogre::BillboardParticleRenderer</a>.    </td>
354  </tr>
355</table>
356<a class="anchor" name="Ogre_1_1ParticleSystemRenderera10" doxytag="Ogre::ParticleSystemRenderer::_notifyDefaultDimensions" ></a><p>
357<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
358  <tr>
359    <td class="mdRow">
360      <table cellpadding="0" cellspacing="0" border="0">
361        <tr>
362          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyDefaultDimensions </td>
363          <td class="md" valign="top">(&nbsp;</td>
364          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
365          <td class="mdname" nowrap> <em>width</em>, </td>
366        </tr>
367        <tr>
368          <td class="md" nowrap align="right"></td>
369          <td></td>
370          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
371          <td class="mdname" nowrap> <em>height</em></td>
372        </tr>
373        <tr>
374          <td></td>
375          <td class="md">)&nbsp;</td>
376          <td class="md" colspan="2"><code> [pure virtual]</code></td>
377        </tr>
378
379      </table>
380    </td>
381  </tr>
382</table>
383<table cellspacing=5 cellpadding=0 border=0>
384  <tr>
385    <td>
386      &nbsp;
387    </td>
388    <td>
389
390<p>
391Tells the renderer that the particle default size has changed.
392<p>
393
394<p>
395Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera24">Ogre::BillboardParticleRenderer</a>.    </td>
396  </tr>
397</table>
398<a class="anchor" name="Ogre_1_1ParticleSystemRenderera9" doxytag="Ogre::ParticleSystemRenderer::_notifyParticleQuota" ></a><p>
399<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
400  <tr>
401    <td class="mdRow">
402      <table cellpadding="0" cellspacing="0" border="0">
403        <tr>
404          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyParticleQuota </td>
405          <td class="md" valign="top">(&nbsp;</td>
406          <td class="md" nowrap valign="top">size_t&nbsp;</td>
407          <td class="mdname1" valign="top" nowrap> <em>quota</em>          </td>
408          <td class="md" valign="top">&nbsp;)&nbsp;</td>
409          <td class="md" nowrap><code> [pure virtual]</code></td>
410        </tr>
411
412      </table>
413    </td>
414  </tr>
415</table>
416<table cellspacing=5 cellpadding=0 border=0>
417  <tr>
418    <td>
419      &nbsp;
420    </td>
421    <td>
422
423<p>
424Tells the renderer that the particle quota has changed.
425<p>
426
427<p>
428Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera22">Ogre::BillboardParticleRenderer</a>.    </td>
429  </tr>
430</table>
431<a class="anchor" name="Ogre_1_1ParticleSystemRenderera8" doxytag="Ogre::ParticleSystemRenderer::_notifyParticleResized" ></a><p>
432<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
433  <tr>
434    <td class="mdRow">
435      <table cellpadding="0" cellspacing="0" border="0">
436        <tr>
437          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyParticleResized </td>
438          <td class="md" valign="top">(&nbsp;</td>
439          <td class="md" nowrap valign="top">void&nbsp;</td>
440          <td class="mdname1" valign="top" nowrap>          </td>
441          <td class="md" valign="top">&nbsp;)&nbsp;</td>
442          <td class="md" nowrap><code> [virtual]</code></td>
443        </tr>
444
445      </table>
446    </td>
447  </tr>
448</table>
449<table cellspacing=5 cellpadding=0 border=0>
450  <tr>
451    <td>
452      &nbsp;
453    </td>
454    <td>
455
456<p>
457Optional callback notified when particles are resized individually.
458<p>
459
460<p>
461Reimplemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera21">Ogre::BillboardParticleRenderer</a>.
462<p>
463Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00067">67</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
464  </tr>
465</table>
466<a class="anchor" name="Ogre_1_1ParticleSystemRenderera7" doxytag="Ogre::ParticleSystemRenderer::_notifyParticleRotated" ></a><p>
467<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
468  <tr>
469    <td class="mdRow">
470      <table cellpadding="0" cellspacing="0" border="0">
471        <tr>
472          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_notifyParticleRotated </td>
473          <td class="md" valign="top">(&nbsp;</td>
474          <td class="md" nowrap valign="top">void&nbsp;</td>
475          <td class="mdname1" valign="top" nowrap>          </td>
476          <td class="md" valign="top">&nbsp;)&nbsp;</td>
477          <td class="md" nowrap><code> [virtual]</code></td>
478        </tr>
479
480      </table>
481    </td>
482  </tr>
483</table>
484<table cellspacing=5 cellpadding=0 border=0>
485  <tr>
486    <td>
487      &nbsp;
488    </td>
489    <td>
490
491<p>
492Optional callback notified when particles are rotated.
493<p>
494
495<p>
496Reimplemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera20">Ogre::BillboardParticleRenderer</a>.
497<p>
498Definition at line <a class="el" href="OgreParticleSystemRenderer_8h-source.html#l00065">65</a> of file <a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a>.    </td>
499  </tr>
500</table>
501<a class="anchor" name="Ogre_1_1ParticleSystemRenderera4" doxytag="Ogre::ParticleSystemRenderer::_setMaterial" ></a><p>
502<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
503  <tr>
504    <td class="mdRow">
505      <table cellpadding="0" cellspacing="0" border="0">
506        <tr>
507          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_setMaterial </td>
508          <td class="md" valign="top">(&nbsp;</td>
509          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> &amp;&nbsp;</td>
510          <td class="mdname1" valign="top" nowrap> <em>mat</em>          </td>
511          <td class="md" valign="top">&nbsp;)&nbsp;</td>
512          <td class="md" nowrap><code> [pure virtual]</code></td>
513        </tr>
514
515      </table>
516    </td>
517  </tr>
518</table>
519<table cellspacing=5 cellpadding=0 border=0>
520  <tr>
521    <td>
522      &nbsp;
523    </td>
524    <td>
525
526<p>
527Sets the material this renderer must use; called by <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.
528<p>
529
530<p>
531Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera18">Ogre::BillboardParticleRenderer</a>.    </td>
532  </tr>
533</table>
534<a class="anchor" name="Ogre_1_1ParticleSystemRenderera3" doxytag="Ogre::ParticleSystemRenderer::_updateRenderQueue" ></a><p>
535<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
536  <tr>
537    <td class="mdRow">
538      <table cellpadding="0" cellspacing="0" border="0">
539        <tr>
540          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::_updateRenderQueue </td>
541          <td class="md" valign="top">(&nbsp;</td>
542          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1RenderQueue.html">RenderQueue</a> *&nbsp;</td>
543          <td class="mdname" nowrap> <em>queue</em>, </td>
544        </tr>
545        <tr>
546          <td class="md" nowrap align="right"></td>
547          <td></td>
548          <td class="md" nowrap>std::list&lt; <a class="el" href="classOgre_1_1Particle.html">Particle</a> * &gt; &amp;&nbsp;</td>
549          <td class="mdname" nowrap> <em>currentParticles</em>, </td>
550        </tr>
551        <tr>
552          <td class="md" nowrap align="right"></td>
553          <td></td>
554          <td class="md" nowrap>bool&nbsp;</td>
555          <td class="mdname" nowrap> <em>cullIndividually</em></td>
556        </tr>
557        <tr>
558          <td></td>
559          <td class="md">)&nbsp;</td>
560          <td class="md" colspan="2"><code> [pure virtual]</code></td>
561        </tr>
562
563      </table>
564    </td>
565  </tr>
566</table>
567<table cellspacing=5 cellpadding=0 border=0>
568  <tr>
569    <td>
570      &nbsp;
571    </td>
572    <td>
573
574<p>
575Delegated to by <a class="el" href="classOgre_1_1ParticleSystem.html#Ogre_1_1ParticleSystema31">ParticleSystem::_updateRenderQueue</a>.
576<p>
577<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>
578
579<p>
580Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera17">Ogre::BillboardParticleRenderer</a>.    </td>
581  </tr>
582</table>
583<a class="anchor" name="Ogre_1_1Texturee0" doxytag="Ogre::ParticleSystemRenderer::cleanupDictionary" ></a><p>
584<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
585  <tr>
586    <td class="mdRow">
587      <table cellpadding="0" cellspacing="0" border="0">
588        <tr>
589          <td class="md" nowrap valign="top"> void Ogre::StringInterface::cleanupDictionary </td>
590          <td class="md" valign="top">(&nbsp;</td>
591          <td class="mdname1" valign="top" nowrap>          </td>
592          <td class="md" valign="top">&nbsp;)&nbsp;</td>
593          <td class="md" nowrap><code> [static, inherited]</code></td>
594        </tr>
595
596      </table>
597    </td>
598  </tr>
599</table>
600<table cellspacing=5 cellpadding=0 border=0>
601  <tr>
602    <td>
603      &nbsp;
604    </td>
605    <td>
606
607<p>
608Cleans 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.
609<p>
610<a class="el" href="classOgre_1_1MaterialManager.html">MaterialManager</a>) initializes.     </td>
611  </tr>
612</table>
613<a class="anchor" name="Ogre_1_1Texturea51" doxytag="Ogre::ParticleSystemRenderer::copyParametersTo" ></a><p>
614<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
615  <tr>
616    <td class="mdRow">
617      <table cellpadding="0" cellspacing="0" border="0">
618        <tr>
619          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::copyParametersTo </td>
620          <td class="md" valign="top">(&nbsp;</td>
621          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1StringInterface.html">StringInterface</a> *&nbsp;</td>
622          <td class="mdname1" valign="top" nowrap> <em>dest</em>          </td>
623          <td class="md" valign="top">&nbsp;)&nbsp;</td>
624          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
625        </tr>
626
627      </table>
628    </td>
629  </tr>
630</table>
631<table cellspacing=5 cellpadding=0 border=0>
632  <tr>
633    <td>
634      &nbsp;
635    </td>
636    <td>
637
638<p>
639Method for copying this object's parameters to another object.
640<p>
641<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>
642<dl compact><dt><b></b></dt><dd><a class="el" href="classOgre_1_1Any.html">Any</a> unrecognised parameters will be ignored as with setParameter method. </dd></dl>
643<dl compact><dt><b>Parameters:</b></dt><dd>
644  <table border="0" cellspacing="2" cellpadding="0">
645    <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>
646  </table>
647</dl>
648
649<p>
650Definition 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>.
651<p>
652References <a class="el" href="OgreStringInterface_8h-source.html#l00084">Ogre::ParamDictionary::mParamDefs</a>, and <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturea48">Ogre::StringInterface::setParameter()</a>.    </td>
653  </tr>
654</table>
655<a class="anchor" name="Ogre_1_1Textureb6" doxytag="Ogre::ParticleSystemRenderer::createParamDictionary" ></a><p>
656<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
657  <tr>
658    <td class="mdRow">
659      <table cellpadding="0" cellspacing="0" border="0">
660        <tr>
661          <td class="md" nowrap valign="top"> bool Ogre::StringInterface::createParamDictionary </td>
662          <td class="md" valign="top">(&nbsp;</td>
663          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
664          <td class="mdname1" valign="top" nowrap> <em>className</em>          </td>
665          <td class="md" valign="top">&nbsp;)&nbsp;</td>
666          <td class="md" nowrap><code> [protected, inherited]</code></td>
667        </tr>
668
669      </table>
670    </td>
671  </tr>
672</table>
673<table cellspacing=5 cellpadding=0 border=0>
674  <tr>
675    <td>
676      &nbsp;
677    </td>
678    <td>
679
680<p>
681Internal method for creating a parameter dictionary for the class, if it does not already exist.
682<p>
683<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>
684<dl compact><dt><b>Parameters:</b></dt><dd>
685  <table border="0" cellspacing="2" cellpadding="0">
686    <tr><td valign=top><em>className</em>&nbsp;</td><td>the name of the class using the dictionary </td></tr>
687  </table>
688</dl>
689<dl compact><dt><b>Returns:</b></dt><dd>true if a new dictionary was created, false if it was already there </dd></dl>
690
691<p>
692Definition 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>.
693<p>
694References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>.    </td>
695  </tr>
696</table>
697<a class="anchor" name="Ogre_1_1Texturea46" doxytag="Ogre::ParticleSystemRenderer::getParamDictionary" ></a><p>
698<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
699  <tr>
700    <td class="mdRow">
701      <table cellpadding="0" cellspacing="0" border="0">
702        <tr>
703          <td class="md" nowrap valign="top"> const <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
704          <td class="md" valign="top">(&nbsp;</td>
705          <td class="md" nowrap valign="top">void&nbsp;</td>
706          <td class="mdname1" valign="top" nowrap>          </td>
707          <td class="md" valign="top">&nbsp;)&nbsp;</td>
708          <td class="md" nowrap> const<code> [inherited]</code></td>
709        </tr>
710
711      </table>
712    </td>
713  </tr>
714</table>
715<table cellspacing=5 cellpadding=0 border=0>
716  <tr>
717    <td>
718      &nbsp;
719    </td>
720    <td>
721
722<p>
723
724<p>
725Definition 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>
726  </tr>
727</table>
728<a class="anchor" name="Ogre_1_1Texturea45" doxytag="Ogre::ParticleSystemRenderer::getParamDictionary" ></a><p>
729<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
730  <tr>
731    <td class="mdRow">
732      <table cellpadding="0" cellspacing="0" border="0">
733        <tr>
734          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1ParamDictionary.html">ParamDictionary</a>* Ogre::StringInterface::getParamDictionary </td>
735          <td class="md" valign="top">(&nbsp;</td>
736          <td class="md" nowrap valign="top">void&nbsp;</td>
737          <td class="mdname1" valign="top" nowrap>          </td>
738          <td class="md" valign="top">&nbsp;)&nbsp;</td>
739          <td class="md" nowrap><code> [inherited]</code></td>
740        </tr>
741
742      </table>
743    </td>
744  </tr>
745</table>
746<table cellspacing=5 cellpadding=0 border=0>
747  <tr>
748    <td>
749      &nbsp;
750    </td>
751    <td>
752
753<p>
754Retrieves the parameter dictionary for this class.
755<p>
756<dl compact><dt><b>Remarks:</b></dt><dd>Only valid to call this after createParamDictionary. </dd></dl>
757<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>
758
759<p>
760Definition 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>
761  </tr>
762</table>
763<a class="anchor" name="Ogre_1_1Texturea50" doxytag="Ogre::ParticleSystemRenderer::getParameter" ></a><p>
764<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
765  <tr>
766    <td class="mdRow">
767      <table cellpadding="0" cellspacing="0" border="0">
768        <tr>
769          <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::StringInterface::getParameter </td>
770          <td class="md" valign="top">(&nbsp;</td>
771          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
772          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
773          <td class="md" valign="top">&nbsp;)&nbsp;</td>
774          <td class="md" nowrap> const<code> [virtual, inherited]</code></td>
775        </tr>
776
777      </table>
778    </td>
779  </tr>
780</table>
781<table cellspacing=5 cellpadding=0 border=0>
782  <tr>
783    <td>
784      &nbsp;
785    </td>
786    <td>
787
788<p>
789Generic parameter retrieval method.
790<p>
791<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>
792<dl compact><dt><b>Parameters:</b></dt><dd>
793  <table border="0" cellspacing="2" cellpadding="0">
794    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to get </td></tr>
795  </table>
796</dl>
797<dl compact><dt><b>Returns:</b></dt><dd>String value of parameter, blank if not found </dd></dl>
798
799<p>
800Definition 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>.
801<p>
802References <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#l00156">Ogre::String</a>.    </td>
803  </tr>
804</table>
805<a class="anchor" name="Ogre_1_1Texturea47" doxytag="Ogre::ParticleSystemRenderer::getParameters" ></a><p>
806<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
807  <tr>
808    <td class="mdRow">
809      <table cellpadding="0" cellspacing="0" border="0">
810        <tr>
811          <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a563">ParameterList</a>&amp; Ogre::StringInterface::getParameters </td>
812          <td class="md" valign="top">(&nbsp;</td>
813          <td class="md" nowrap valign="top">void&nbsp;</td>
814          <td class="mdname1" valign="top" nowrap>          </td>
815          <td class="md" valign="top">&nbsp;)&nbsp;</td>
816          <td class="md" nowrap> const<code> [inherited]</code></td>
817        </tr>
818
819      </table>
820    </td>
821  </tr>
822</table>
823<table cellspacing=5 cellpadding=0 border=0>
824  <tr>
825    <td>
826      &nbsp;
827    </td>
828    <td>
829
830<p>
831Retrieves a list of parameters valid for this object.
832<p>
833<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>
834    </td>
835  </tr>
836</table>
837<a class="anchor" name="Ogre_1_1ParticleSystemRenderera2" doxytag="Ogre::ParticleSystemRenderer::getType" ></a><p>
838<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
839  <tr>
840    <td class="mdRow">
841      <table cellpadding="0" cellspacing="0" border="0">
842        <tr>
843          <td class="md" nowrap valign="top"> virtual const <a class="el" href="namespaceOgre.html#a471">String</a>&amp; Ogre::ParticleSystemRenderer::getType </td>
844          <td class="md" valign="top">(&nbsp;</td>
845          <td class="md" nowrap valign="top">void&nbsp;</td>
846          <td class="mdname1" valign="top" nowrap>          </td>
847          <td class="md" valign="top">&nbsp;)&nbsp;</td>
848          <td class="md" nowrap> const<code> [pure virtual]</code></td>
849        </tr>
850
851      </table>
852    </td>
853  </tr>
854</table>
855<table cellspacing=5 cellpadding=0 border=0>
856  <tr>
857    <td>
858      &nbsp;
859    </td>
860    <td>
861
862<p>
863Gets the type of this renderer - must be implemented by subclasses.
864<p>
865
866<p>
867Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera16">Ogre::BillboardParticleRenderer</a>.    </td>
868  </tr>
869</table>
870<a class="anchor" name="Ogre_1_1ParticleSystemRenderera14" doxytag="Ogre::ParticleSystemRenderer::setKeepParticlesInLocalSpace" ></a><p>
871<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
872  <tr>
873    <td class="mdRow">
874      <table cellpadding="0" cellspacing="0" border="0">
875        <tr>
876          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::setKeepParticlesInLocalSpace </td>
877          <td class="md" valign="top">(&nbsp;</td>
878          <td class="md" nowrap valign="top">bool&nbsp;</td>
879          <td class="mdname1" valign="top" nowrap> <em>keepLocal</em>          </td>
880          <td class="md" valign="top">&nbsp;)&nbsp;</td>
881          <td class="md" nowrap><code> [pure virtual]</code></td>
882        </tr>
883
884      </table>
885    </td>
886  </tr>
887</table>
888<table cellspacing=5 cellpadding=0 border=0>
889  <tr>
890    <td>
891      &nbsp;
892    </td>
893    <td>
894
895<p>
896Setting carried over from <a class="el" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>.
897<p>
898
899<p>
900Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera26">Ogre::BillboardParticleRenderer</a>.    </td>
901  </tr>
902</table>
903<a class="anchor" name="Ogre_1_1Texturea48" doxytag="Ogre::ParticleSystemRenderer::setParameter" ></a><p>
904<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
905  <tr>
906    <td class="mdRow">
907      <table cellpadding="0" cellspacing="0" border="0">
908        <tr>
909          <td class="md" nowrap valign="top"> virtual bool Ogre::StringInterface::setParameter </td>
910          <td class="md" valign="top">(&nbsp;</td>
911          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
912          <td class="mdname" nowrap> <em>name</em>, </td>
913        </tr>
914        <tr>
915          <td class="md" nowrap align="right"></td>
916          <td></td>
917          <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> &amp;&nbsp;</td>
918          <td class="mdname" nowrap> <em>value</em></td>
919        </tr>
920        <tr>
921          <td></td>
922          <td class="md">)&nbsp;</td>
923          <td class="md" colspan="2"><code> [virtual, inherited]</code></td>
924        </tr>
925
926      </table>
927    </td>
928  </tr>
929</table>
930<table cellspacing=5 cellpadding=0 border=0>
931  <tr>
932    <td>
933      &nbsp;
934    </td>
935    <td>
936
937<p>
938Generic parameter setting method.
939<p>
940<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_1Texturea47">StringInterface::getParameters</a>. </dd></dl>
941<dl compact><dt><b>Parameters:</b></dt><dd>
942  <table border="0" cellspacing="2" cellpadding="0">
943    <tr><td valign=top><em>name</em>&nbsp;</td><td>The name of the parameter to set </td></tr>
944    <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>
945  </table>
946</dl>
947<dl compact><dt><b>Returns:</b></dt><dd>true if set was successful, false otherwise (NB no exceptions thrown - tolerant method) </dd></dl>
948
949<p>
950Referenced by <a class="el" href="OgreStringInterface_8h-source.html#l00296">Ogre::StringInterface::copyParametersTo()</a>.    </td>
951  </tr>
952</table>
953<a class="anchor" name="Ogre_1_1Texturea49" doxytag="Ogre::ParticleSystemRenderer::setParameterList" ></a><p>
954<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
955  <tr>
956    <td class="mdRow">
957      <table cellpadding="0" cellspacing="0" border="0">
958        <tr>
959          <td class="md" nowrap valign="top"> virtual void Ogre::StringInterface::setParameterList </td>
960          <td class="md" valign="top">(&nbsp;</td>
961          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a76">NameValuePairList</a> &amp;&nbsp;</td>
962          <td class="mdname1" valign="top" nowrap> <em>paramList</em>          </td>
963          <td class="md" valign="top">&nbsp;)&nbsp;</td>
964          <td class="md" nowrap><code> [virtual, inherited]</code></td>
965        </tr>
966
967      </table>
968    </td>
969  </tr>
970</table>
971<table cellspacing=5 cellpadding=0 border=0>
972  <tr>
973    <td>
974      &nbsp;
975    </td>
976    <td>
977
978<p>
979Generic multiple parameter setting method.
980<p>
981<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_1Texturea47">StringInterface::getParameters</a>. </dd></dl>
982<dl compact><dt><b>Parameters:</b></dt><dd>
983  <table border="0" cellspacing="2" cellpadding="0">
984    <tr><td valign=top><em>paramList</em>&nbsp;</td><td>Name/value pair list </td></tr>
985  </table>
986</dl>
987    </td>
988  </tr>
989</table>
990<a class="anchor" name="Ogre_1_1ParticleSystemRenderera13" doxytag="Ogre::ParticleSystemRenderer::setRenderQueueGroup" ></a><p>
991<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
992  <tr>
993    <td class="mdRow">
994      <table cellpadding="0" cellspacing="0" border="0">
995        <tr>
996          <td class="md" nowrap valign="top"> virtual void Ogre::ParticleSystemRenderer::setRenderQueueGroup </td>
997          <td class="md" valign="top">(&nbsp;</td>
998          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a457">uint8</a>&nbsp;</td>
999          <td class="mdname1" valign="top" nowrap> <em>queueID</em>          </td>
1000          <td class="md" valign="top">&nbsp;)&nbsp;</td>
1001          <td class="md" nowrap><code> [pure virtual]</code></td>
1002        </tr>
1003
1004      </table>
1005    </td>
1006  </tr>
1007</table>
1008<table cellspacing=5 cellpadding=0 border=0>
1009  <tr>
1010    <td>
1011      &nbsp;
1012    </td>
1013    <td>
1014
1015<p>
1016Sets which render queue group this renderer should target with it's output.
1017<p>
1018
1019<p>
1020Implemented in <a class="el" href="classOgre_1_1BillboardParticleRenderer.html#Ogre_1_1BillboardParticleRenderera25">Ogre::BillboardParticleRenderer</a>.    </td>
1021  </tr>
1022</table>
1023<hr><h2>Member Data Documentation</h2>
1024<a class="anchor" name="Ogre_1_1Texturep26" doxytag="Ogre::ParticleSystemRenderer::mParamDictName" ></a><p>
1025<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1026  <tr>
1027    <td class="mdRow">
1028      <table cellpadding="0" cellspacing="0" border="0">
1029        <tr>
1030          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturep26">Ogre::StringInterface::mParamDictName</a><code> [protected, inherited]</code>
1031      </table>
1032    </td>
1033  </tr>
1034</table>
1035<table cellspacing=5 cellpadding=0 border=0>
1036  <tr>
1037    <td>
1038      &nbsp;
1039    </td>
1040    <td>
1041
1042<p>
1043Class name for this instance to be used as a lookup (must be initialised by subclasses).
1044<p>
1045
1046<p>
1047Definition 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>
1048  </tr>
1049</table>
1050<a class="anchor" name="Ogre_1_1Texturet0" doxytag="Ogre::ParticleSystemRenderer::msDictionary" ></a><p>
1051<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
1052  <tr>
1053    <td class="mdRow">
1054      <table cellpadding="0" cellspacing="0" border="0">
1055        <tr>
1056          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a565">ParamDictionaryMap</a> <a class="el" href="classOgre_1_1StringInterface.html#Ogre_1_1Texturet0">Ogre::StringInterface::msDictionary</a><code> [static, protected, inherited]</code>
1057      </table>
1058    </td>
1059  </tr>
1060</table>
1061<table cellspacing=5 cellpadding=0 border=0>
1062  <tr>
1063    <td>
1064      &nbsp;
1065    </td>
1066    <td>
1067
1068<p>
1069Dictionary of parameters.
1070<p>
1071
1072<p>
1073Definition 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>
1074  </tr>
1075</table>
1076<hr>The documentation for this class was generated from the following file:<ul>
1077<li><a class="el" href="OgreParticleSystemRenderer_8h-source.html">OgreParticleSystemRenderer.h</a></ul>
1078<hr>
1079<p>
1080Copyright &copy; 2000-2005 by The OGRE Team<br />
1081<!--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/>
1082This 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/>
1083                <!--/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#">
1084                <Work rdf:about="">
1085                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
1086        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
1087                </Work>
1088                <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> -->
1089
1090Last modified Sun Mar 12 14:41:21 2006
1091</p>
1092</body>
1093</html>
Note: See TracBrowser for help on using the repository browser.