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

228 lines
9.3 KiB
HTML
Raw 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++: JParticleSystem 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>JParticleSystem Class Reference</h1><!-- doxytag: class="JParticleSystem" --><code>#include &lt;JParticleSystem.h&gt;</code>
<p>
<p>
<a href="class_j_particle_system-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_system.html#2f8f8a761101a5c3efe1e5b12f6561c5">JParticleSystem</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_system.html#ce628a48005138470fe8221626b0efbc">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_system.html#e4a17a504169691ed7dd1c1a61a5e61f">Render</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_system.html#40b878540db14c17fa16c680c97e75d8">StartEffect</a> (<a class="el" href="class_j_particle_effect.html">JParticleEffect</a> *effect)</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_system.html#4dd0ce60b2f10065e403a799ec67759e">StopAllEffects</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_system.html#5eb53349303735503a84593f164e0a70">ClearAll</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_system.html#3cd01677ef7dec291536d1fa2ed7d481">IsActive</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_system.html#a83ff57fcfa408e129456597eed0922e">SetActive</a> (bool flag)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The particle system of JGE++ is built on a key frame concept with multiple emitters for each effect. It's inspired by the particle system of Torque Game Builder. At each key frame, you can specify the value of the changeable states of the particle. This gives you lots of control over the particles and making it possible to create almost all of the spectacular effects out of your imagination. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="2f8f8a761101a5c3efe1e5b12f6561c5"></a><!-- doxytag: member="JParticleSystem::JParticleSystem" ref="2f8f8a761101a5c3efe1e5b12f6561c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JParticleSystem::JParticleSystem </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ce628a48005138470fe8221626b0efbc"></a><!-- doxytag: member="JParticleSystem::Update" ref="ce628a48005138470fe8221626b0efbc" args="(float dt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleSystem::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 all active effects.<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>- Delta time since last update (in second). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e4a17a504169691ed7dd1c1a61a5e61f"></a><!-- doxytag: member="JParticleSystem::Render" ref="e4a17a504169691ed7dd1c1a61a5e61f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleSystem::Render </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Render all active effects.
</div>
</div><p>
<a class="anchor" name="40b878540db14c17fa16c680c97e75d8"></a><!-- doxytag: member="JParticleSystem::StartEffect" ref="40b878540db14c17fa16c680c97e75d8" args="(JParticleEffect *effect)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleSystem::StartEffect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_j_particle_effect.html">JParticleEffect</a> *&nbsp;</td>
<td class="paramname"> <em>effect</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start an 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>effect</em>&nbsp;</td><td>- Effect to start playing. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4dd0ce60b2f10065e403a799ec67759e"></a><!-- doxytag: member="JParticleSystem::StopAllEffects" ref="4dd0ce60b2f10065e403a799ec67759e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleSystem::StopAllEffects </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop all effects.
</div>
</div><p>
<a class="anchor" name="5eb53349303735503a84593f164e0a70"></a><!-- doxytag: member="JParticleSystem::ClearAll" ref="5eb53349303735503a84593f164e0a70" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleSystem::ClearAll </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete all effects from memory.
</div>
</div><p>
<a class="anchor" name="3cd01677ef7dec291536d1fa2ed7d481"></a><!-- doxytag: member="JParticleSystem::IsActive" ref="3cd01677ef7dec291536d1fa2ed7d481" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JParticleSystem::IsActive </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 system is active or not.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if active. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a83ff57fcfa408e129456597eed0922e"></a><!-- doxytag: member="JParticleSystem::SetActive" ref="a83ff57fcfa408e129456597eed0922e" args="(bool flag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JParticleSystem::SetActive </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>flag</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set active flag.<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>flag</em>&nbsp;</td><td>- Active flag. </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