145 lines
9.0 KiB
HTML
145 lines
9.0 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
|
|
<title>ege Library</title>
|
|
<link rel="stylesheet" href="base.css">
|
|
<link rel="stylesheet" href="menu.css">
|
|
</head>
|
|
<body>
|
|
<div class="navbar navbar-fixed-top">
|
|
<div class="container">
|
|
<h1><a href="index.html">ege library</a></h1>
|
|
<h4><a href="http://github.com/heeroyui/ege/"> [ sources ]</a></h4>
|
|
<h3>API:</h3> <div id="menu">
|
|
<ul class="niveau1">
|
|
<li class="sousmenu"><a href="namespace_ege.html">ege</a>
|
|
<ul class="niveau2">
|
|
<li><a href="namespace_ege__collision.html">collision</a>
|
|
</li>
|
|
<li><a href="namespace_ege__widget.html">widget</a>
|
|
</li>
|
|
<li><a href="namespace_ege__resource.html">resource</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<br/><h3>Associate libraries:</h3><div id="menu">
|
|
<ul class="niveau1"><li><a href="../ewol/index.html">ewol</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../ejson/index.html">ejson</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../egami/index.html">egami</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../esvg/index.html">esvg</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../etk/index.html">etk</a></li>
|
|
</ul><ul class="niveau1"><li><a href="../exml/index.html">exml</a></li>
|
|
</ul></div>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
<br/>
|
|
</div>
|
|
</div>
|
|
<div class="container" id="content">
|
|
<h1>class: ege::Particule</h1><hr/><h2>Description:</h2>
|
|
The particule class is an element with no control, when it will be created,
|
|
it does not have any control, for example smoke or reactor generation ...
|
|
or explosion particule ...<br/><br/>
|
|
<h2>Constructor and Destructor:</h2>
|
|
<pre>
|
|
+ <a class="code-function" href="#6263">Particule</a> (<a class="code-type" href="class_ege__ParticuleEngine.html">ege::ParticuleEngine</a> & <span class="code-argument">_particuleEngine</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_particuleType</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <a class="code-function" href="#6266">~Particule</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Synopsis:</h2>
|
|
<pre>
|
|
# <a class="code-type" href="class_ege__ParticuleEngine.html">ege::ParticuleEngine</a> & <a class="code-member" href="#6261">m_particuleEngine</a>;<br/># <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <a class="code-member" href="#6262">m_particuleType</a>;<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6268">init</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6270">UnInit</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6272">update</a> (<span class="code-type" >float</span> <span class="code-argument">_delta</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6274">draw</a> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ege__Camera.html">ege::Camera</a> & <span class="code-argument">_camera</span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <a class="code-function" href="#6276">needRemove</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <a class="code-function" href="#6278">getParticuleType</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/>+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <a class="code-function" href="#6280">onEnd</a> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
<br/>
|
|
<h2>Detail:</h2>
|
|
<a id="6261"/><a id="6262"/><h3>m_particuleEngine</h3><pre>
|
|
# <a class="code-type" href="class_ege__ParticuleEngine.html">ege::ParticuleEngine</a> & <span class="code-member">m_particuleEngine</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6263"/><h3>m_particuleType</h3><pre>
|
|
# <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-member">m_particuleType</span>;<br/></pre>
|
|
|
|
<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6266"/><h3>Particule</h3><pre>
|
|
+ <span class="code-function">Particule</span> (<a class="code-type" href="class_ege__ParticuleEngine.html">ege::ParticuleEngine</a> & <span class="code-argument">_particuleEngine</span>,<br/> <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-argument">_particuleType</span>);<br/></pre>
|
|
Constructor.<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_particuleEngine</span> </td><td> reference on the particule engine ...</td></tr>
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_particuleType</span> </td><td> Type of the particule (set NULL if you did not want to use the respowner ...)</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6268"/><h3>~Particule</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-function">~Particule</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Destructor.<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6270"/><h3>init</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">init</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
init the particule<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6272"/><h3>UnInit</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">UnInit</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Un-init the particule<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6274"/><h3>update</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">update</span> (<span class="code-type" >float</span> <span class="code-argument">_delta</span>);<br/></pre>
|
|
update the paticule properties<br/><ul>
|
|
<table class="parameter-list">
|
|
<td><b>Parameter [input]:</b></td><td><span class="code-argument">_delta</span> </td><td> Delta time from the previous call</td></tr>
|
|
</table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6276"/><h3>draw</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">draw</span> (<span class="code-storage-keyword">const</span> <a class="code-type" href="class_ege__Camera.html">ege::Camera</a> & <span class="code-argument">_camera</span>);<br/></pre>
|
|
draw the current particule<br/>
|
|
<br/>
|
|
<hr/>
|
|
<a id="6278"/><h3>needRemove</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >bool</span> <span class="code-function">needRemove</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
Check if the element might be removed<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>true : The element might be removed<br/>false : The element might be keeped</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<a id="6280"/><h3>getParticuleType</h3><pre>
|
|
+ <span class="code-storage-keyword">const</span> <span class="code-type" >char</span>* <span class="code-function">getParticuleType</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
get the type of the particule<br/><ul>
|
|
<table class="parameter-list">
|
|
<tr><td><b>Return: </b></td><td></td><td>Type of the current particule</td></tr></table>
|
|
</ul>
|
|
|
|
<br/>
|
|
<hr/>
|
|
<h3>onEnd</h3><pre>
|
|
+ <span class="code-storage-keyword">virtual</span> <span class="code-type" >void</span> <span class="code-function">onEnd</span> (<span class="code-type" >void</span> <span class="code-argument"></span>);<br/></pre>
|
|
When the particule arrive to his end of life, this function is called.<br/>
|
|
<br/>
|
|
<hr/>
|
|
</div>
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-46753803-1', 'heeroyui.github.io');
|
|
ga('send', 'pageview');
|
|
</script>
|
|
</body>
|
|
</html>
|