Mahtan/wagic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
wagic/JGE/docs/html/class_j_particle_effect.html
wagic.the.homebrew d45e3b101b
2008-11-02 09:50:16 +00:00

384 lines
15 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>JGE++: JParticleEffect Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>JParticleEffect Class Reference</h1><!-- doxytag: class="JParticleEffect" --><code>#include &lt;JParticleEffect.h&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for JParticleEffect:</div>
<div class="dynsection">
</div>
<p>
<a href="class_j_particle_effect-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#ec75fff60b7ef84ce143c58ebe74e509">JParticleEffect</a> (JResourceManager *mgr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#2128b89bfad041c99d8e76d4652da4cd">Load</a> (const char *filename)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#f6380ba4a767d8c5361adf13e2b29953">Update</a> (float dt)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#5dae1b5a9293ca1c99fcca4f0d92563f">Render</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#2ec1d1293e5972061e8ad42a0531e2ad">Done</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#34ed89b7d648d36adf0a34de9ac7a4ba">Start</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#6e164520da4d5b7408edb2643c97f4e2">Stop</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#7418e1649d5a971b2bdd4b00da5e2005">SetParticleSystem</a> (<a class="el" href="class_j_particle_system.html">JParticleSystem</a> *particleSys)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_j_particle_system.html">JParticleSystem</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#a3af576c03833f9a12cd6801791d13ce">GetParticleSystem</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#6c7c4e4a03188ddd93256fe9e9957264">SetPosition</a> (float x, float y)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#ae3f1bf17ba966bd092248fd3dda633a">GetX</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#b6be7b9294f956a2de91212c963294b7">GetY</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_particle_effect.html#2506cbba7549ec2e2aec3b1959013856">MoveTo</a> (float x, float y)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Particle effect. Each particle effect can contain one or more emitters. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="ec75fff60b7ef84ce143c58ebe74e509"></a><!-- doxytag: member="JParticleEffect::JParticleEffect" ref="ec75fff60b7ef84ce143c58ebe74e509" args="(JResourceManager *mgr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JParticleEffect::JParticleEffect </td>
<td>(</td>
<td class="paramtype">JResourceManager *&nbsp;</td>
<td class="paramname"> <em>mgr</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mgr</em>&nbsp;</td><td>- Resource manager for retrieving image quads for the particles. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2128b89bfad041c99d8e76d4652da4cd"></a><!-- doxytag: member="JParticleEffect::Load" ref="2128b89bfad041c99d8e76d4652da4cd" args="(const char *filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JParticleEffect::Load </td>
<td>(</td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>filename</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load effect from file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>- Name of effect file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f6380ba4a767d8c5361adf13e2b29953"></a><!-- doxytag: member="JParticleEffect::Update" ref="f6380ba4a767d8c5361adf13e2b29953" args="(float dt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleEffect::Update </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>dt</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update particle effect.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dt</em>&nbsp;</td><td>- Time elapsed since last update (in second). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5dae1b5a9293ca1c99fcca4f0d92563f"></a><!-- doxytag: member="JParticleEffect::Render" ref="5dae1b5a9293ca1c99fcca4f0d92563f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleEffect::Render </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Render particle effect.
</div>
</div><p>
<a class="anchor" name="2ec1d1293e5972061e8ad42a0531e2ad"></a><!-- doxytag: member="JParticleEffect::Done" ref="2ec1d1293e5972061e8ad42a0531e2ad" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JParticleEffect::Done </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the particle effect is finished.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if done. </dd></dl>
</div>
</div><p>
<a class="anchor" name="34ed89b7d648d36adf0a34de9ac7a4ba"></a><!-- doxytag: member="JParticleEffect::Start" ref="34ed89b7d648d36adf0a34de9ac7a4ba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleEffect::Start </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start playing.
</div>
</div><p>
<a class="anchor" name="6e164520da4d5b7408edb2643c97f4e2"></a><!-- doxytag: member="JParticleEffect::Stop" ref="6e164520da4d5b7408edb2643c97f4e2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleEffect::Stop </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop playing.
</div>
</div><p>
<a class="anchor" name="7418e1649d5a971b2bdd4b00da5e2005"></a><!-- doxytag: member="JParticleEffect::SetParticleSystem" ref="7418e1649d5a971b2bdd4b00da5e2005" args="(JParticleSystem *particleSys)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleEffect::SetParticleSystem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_j_particle_system.html">JParticleSystem</a> *&nbsp;</td>
<td class="paramname"> <em>particleSys</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set particle system.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>particleSys</em>&nbsp;</td><td>- Particle system. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a3af576c03833f9a12cd6801791d13ce"></a><!-- doxytag: member="JParticleEffect::GetParticleSystem" ref="a3af576c03833f9a12cd6801791d13ce" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_j_particle_system.html">JParticleSystem</a>* JParticleEffect::GetParticleSystem </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get particle system.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Particle system. </dd></dl>
</div>
</div><p>
<a class="anchor" name="6c7c4e4a03188ddd93256fe9e9957264"></a><!-- doxytag: member="JParticleEffect::SetPosition" ref="6c7c4e4a03188ddd93256fe9e9957264" args="(float x, float y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleEffect::SetPosition </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set position of the effect. New particles will be emitted from the new position but the existing active particles will not be affected.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>- X screen position. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>- Y screen position. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ae3f1bf17ba966bd092248fd3dda633a"></a><!-- doxytag: member="JParticleEffect::GetX" ref="ae3f1bf17ba966bd092248fd3dda633a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JParticleEffect::GetX </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get X position.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>X position. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b6be7b9294f956a2de91212c963294b7"></a><!-- doxytag: member="JParticleEffect::GetY" ref="b6be7b9294f956a2de91212c963294b7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float JParticleEffect::GetY </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get Y position.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Y position. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2506cbba7549ec2e2aec3b1959013856"></a><!-- doxytag: member="JParticleEffect::MoveTo" ref="2506cbba7549ec2e2aec3b1959013856" args="(float x, float y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleEffect::MoveTo </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the particle effect over to a new position. All the existing particles will be moved relatively.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>X</em>&nbsp;</td><td>- X screen position. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>- Y screen position. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 22 00:28:22 2007 for JGE++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink