Sophie

Sophie

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

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: iODEDynamicState 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>iODEDynamicState Struct Reference</h1><!-- doxytag: class="iODEDynamicState" --><!-- doxytag: inherits="iBase" -->This class exposes parameters specific to odedynam as an implementation of <a class="el" href="structiDynamics.html" title="This is the interface for the actual plugin.">iDynamics</a>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="ode_8h-source.html">ivaria/ode.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iODEDynamicState:</div>
<div class="dynsection">
<p><center><img src="structiODEDynamicState__inherit__graph.png" border="0" usemap="#iODEDynamicState__inherit__map" alt="Inheritance graph"></center>
<map name="iODEDynamicState__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="51,7,107,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiODEDynamicState-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="structiODEDynamicState.html#41169162a661f217d6be229756c3e35c">EnableEventProcessing</a> (bool enable)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This makes updates happen on the csevPreProcess and invalidates calls to Step() This should be used in conjuction with the FrameRate calls.  <a href="#41169162a661f217d6be229756c3e35c"></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="structiODEDynamicState.html#890c8ec163ec9e052a49393354c080a0">EnableFastObjects</a> (bool enable)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The following enables special robustness checks for fast moving objects to determine if they will tunneling and adjusts the physics frame resolution (rate) to a double for that step (possible doing this recursively down to a potentially infinite resolution for a given step, depending on the speed of the objects being tested) Only enable this if you are experiencing tunneling problems and can't afford to increase the standard FrameRate in the settings above.  <a href="#890c8ec163ec9e052a49393354c080a0"></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="structiODEDynamicState.html#f11be49834acd3e6f443b02dd45b4a3b">EnableFrameRate</a> (bool enable)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The following code enables a constant framerate on processing this means if you set the frame rate to (default) 50 The stepsize passed into Step is treated as the elapsed time in seconds received from the virtual clock GetElapsedTicks.  <a href="#f11be49834acd3e6f443b02dd45b4a3b"></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="structiODEDynamicState.html#7219d10c5e83e672015751cc961df6f3">EnableStepFast</a> (bool enable)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Enables the experimental StepFast code in ode.  <a href="#7219d10c5e83e672015751cc961df6f3"></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="structiODEDynamicState.html#6772f5b405c746bbf7c7345bf2883231">SetGlobalCFM</a> (float cfm)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets ODE's Constraint Force Mixing (see ode docs for details).  <a href="#6772f5b405c746bbf7c7345bf2883231"></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="structiODEDynamicState.html#8fa2f18cffcf44ad930f60b21e0ee73f">SetGlobalERP</a> (float erp)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets ODE's Error Resolution Parameter (see ode docs for details).  <a href="#8fa2f18cffcf44ad930f60b21e0ee73f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class exposes parameters specific to odedynam as an implementation of <a class="el" href="structiDynamics.html" title="This is the interface for the actual plugin.">iDynamics</a>. 
<p>Definition at line <a class="el" href="ode_8h-source.html#l00045">45</a> of file <a class="el" href="ode_8h-source.html">ode.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="41169162a661f217d6be229756c3e35c"></a><!-- doxytag: member="iODEDynamicState::EnableEventProcessing" ref="41169162a661f217d6be229756c3e35c" args="(bool enable)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iODEDynamicState::EnableEventProcessing           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>enable</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This makes updates happen on the csevPreProcess and invalidates calls to Step() This should be used in conjuction with the FrameRate calls. 
<p>

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

<p>
The following enables special robustness checks for fast moving objects to determine if they will tunneling and adjusts the physics frame resolution (rate) to a double for that step (possible doing this recursively down to a potentially infinite resolution for a given step, depending on the speed of the objects being tested) Only enable this if you are experiencing tunneling problems and can't afford to increase the standard FrameRate in the settings above. 
<p>

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

<p>
The following code enables a constant framerate on processing this means if you set the frame rate to (default) 50 The stepsize passed into Step is treated as the elapsed time in seconds received from the virtual clock GetElapsedTicks. 
<p>
The physics will iterate a number of steps at 1/50th of a second until enough time has passed to account for the time Beware the default setting for frame limit is 10, which means if the stepsize passed to Step is longer than 1/10 a second the physics will stop iterating and slow down. Never set this parameter to 0 or else you could incur cycle of death where the number of physics steps increases the amount of elapsed time between frames which increases the number of physics steps toward infinity 
</div>
</div><p>
<a class="anchor" name="7219d10c5e83e672015751cc961df6f3"></a><!-- doxytag: member="iODEDynamicState::EnableStepFast" ref="7219d10c5e83e672015751cc961df6f3" args="(bool enable)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iODEDynamicState::EnableStepFast           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>enable</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Enables the experimental StepFast code in ode. 
<p>

</div>
</div><p>
<a class="anchor" name="6772f5b405c746bbf7c7345bf2883231"></a><!-- doxytag: member="iODEDynamicState::SetGlobalCFM" ref="6772f5b405c746bbf7c7345bf2883231" args="(float cfm)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iODEDynamicState::SetGlobalCFM           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>cfm</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets ODE's Constraint Force Mixing (see ode docs for details). 
<p>

</div>
</div><p>
<a class="anchor" name="8fa2f18cffcf44ad930f60b21e0ee73f"></a><!-- doxytag: member="iODEDynamicState::SetGlobalERP" ref="8fa2f18cffcf44ad930f60b21e0ee73f" args="(float erp)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iODEDynamicState::SetGlobalERP           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>erp</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Sets ODE's Error Resolution Parameter (see ode docs for details). 
<p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="ode_8h-source.html">ode.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>