Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 773

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csNewtonianParticleSystem Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <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>csNewtonianParticleSystem Class Reference<br>
<small>
[<a class="el" href="group__plugincommon.html">Common Plugin Classes</a>]</small>
</h1><!-- doxytag: class="csNewtonianParticleSystem" --><!-- doxytag: inherits="scfImplementationExt0&lt; csNewtonianParticleSystem, csParticleSystem &gt;" -->This class has a set of particles that behave with physics.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="partgen_8h-source.html">csplugincommon/particlesys/partgen.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for csNewtonianParticleSystem:</div>
<div class="dynsection">
<p><center><img src="classcsNewtonianParticleSystem__inherit__graph.png" border="0" usemap="#csNewtonianParticleSystem__inherit__map" alt="Inheritance graph"></center>
<map name="csNewtonianParticleSystem__inherit__map">
<area shape="rect" href="classscfImplementationExt0.html" title="scfImplementationExt0\&lt; csNewtonianParticleSystem, csParticleSystem \&gt;" alt="" coords="1992,107,2496,133"><area shape="rect" href="classcsParticleSystem.html" title="This class represents a particle system." alt="" coords="1811,107,1944,133"><area shape="rect" href="classscfImplementationExt2.html" title="scfImplementationExt2\&lt; csParticleSystem, csObjectModel, iMeshObject, iParticleState \&gt;" alt="" coords="1165,107,1763,133"><area shape="rect" href="classcsObjectModel.html" title="Helper class to make it easier to implement iObjectModel in mesh objects." alt="" coords="1003,56,1117,83"><area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\&lt; csObjectModel, iObjectModel \&gt;" alt="" coords="591,56,953,83"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\&lt; csObjectModel \&gt;" alt="" coords="276,5,540,32"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="88,81,144,108"><area shape="rect" href="structiObjectModel.html" title="This interface represents data related to some geometry in object space." alt="" coords="356,56,460,83"><area shape="rect" href="structiMeshObject.html" title="This is a general mesh object that the engine can interact with." alt="" coords="1011,107,1109,133"><area shape="rect" href="structiParticleState.html" title="This interface describes the API for the particle mesh object." alt="" coords="1007,157,1113,184"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="5,5,227,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classcsNewtonianParticleSystem-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="classcsNewtonianParticleSystem.html#22661e3a2e2e75534d8f5eb31c86d464">csNewtonianParticleSystem</a> (<a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *<a class="el" href="classcsParticleSystem.html#d0eaf4027452133719edd24637d0304f">object_reg</a>, <a class="el" href="structiMeshObjectFactory.html">iMeshObjectFactory</a> *<a class="el" href="classcsParticleSystem.html#7f9c3a76227c84c1a8af27b69a1a79f1">factory</a>)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specify max number of particles.  <a href="#22661e3a2e2e75534d8f5eb31c86d464"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNewtonianParticleSystem.html#48a91f43c15931f641b83f52135e6881">GetAccel</a> (int idx) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a particles acceleration. accelerations are in metres/second.  <a href="#48a91f43c15931f641b83f52135e6881"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNewtonianParticleSystem.html#51766b35969a9d48589329ae14079426">GetSpeed</a> (int idx) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a particles speed. speeds are in metres/second.  <a href="#51766b35969a9d48589329ae14079426"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNewtonianParticleSystem.html#28dd962ac45663237985eec9ef60ccbd">SetAccel</a> (int idx, const <a class="el" href="classcsVector3.html">csVector3</a> &amp;acl)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a particles acceleration. accelerations are in metres/second.  <a href="#28dd962ac45663237985eec9ef60ccbd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNewtonianParticleSystem.html#39839a17e51760fe0d7a98bb2a55190a">SetSpeed</a> (int idx, const <a class="el" href="classcsVector3.html">csVector3</a> &amp;spd)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a particles speed. speeds are in metres/second.  <a href="#39839a17e51760fe0d7a98bb2a55190a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNewtonianParticleSystem.html#c82bc79d6507d855d1a9628fb2dce59f">Update</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> elapsed_time)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves the particles depending on their acceleration and speed.  <a href="#c82bc79d6507d855d1a9628fb2dce59f"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNewtonianParticleSystem.html#cfa134f0336f037e125a20bc3edbcb76">part_accel</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Particle acceleration, m/s^2.  <a href="#cfa134f0336f037e125a20bc3edbcb76"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsVector3.html">csVector3</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsNewtonianParticleSystem.html#2e820855219c2606361a879288eb5387">part_speed</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Particle speed, m/s.  <a href="#2e820855219c2606361a879288eb5387"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class has a set of particles that behave with physics. 
<p>
They each have a speed and an acceleration. 
<p>Definition at line <a class="el" href="partgen_8h-source.html#l00402">402</a> of file <a class="el" href="partgen_8h-source.html">partgen.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="22661e3a2e2e75534d8f5eb31c86d464"></a><!-- doxytag: member="csNewtonianParticleSystem::csNewtonianParticleSystem" ref="22661e3a2e2e75534d8f5eb31c86d464" args="(iObjectRegistry *object_reg, iMeshObjectFactory *factory)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">csNewtonianParticleSystem::csNewtonianParticleSystem           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *&nbsp;</td>
          <td class="paramname"> <em>object_reg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiMeshObjectFactory.html">iMeshObjectFactory</a> *&nbsp;</td>
          <td class="paramname"> <em>factory</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>
