aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_particle_affector.html
diff options
context:
space:
mode:
Diffstat (limited to 'src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_particle_affector.html')
-rw-r--r--src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_particle_affector.html317
1 files changed, 317 insertions, 0 deletions
diff --git a/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_particle_affector.html b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_particle_affector.html
new file mode 100644
index 0000000..c579b07
--- /dev/null
+++ b/src/others/irrlicht-1.8.1/doc/html/classirr_1_1scene_1_1_i_particle_affector.html
@@ -0,0 +1,317 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5<title>Irrlicht 3D Engine: irr::scene::IParticleAffector Class Reference</title>
6
7<link href="tabs.css" rel="stylesheet" type="text/css"/>
8<link href="doxygen.css" rel="stylesheet" type="text/css" />
9<link href="navtree.css" rel="stylesheet" type="text/css"/>
10<script type="text/javascript" src="jquery.js"></script>
11<script type="text/javascript" src="resize.js"></script>
12<script type="text/javascript" src="navtree.js"></script>
13<script type="text/javascript">
14 $(document).ready(initResizable);
15</script>
16<link href="search/search.css" rel="stylesheet" type="text/css"/>
17<script type="text/javascript" src="search/search.js"></script>
18<script type="text/javascript">
19 $(document).ready(function() { searchBox.OnSelectItem(0); });
20</script>
21
22</head>
23<body>
24<div id="top"><!-- do not remove this div! -->
25
26
27<div id="titlearea">
28<table cellspacing="0" cellpadding="0">
29 <tbody>
30 <tr style="height: 56px;">
31
32 <td id="projectlogo"><img alt="Logo" src="irrlichtlogo.png"/></td>
33
34
35 <td style="padding-left: 0.5em;">
36 <div id="projectname">Irrlicht 3D Engine
37
38 </div>
39
40 </td>
41
42
43
44
45 <td> <div id="MSearchBox" class="MSearchBoxInactive">
46 <span class="left">
47 <img id="MSearchSelect" src="search/mag_sel.png"
48 onmouseover="return searchBox.OnSearchSelectShow()"
49 onmouseout="return searchBox.OnSearchSelectHide()"
50 alt=""/>
51 <input type="text" id="MSearchField" value="Search" accesskey="S"
52 onfocus="searchBox.OnSearchFieldFocus(true)"
53 onblur="searchBox.OnSearchFieldFocus(false)"
54 onkeyup="searchBox.OnSearchFieldChange(event)"/>
55 </span><span class="right">
56 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
57 </span>
58 </div>
59</td>
60
61
62 </tr>
63 </tbody>
64</table>
65</div>
66
67<!-- Generated by Doxygen 1.7.5.1 -->
68<script type="text/javascript">
69var searchBox = new SearchBox("searchBox", "search",false,'Search');
70</script>
71<script type="text/javascript" src="dynsections.js"></script>
72</div>
73<div id="side-nav" class="ui-resizable side-nav-resizable">
74 <div id="nav-tree">
75 <div id="nav-tree-contents">
76 </div>
77 </div>
78 <div id="splitbar" style="-moz-user-select:none;"
79 class="ui-resizable-handle">
80 </div>
81</div>
82<script type="text/javascript">
83 initNavTree('classirr_1_1scene_1_1_i_particle_affector.html','');
84</script>
85<div id="doc-content">
86<div class="header">
87 <div class="summary">
88<a href="#pub-methods">Public Member Functions</a> &#124;
89<a href="#pro-attribs">Protected Attributes</a> </div>
90 <div class="headertitle">
91<div class="title">irr::scene::IParticleAffector Class Reference</div> </div>
92</div>
93<div class="contents">
94<!-- doxytag: class="irr::scene::IParticleAffector" --><!-- doxytag: inherits="irr::io::IAttributeExchangingObject" -->
95<p>A particle affector modifies particles.
96 <a href="classirr_1_1scene_1_1_i_particle_affector.html#details">More...</a></p>
97
98<p><code>#include &lt;<a class="el" href="_i_particle_affector_8h_source.html">IParticleAffector.h</a>&gt;</code></p>
99<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
100 <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for irr::scene::IParticleAffector:</div>
101<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
102</div>
103<div id="dynsection-0-content" class="dyncontent" style="display:none;">
104 <div class="center">
105 <img src="classirr_1_1scene_1_1_i_particle_affector.png" usemap="#irr::scene::IParticleAffector_map" alt=""/>
106 <map id="irr::scene::IParticleAffector_map" name="irr::scene::IParticleAffector_map">
107<area href="classirr_1_1io_1_1_i_attribute_exchanging_object.html" title="An object which is able to serialize and deserialize its attributes into an attributes object..." alt="irr::io::IAttributeExchangingObject" shape="rect" coords="340,56,557,80"/>
108<area href="classirr_1_1_i_reference_counted.html" title="Base class of most objects of the Irrlicht Engine." alt="irr::IReferenceCounted" shape="rect" coords="340,0,557,24"/>
109<area href="classirr_1_1scene_1_1_i_particle_attraction_affector.html" title="A particle affector which attracts or detracts particles." alt="irr::scene::IParticleAttractionAffector" shape="rect" coords="0,168,217,192"/>
110<area href="classirr_1_1scene_1_1_i_particle_fade_out_affector.html" title="A particle affector which fades out the particles." alt="irr::scene::IParticleFadeOutAffector" shape="rect" coords="227,168,444,192"/>
111<area href="classirr_1_1scene_1_1_i_particle_gravity_affector.html" title="A particle affector which applies gravity to particles." alt="irr::scene::IParticleGravityAffector" shape="rect" coords="454,168,671,192"/>
112<area href="classirr_1_1scene_1_1_i_particle_rotation_affector.html" title="A particle affector which rotates the particle system." alt="irr::scene::IParticleRotationAffector" shape="rect" coords="681,168,898,192"/>
113</map>
114 </div></div>
115
116<p><a href="classirr_1_1scene_1_1_i_particle_affector-members.html">List of all members.</a></p>
117<h2><a name="pub-methods"></a>
118Public Member Functions</h2>
119<ul>
120<li><a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html#a060c7080c8c619e9bb2d35c7ac981889">IParticleAffector</a> ()
121<dl class="el"><dd class="mdescRight">constructor <a href="#a060c7080c8c619e9bb2d35c7ac981889"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html#a87fb9116bb1a4d3ea075c59f3e2d1dbc">affect</a> (<a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> now, <a class="el" href="structirr_1_1scene_1_1_s_particle.html">SParticle</a> *particlearray, <a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a> count)=0
122<dl class="el"><dd class="mdescRight">Affects an array of particles. <a href="#a87fb9116bb1a4d3ea075c59f3e2d1dbc"></a><br/></dl><li>virtual bool <a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html#a23e0a72307a93dbb25453a7229bd8840">getEnabled</a> () const
123<dl class="el"><dd class="mdescRight">Gets whether or not the affector is currently enabled. <a href="#a23e0a72307a93dbb25453a7229bd8840"></a><br/></dl><li>virtual <a class="el" href="namespaceirr_1_1scene.html#a34c0f9475cfcbda8b50ad816a046010b">E_PARTICLE_AFFECTOR_TYPE</a> <a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html#add5652cd7dabb91342497fed776e2557">getType</a> () const =0
124<dl class="el"><dd class="mdescRight">Get emitter type. <a href="#add5652cd7dabb91342497fed776e2557"></a><br/></dl><li>virtual void <a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html#aa3715a5686640a180462ad7843aaff0b">setEnabled</a> (bool enabled)
125<dl class="el"><dd class="mdescRight">Sets whether or not the affector is currently enabled. <a href="#aa3715a5686640a180462ad7843aaff0b"></a><br/></dl></ul>
126<h2><a name="pro-attribs"></a>
127Protected Attributes</h2>
128<ul>
129<li>bool <a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html#a23798f130948c5d4bd045f69f4035398">Enabled</a>
130</ul>
131<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
132<div class="textblock"><p>A particle affector modifies particles. </p>
133
134<p>Definition at line <a class="el" href="_i_particle_affector_8h_source.html#l00041">41</a> of file <a class="el" href="_i_particle_affector_8h_source.html">IParticleAffector.h</a>.</p>
135</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
136<a class="anchor" id="a060c7080c8c619e9bb2d35c7ac981889"></a><!-- doxytag: member="irr::scene::IParticleAffector::IParticleAffector" ref="a060c7080c8c619e9bb2d35c7ac981889" args="()" -->
137<div class="memitem">
138<div class="memproto">
139 <table class="memname">
140 <tr>
141 <td class="memname">irr::scene::IParticleAffector::IParticleAffector </td>
142 <td>(</td>
143 <td class="paramname"></td><td>)</td>
144 <td><code> [inline]</code></td>
145 </tr>
146 </table>
147</div>
148<div class="memdoc">
149
150<p>constructor </p>
151
152<p>Definition at line <a class="el" href="_i_particle_affector_8h_source.html#l00046">46</a> of file <a class="el" href="_i_particle_affector_8h_source.html">IParticleAffector.h</a>.</p>
153
154</div>
155</div>
156<hr/><h2>Member Function Documentation</h2>
157<a class="anchor" id="a87fb9116bb1a4d3ea075c59f3e2d1dbc"></a><!-- doxytag: member="irr::scene::IParticleAffector::affect" ref="a87fb9116bb1a4d3ea075c59f3e2d1dbc" args="(u32 now, SParticle *particlearray, u32 count)=0" -->
158<div class="memitem">
159<div class="memproto">
160 <table class="memname">
161 <tr>
162 <td class="memname">virtual void irr::scene::IParticleAffector::affect </td>
163 <td>(</td>
164 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
165 <td class="paramname"><em>now</em>, </td>
166 </tr>
167 <tr>
168 <td class="paramkey"></td>
169 <td></td>
170 <td class="paramtype"><a class="el" href="structirr_1_1scene_1_1_s_particle.html">SParticle</a> *&#160;</td>
171 <td class="paramname"><em>particlearray</em>, </td>
172 </tr>
173 <tr>
174 <td class="paramkey"></td>
175 <td></td>
176 <td class="paramtype"><a class="el" href="namespaceirr.html#a0416a53257075833e7002efd0a18e804">u32</a>&#160;</td>
177 <td class="paramname"><em>count</em>&#160;</td>
178 </tr>
179 <tr>
180 <td></td>
181 <td>)</td>
182 <td></td><td><code> [pure virtual]</code></td>
183 </tr>
184 </table>
185</div>
186<div class="memdoc">
187
188<p>Affects an array of particles. </p>
189<dl><dt><b>Parameters:</b></dt><dd>
190 <table class="params">
191 <tr><td class="paramname">now</td><td>Current time. (Same as <a class="el" href="classirr_1_1_i_timer.html#aa2c53890268d6886b3b5bbf2af5dba9c" title="Returns current virtual time in milliseconds.">ITimer::getTime()</a> would return) </td></tr>
192 <tr><td class="paramname">particlearray</td><td>Array of particles. </td></tr>
193 <tr><td class="paramname">count</td><td>Amount of particles in array. </td></tr>
194 </table>
195 </dd>
196</dl>
197
198</div>
199</div>
200<a class="anchor" id="a23e0a72307a93dbb25453a7229bd8840"></a><!-- doxytag: member="irr::scene::IParticleAffector::getEnabled" ref="a23e0a72307a93dbb25453a7229bd8840" args="() const " -->
201<div class="memitem">
202<div class="memproto">
203 <table class="memname">
204 <tr>
205 <td class="memname">virtual bool irr::scene::IParticleAffector::getEnabled </td>
206 <td>(</td>
207 <td class="paramname"></td><td>)</td>
208 <td> const<code> [inline, virtual]</code></td>
209 </tr>
210 </table>
211</div>
212<div class="memdoc">
213
214<p>Gets whether or not the affector is currently enabled. </p>
215
216<p>Definition at line <a class="el" href="_i_particle_affector_8h_source.html#l00058">58</a> of file <a class="el" href="_i_particle_affector_8h_source.html">IParticleAffector.h</a>.</p>
217
218<p>References <a class="el" href="_i_particle_affector_8h_source.html#l00064">Enabled</a>.</p>
219
220</div>
221</div>
222<a class="anchor" id="add5652cd7dabb91342497fed776e2557"></a><!-- doxytag: member="irr::scene::IParticleAffector::getType" ref="add5652cd7dabb91342497fed776e2557" args="() const =0" -->
223<div class="memitem">
224<div class="memproto">
225 <table class="memname">
226 <tr>
227 <td class="memname">virtual <a class="el" href="namespaceirr_1_1scene.html#a34c0f9475cfcbda8b50ad816a046010b">E_PARTICLE_AFFECTOR_TYPE</a> irr::scene::IParticleAffector::getType </td>
228 <td>(</td>
229 <td class="paramname"></td><td>)</td>
230 <td> const<code> [pure virtual]</code></td>
231 </tr>
232 </table>
233</div>
234<div class="memdoc">
235
236<p>Get emitter type. </p>
237
238<p>Implemented in <a class="el" href="classirr_1_1scene_1_1_i_particle_attraction_affector.html#a8b7801b8cc28c5c1a1c1d46f526ccac4">irr::scene::IParticleAttractionAffector</a>, <a class="el" href="classirr_1_1scene_1_1_i_particle_gravity_affector.html#a76fdedddfa7fb08e687e2c240b3eedd1">irr::scene::IParticleGravityAffector</a>, <a class="el" href="classirr_1_1scene_1_1_i_particle_fade_out_affector.html#ac49427a7c8981d4d28d807e81ba04617">irr::scene::IParticleFadeOutAffector</a>, and <a class="el" href="classirr_1_1scene_1_1_i_particle_rotation_affector.html#af85dcdff7cb30ccea6d7f58c7a44f804">irr::scene::IParticleRotationAffector</a>.</p>
239
240</div>
241</div>
242<a class="anchor" id="aa3715a5686640a180462ad7843aaff0b"></a><!-- doxytag: member="irr::scene::IParticleAffector::setEnabled" ref="aa3715a5686640a180462ad7843aaff0b" args="(bool enabled)" -->
243<div class="memitem">
244<div class="memproto">
245 <table class="memname">
246 <tr>
247 <td class="memname">virtual void irr::scene::IParticleAffector::setEnabled </td>
248 <td>(</td>
249 <td class="paramtype">bool&#160;</td>
250 <td class="paramname"><em>enabled</em></td><td>)</td>
251 <td><code> [inline, virtual]</code></td>
252 </tr>
253 </table>
254</div>
255<div class="memdoc">
256
257<p>Sets whether or not the affector is currently enabled. </p>
258
259<p>Definition at line <a class="el" href="_i_particle_affector_8h_source.html#l00055">55</a> of file <a class="el" href="_i_particle_affector_8h_source.html">IParticleAffector.h</a>.</p>
260
261<p>References <a class="el" href="_i_particle_affector_8h_source.html#l00064">Enabled</a>.</p>
262
263</div>
264</div>
265<hr/><h2>Member Data Documentation</h2>
266<a class="anchor" id="a23798f130948c5d4bd045f69f4035398"></a><!-- doxytag: member="irr::scene::IParticleAffector::Enabled" ref="a23798f130948c5d4bd045f69f4035398" args="" -->
267<div class="memitem">
268<div class="memproto">
269 <table class="memname">
270 <tr>
271 <td class="memname">bool <a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html#a23798f130948c5d4bd045f69f4035398">irr::scene::IParticleAffector::Enabled</a><code> [protected]</code></td>
272 </tr>
273 </table>
274</div>
275<div class="memdoc">
276
277<p>Definition at line <a class="el" href="_i_particle_affector_8h_source.html#l00064">64</a> of file <a class="el" href="_i_particle_affector_8h_source.html">IParticleAffector.h</a>.</p>
278
279<p>Referenced by <a class="el" href="_i_particle_affector_8h_source.html#l00058">getEnabled()</a>, and <a class="el" href="_i_particle_affector_8h_source.html#l00055">setEnabled()</a>.</p>
280
281</div>
282</div>
283<hr/>The documentation for this class was generated from the following file:<ul>
284<li><a class="el" href="_i_particle_affector_8h_source.html">IParticleAffector.h</a></li>
285</ul>
286</div>
287</div>
288 <div id="nav-path" class="navpath">
289 <ul>
290 <li class="navelem"><a class="el" href="namespaceirr.html">irr</a> </li>
291 <li class="navelem"><a class="el" href="namespaceirr_1_1scene.html">scene</a> </li>
292 <li class="navelem"><a class="el" href="classirr_1_1scene_1_1_i_particle_affector.html">IParticleAffector</a> </li>
293<!-- window showing the filter options -->
294<div id="MSearchSelectWindow"
295 onmouseover="return searchBox.OnSearchSelectShow()"
296 onmouseout="return searchBox.OnSearchSelectHide()"
297 onkeydown="return searchBox.OnSearchSelectKey(event)">
298<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Defines</a></div>
299
300<!-- iframe showing the search results (closed by default) -->
301<div id="MSearchResultsWindow">
302<iframe src="javascript:void(0)" frameborder="0"
303 name="MSearchResults" id="MSearchResults">
304</iframe>
305</div>
306
307
308 <li class="footer">
309<a href="http://irrlicht.sourceforge.net" target="_blank">Irrlicht
310Engine</a> Documentation &copy; 2003-2012 by Nikolaus Gebhardt. Generated on Sun Nov 17 2013 20:18:46 for Irrlicht 3D Engine by
311<a href="http://www.doxygen.org/index.html" target="_blank">Doxygen</a> 1.7.5.1 </li>
312 </ul>
313 </div>
314
315
316</body>
317</html>