class_particle_system.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: ParticleSystem Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#nested-classes">Classes</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  75. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
  76. <a href="class_particle_system-members.html">List of all members</a> </div>
  77. <div class="headertitle"><div class="title">ParticleSystem Class Reference</div></div>
  78. </div><!--header-->
  79. <div class="contents">
  80. <p><code>#include &lt;ParticleSystem.h&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  83. Classes</h2></td></tr>
  84. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_particle_system_1_1_particle_node.html">ParticleNode</a></td></tr>
  85. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Particle node. <a href="struct_particle_system_1_1_particle_node.html#details">More...</a><br /></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table><table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  89. Public Member Functions</h2></td></tr>
  90. <tr class="memitem:af4724918e167ca419f98595f463e6b2b" id="r_af4724918e167ca419f98595f463e6b2b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#af4724918e167ca419f98595f463e6b2b">ParticleSystem</a> ()</td></tr>
  91. <tr class="separator:af4724918e167ca419f98595f463e6b2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a78dd6f590140263566341079641ead45" id="r_a78dd6f590140263566341079641ead45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#a78dd6f590140263566341079641ead45">~ParticleSystem</a> ()</td></tr>
  93. <tr class="separator:a78dd6f590140263566341079641ead45"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:af1b3a9e5977149cefc04f2abf28bb14c" id="r_af1b3a9e5977149cefc04f2abf28bb14c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_particle_system_1_1_particle_node.html">ParticleNode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#af1b3a9e5977149cefc04f2abf28bb14c">createParticle</a> (void)</td></tr>
  95. <tr class="separator:af1b3a9e5977149cefc04f2abf28bb14c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:aa1721417f0d69055588d73482234a5ba" id="r_aa1721417f0d69055588d73482234a5ba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#aa1721417f0d69055588d73482234a5ba">freeParticle</a> (<a class="el" href="struct_particle_system_1_1_particle_node.html">ParticleNode</a> *pParticleNode)</td></tr>
  97. <tr class="separator:aa1721417f0d69055588d73482234a5ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a899856192fbbcfc637b18e6a8056db1d" id="r_a899856192fbbcfc637b18e6a8056db1d"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#a899856192fbbcfc637b18e6a8056db1d">getActiveParticleCount</a> (void) const</td></tr>
  99. <tr class="separator:a899856192fbbcfc637b18e6a8056db1d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:afac64348326a2ac6927d8b52583fae03" id="r_afac64348326a2ac6927d8b52583fae03"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#afac64348326a2ac6927d8b52583fae03">getAllocatedParticleCount</a> (void) const</td></tr>
  101. <tr class="separator:afac64348326a2ac6927d8b52583fae03"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table><table class="memberdecls">
  103. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  104. Static Public Member Functions</h2></td></tr>
  105. <tr class="memitem:a7ce0a14b6e7779fbb2d9a05333792c41" id="r_a7ce0a14b6e7779fbb2d9a05333792c41"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#a7ce0a14b6e7779fbb2d9a05333792c41">Init</a> (void)</td></tr>
  106. <tr class="separator:a7ce0a14b6e7779fbb2d9a05333792c41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a753e3cdb094f7b939f247bd7e16fe04a" id="r_a753e3cdb094f7b939f247bd7e16fe04a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#a753e3cdb094f7b939f247bd7e16fe04a">destroy</a> (void)</td></tr>
  108. <tr class="separator:a753e3cdb094f7b939f247bd7e16fe04a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table><table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  111. Static Public Attributes</h2></td></tr>
  112. <tr class="memitem:ad28e62c560d6f1975a0b4a90d8fc3463" id="r_ad28e62c560d6f1975a0b4a90d8fc3463"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_particle_system.html">ParticleSystem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_particle_system.html#ad28e62c560d6f1975a0b4a90d8fc3463">Instance</a> = NULL</td></tr>
  113. <tr class="separator:ad28e62c560d6f1975a0b4a90d8fc3463"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  116. <a id="af4724918e167ca419f98595f463e6b2b" name="af4724918e167ca419f98595f463e6b2b"></a>
  117. <h2 class="memtitle"><span class="permalink"><a href="#af4724918e167ca419f98595f463e6b2b">&#9670;&#160;</a></span>ParticleSystem()</h2>
  118. <div class="memitem">
  119. <div class="memproto">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname"><a class="el" href="class_particle_system.html">ParticleSystem</a> </td>
  123. <td>(</td>
  124. <td class="paramname"></td><td>)</td>
  125. <td></td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. </div>
  130. </div>
  131. <a id="a78dd6f590140263566341079641ead45" name="a78dd6f590140263566341079641ead45"></a>
  132. <h2 class="memtitle"><span class="permalink"><a href="#a78dd6f590140263566341079641ead45">&#9670;&#160;</a></span>~ParticleSystem()</h2>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="memname">
  136. <tr>
  137. <td class="memname">~<a class="el" href="class_particle_system.html">ParticleSystem</a> </td>
  138. <td>(</td>
  139. <td class="paramname"></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. </div>
  145. </div>
  146. <h2 class="groupheader">Member Function Documentation</h2>
  147. <a id="af1b3a9e5977149cefc04f2abf28bb14c" name="af1b3a9e5977149cefc04f2abf28bb14c"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#af1b3a9e5977149cefc04f2abf28bb14c">&#9670;&#160;</a></span>createParticle()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname"><a class="el" href="struct_particle_system_1_1_particle_node.html">ParticleSystem::ParticleNode</a> * createParticle </td>
  154. <td>(</td>
  155. <td class="paramtype">void&#160;</td>
  156. <td class="paramname"></td><td>)</td>
  157. <td></td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. </div>
  162. </div>
  163. <a id="a753e3cdb094f7b939f247bd7e16fe04a" name="a753e3cdb094f7b939f247bd7e16fe04a"></a>
  164. <h2 class="memtitle"><span class="permalink"><a href="#a753e3cdb094f7b939f247bd7e16fe04a">&#9670;&#160;</a></span>destroy()</h2>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="mlabels">
  168. <tr>
  169. <td class="mlabels-left">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">void destroy </td>
  173. <td>(</td>
  174. <td class="paramtype">void&#160;</td>
  175. <td class="paramname"></td><td>)</td>
  176. <td></td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. </div>
  186. </div>
  187. <a id="aa1721417f0d69055588d73482234a5ba" name="aa1721417f0d69055588d73482234a5ba"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#aa1721417f0d69055588d73482234a5ba">&#9670;&#160;</a></span>freeParticle()</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname">void freeParticle </td>
  194. <td>(</td>
  195. <td class="paramtype"><a class="el" href="struct_particle_system_1_1_particle_node.html">ParticleNode</a> *&#160;</td>
  196. <td class="paramname"><em>pParticleNode</em></td><td>)</td>
  197. <td></td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. </div>
  202. </div>
  203. <a id="a899856192fbbcfc637b18e6a8056db1d" name="a899856192fbbcfc637b18e6a8056db1d"></a>
  204. <h2 class="memtitle"><span class="permalink"><a href="#a899856192fbbcfc637b18e6a8056db1d">&#9670;&#160;</a></span>getActiveParticleCount()</h2>
  205. <div class="memitem">
  206. <div class="memproto">
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <td class="memname">U32 getActiveParticleCount </td>
  213. <td>(</td>
  214. <td class="paramtype">void&#160;</td>
  215. <td class="paramname"></td><td>)</td>
  216. <td> const</td>
  217. </tr>
  218. </table>
  219. </td>
  220. <td class="mlabels-right">
  221. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  222. </tr>
  223. </table>
  224. </div><div class="memdoc">
  225. </div>
  226. </div>
  227. <a id="afac64348326a2ac6927d8b52583fae03" name="afac64348326a2ac6927d8b52583fae03"></a>
  228. <h2 class="memtitle"><span class="permalink"><a href="#afac64348326a2ac6927d8b52583fae03">&#9670;&#160;</a></span>getAllocatedParticleCount()</h2>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="mlabels">
  232. <tr>
  233. <td class="mlabels-left">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">U32 getAllocatedParticleCount </td>
  237. <td>(</td>
  238. <td class="paramtype">void&#160;</td>
  239. <td class="paramname"></td><td>)</td>
  240. <td> const</td>
  241. </tr>
  242. </table>
  243. </td>
  244. <td class="mlabels-right">
  245. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. </div>
  250. </div>
  251. <a id="a7ce0a14b6e7779fbb2d9a05333792c41" name="a7ce0a14b6e7779fbb2d9a05333792c41"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#a7ce0a14b6e7779fbb2d9a05333792c41">&#9670;&#160;</a></span>Init()</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <table class="mlabels">
  256. <tr>
  257. <td class="mlabels-left">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">void Init </td>
  261. <td>(</td>
  262. <td class="paramtype">void&#160;</td>
  263. <td class="paramname"></td><td>)</td>
  264. <td></td>
  265. </tr>
  266. </table>
  267. </td>
  268. <td class="mlabels-right">
  269. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  270. </tr>
  271. </table>
  272. </div><div class="memdoc">
  273. </div>
  274. </div>
  275. <h2 class="groupheader">Member Data Documentation</h2>
  276. <a id="ad28e62c560d6f1975a0b4a90d8fc3463" name="ad28e62c560d6f1975a0b4a90d8fc3463"></a>
  277. <h2 class="memtitle"><span class="permalink"><a href="#ad28e62c560d6f1975a0b4a90d8fc3463">&#9670;&#160;</a></span>Instance</h2>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <table class="mlabels">
  281. <tr>
  282. <td class="mlabels-left">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname"><a class="el" href="class_particle_system.html">ParticleSystem</a> * Instance = NULL</td>
  286. </tr>
  287. </table>
  288. </td>
  289. <td class="mlabels-right">
  290. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. </div>
  295. </div>
  296. <hr/>The documentation for this class was generated from the following files:<ul>
  297. <li>2d/core/<b>ParticleSystem.h</b></li>
  298. <li>2d/core/<b>ParticleSystem.cc</b></li>
  299. </ul>
  300. </div><!-- contents -->
  301. <!-- start footer part -->
  302. <hr class="footer"/><address class="footer"><small>
  303. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  304. </small></address>
  305. </body>
  306. </html>