Sophie

Sophie

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

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: iParticleBuiltinEmitterBase Struct 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>iParticleBuiltinEmitterBase Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iParticleBuiltinEmitterBase" --><!-- doxytag: inherits="iParticleEmitter" --><div class="dynheader">
Inheritance diagram for iParticleBuiltinEmitterBase:</div>
<div class="dynsection">
<p><center><img src="structiParticleBuiltinEmitterBase__inherit__graph.png" border="0" usemap="#iParticleBuiltinEmitterBase__inherit__map" alt="Inheritance graph"></center>
<map name="iParticleBuiltinEmitterBase__inherit__map">
<area shape="rect" href="structiParticleBuiltinEmitterBox.html" title="iParticleBuiltinEmitterBox" alt="" coords="535,5,719,32"><area shape="rect" href="structiParticleBuiltinEmitterCone.html" title="iParticleBuiltinEmitterCone" alt="" coords="529,56,724,83"><area shape="rect" href="structiParticleBuiltinEmitterCylinder.html" title="iParticleBuiltinEmitterCylinder" alt="" coords="520,107,733,133"><area shape="rect" href="structiParticleBuiltinEmitterSphere.html" title="iParticleBuiltinEmitterSphere" alt="" coords="524,157,729,184"><area shape="rect" href="structiParticleEmitter.html" title="A particle emitter." alt="" coords="111,81,231,108"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="5,81,61,108"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiParticleBuiltinEmitterBase-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiParticleBuiltinEmitterBase.html#3578e553ecdfa6aa74e7e99c88fd6eba">GetInitialVelocity</a> (<a class="el" href="classcsVector3.html">csVector3</a> &amp;linear, <a class="el" href="classcsVector3.html">csVector3</a> &amp;angular) const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get velocity for emitted particles.  <a href="#3578e553ecdfa6aa74e7e99c88fd6eba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="group__meshplugins.html#g92a7105932f4383bf09437ccaa2a1c85">csParticleBuiltinEmitterPlacement</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiParticleBuiltinEmitterBase.html#a27357301e1f2538cd351201bceb83c0">GetParticlePlacement</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get particle placement.  <a href="#a27357301e1f2538cd351201bceb83c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiParticleBuiltinEmitterBase.html#51d3156917ef177e47803cc52c20e09f">GetPosition</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get position.  <a href="#51d3156917ef177e47803cc52c20e09f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structiParticleBuiltinEmitterBase.html#95899105882eaa0c1a357ddef01dd249">GetUniformVelocity</a> () const =0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get initial velocity strategy.  <a href="#95899105882eaa0c1a357ddef01dd249"></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="structiParticleBuiltinEmitterBase.html#04891451231a333b28163269c5de2562">SetInitialVelocity</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;linear, const <a class="el" href="classcsVector3.html">csVector3</a> &amp;angular)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set velocity/magnitude for emitted particles.  <a href="#04891451231a333b28163269c5de2562"></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="structiParticleBuiltinEmitterBase.html#0b341dffe471dd08d53cd76c8aab187f">SetParticlePlacement</a> (<a class="el" href="group__meshplugins.html#g92a7105932f4383bf09437ccaa2a1c85">csParticleBuiltinEmitterPlacement</a> place)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set particle placement.  <a href="#0b341dffe471dd08d53cd76c8aab187f"></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="structiParticleBuiltinEmitterBase.html#626ab6780b0327bfc0772c69c41e5d93">SetPosition</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &amp;position)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set position of emitter.  <a href="#626ab6780b0327bfc0772c69c41e5d93"></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="structiParticleBuiltinEmitterBase.html#b2fe190717ce29dbe5af3621be5af40d">SetUniformVelocity</a> (bool uniform)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set initial velocity assignment strategy.  <a href="#b2fe190717ce29dbe5af3621be5af40d"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="particles_8h-source.html#l00529">529</a> of file <a class="el" href="particles_8h-source.html">particles.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3578e553ecdfa6aa74e7e99c88fd6eba"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::GetInitialVelocity" ref="3578e553ecdfa6aa74e7e99c88fd6eba" args="(csVector3 &amp;linear, csVector3 &amp;angular) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iParticleBuiltinEmitterBase::GetInitialVelocity           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>linear</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>angular</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get velocity for emitted particles. 
<p>

</div>
</div><p>
<a class="anchor" name="a27357301e1f2538cd351201bceb83c0"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::GetParticlePlacement" ref="a27357301e1f2538cd351201bceb83c0" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="group__meshplugins.html#g92a7105932f4383bf09437ccaa2a1c85">csParticleBuiltinEmitterPlacement</a> iParticleBuiltinEmitterBase::GetParticlePlacement           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get particle placement. 
<p>

</div>
</div><p>
<a class="anchor" name="51d3156917ef177e47803cc52c20e09f"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::GetPosition" ref="51d3156917ef177e47803cc52c20e09f" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>&amp; iParticleBuiltinEmitterBase::GetPosition           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get position. 
<p>

</div>
</div><p>
<a class="anchor" name="95899105882eaa0c1a357ddef01dd249"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::GetUniformVelocity" ref="95899105882eaa0c1a357ddef01dd249" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool iParticleBuiltinEmitterBase::GetUniformVelocity           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get initial velocity strategy. 
<p>

</div>
</div><p>
<a class="anchor" name="04891451231a333b28163269c5de2562"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::SetInitialVelocity" ref="04891451231a333b28163269c5de2562" args="(const csVector3 &amp;linear, const csVector3 &amp;angular)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iParticleBuiltinEmitterBase::SetInitialVelocity           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>linear</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>angular</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set velocity/magnitude for emitted particles. 
<p>

</div>
</div><p>
<a class="anchor" name="0b341dffe471dd08d53cd76c8aab187f"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::SetParticlePlacement" ref="0b341dffe471dd08d53cd76c8aab187f" args="(csParticleBuiltinEmitterPlacement place)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iParticleBuiltinEmitterBase::SetParticlePlacement           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__meshplugins.html#g92a7105932f4383bf09437ccaa2a1c85">csParticleBuiltinEmitterPlacement</a>&nbsp;</td>
          <td class="paramname"> <em>place</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set particle placement. 
<p>

</div>
</div><p>
<a class="anchor" name="626ab6780b0327bfc0772c69c41e5d93"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::SetPosition" ref="626ab6780b0327bfc0772c69c41e5d93" args="(const csVector3 &amp;position)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iParticleBuiltinEmitterBase::SetPosition           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>position</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set position of emitter. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd>iParticleSystemBase::SetLocalMode </dd></dl>

</div>
</div><p>
<a class="anchor" name="b2fe190717ce29dbe5af3621be5af40d"></a><!-- doxytag: member="iParticleBuiltinEmitterBase::SetUniformVelocity" ref="b2fe190717ce29dbe5af3621be5af40d" args="(bool uniform)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iParticleBuiltinEmitterBase::SetUniformVelocity           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>uniform</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set initial velocity assignment strategy. 
<p>
Uniform velocity means that direction is always "outward pushing" (exactly what that is depends on the shape of the emitter, for example sphere emitter give radial velocity). When using uniform velocity only the magnitude is used from the set velocity vector.<p>
Opposite to uniform is to use a single velocity vector for new particles.<p>
Default should be uniform velocity distribution. 
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="particles_8h-source.html">particles.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>