Specify max number of particles. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="48a91f43c15931f641b83f52135e6881"></a><!-- doxytag: member="csNewtonianParticleSystem::GetAccel" ref="48a91f43c15931f641b83f52135e6881" args="(int idx) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a>&amp; csNewtonianParticleSystem::GetAccel           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>idx</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a particles acceleration. accelerations are in metres/second. 
<p>

<p>Definition at line <a class="el" href="partgen_8h-source.html#l00429">429</a> of file <a class="el" href="partgen_8h-source.html">partgen.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="51766b35969a9d48589329ae14079426"></a><!-- doxytag: member="csNewtonianParticleSystem::GetSpeed" ref="51766b35969a9d48589329ae14079426" args="(int idx) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a>&amp; csNewtonianParticleSystem::GetSpeed           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>idx</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a particles speed. speeds are in metres/second. 
<p>

<p>Definition at line <a class="el" href="partgen_8h-source.html#l00423">423</a> of file <a class="el" href="partgen_8h-source.html">partgen.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="28dd962ac45663237985eec9ef60ccbd"></a><!-- doxytag: member="csNewtonianParticleSystem::SetAccel" ref="28dd962ac45663237985eec9ef60ccbd" args="(int idx, const csVector3 &amp;acl)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csNewtonianParticleSystem::SetAccel           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>idx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>acl</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set a particles acceleration. accelerations are in metres/second. 
<p>

<p>Definition at line <a class="el" href="partgen_8h-source.html#l00431">431</a> of file <a class="el" href="partgen_8h-source.html">partgen.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="39839a17e51760fe0d7a98bb2a55190a"></a><!-- doxytag: member="csNewtonianParticleSystem::SetSpeed" ref="39839a17e51760fe0d7a98bb2a55190a" args="(int idx, const csVector3 &amp;spd)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void csNewtonianParticleSystem::SetSpeed           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>idx</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>spd</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set a particles speed. speeds are in metres/second. 
<p>

<p>Definition at line <a class="el" href="partgen_8h-source.html#l00425">425</a> of file <a class="el" href="partgen_8h-source.html">partgen.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c82bc79d6507d855d1a9628fb2dce59f"></a><!-- doxytag: member="csNewtonianParticleSystem::Update" ref="c82bc79d6507d855d1a9628fb2dce59f" args="(csTicks elapsed_time)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csNewtonianParticleSystem::Update           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a>&nbsp;</td>
          <td class="paramname"> <em>elapsed_time</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Moves the particles depending on their acceleration and speed. 
<p>

<p>Reimplemented from <a class="el" href="classcsParticleSystem.html#65efacb0fdb7dc112820e2afafb7cb1b">csParticleSystem</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="cfa134f0336f037e125a20bc3edbcb76"></a><!-- doxytag: member="csNewtonianParticleSystem::part_accel" ref="cfa134f0336f037e125a20bc3edbcb76" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a>* <a class="el" href="classcsNewtonianParticleSystem.html#cfa134f0336f037e125a20bc3edbcb76">csNewtonianParticleSystem::part_accel</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Particle acceleration, m/s^2. 
<p>

<p>Definition at line <a class="el" href="partgen_8h-source.html#l00409">409</a> of file <a class="el" href="partgen_8h-source.html">partgen.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2e820855219c2606361a879288eb5387"></a><!-- doxytag: member="csNewtonianParticleSystem::part_speed" ref="2e820855219c2606361a879288eb5387" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classcsVector3.html">csVector3</a>* <a class="el" href="classcsNewtonianParticleSystem.html#2e820855219c2606361a879288eb5387">csNewtonianParticleSystem::part_speed</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Particle speed, m/s. 
<p>

<p>Definition at line <a class="el" href="partgen_8h-source.html#l00407">407</a> of file <a class="el" href="partgen_8h-source.html">partgen.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csplugincommon/particlesys/<a class="el" href="partgen_8h-source.html">partgen.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>