Sophie

Sophie

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

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: iSequenceOperation 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>iSequenceOperation Struct Reference</h1><!-- doxytag: class="iSequenceOperation" --><!-- doxytag: inherits="iBase" -->A sequence operation.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sequence_8h-source.html">ivaria/sequence.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for iSequenceOperation:</div>
<div class="dynsection">
<p><center><img src="structiSequenceOperation__inherit__graph.png" border="0" usemap="#iSequenceOperation__inherit__map" alt="Inheritance graph"></center>
<map name="iSequenceOperation__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="53,7,109,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="structiSequenceOperation-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="structiSequenceOperation.html#7988ce03e8d1cb3c4babce0f576a612c">CleanupSequences</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This routine is responsible for forcibly cleaning up all references to sequences.  <a href="#7988ce03e8d1cb3c4babce0f576a612c"></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="structiSequenceOperation.html#b83cb1989dc0fd8540dee3b15fad1141">Do</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> dt, <a class="el" href="structiBase.html">iBase</a> *params)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Do the operation.  <a href="#b83cb1989dc0fd8540dee3b15fad1141"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A sequence operation. 
<p>
This is effectively a callback to the application.<p>
Main creators of instances implementing this interface:<ul>
<li>Application using the sequence manager.</li></ul>
<p>
Main users of this interface:<ul>
<li><a class="el" href="structiSequence.html" title="A sequence of operations tagged with relative time information.">iSequence</a> </li></ul>

<p>Definition at line <a class="el" href="sequence_8h-source.html#l00039">39</a> of file <a class="el" href="sequence_8h-source.html">sequence.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7988ce03e8d1cb3c4babce0f576a612c"></a><!-- doxytag: member="iSequenceOperation::CleanupSequences" ref="7988ce03e8d1cb3c4babce0f576a612c" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iSequenceOperation::CleanupSequences           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This routine is responsible for forcibly cleaning up all references to sequences. 
<p>
It is called when the sequence manager is destructed. 
</div>
</div><p>
<a class="anchor" name="b83cb1989dc0fd8540dee3b15fad1141"></a><!-- doxytag: member="iSequenceOperation::Do" ref="b83cb1989dc0fd8540dee3b15fad1141" args="(csTicks dt, iBase *params)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void iSequenceOperation::Do           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a>&nbsp;</td>
          <td class="paramname"> <em>dt</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structiBase.html">iBase</a> *&nbsp;</td>
          <td class="paramname"> <em>params</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>
Do the operation. 
<p>
The dt parameter is the difference between the time the sequence manager is at now and the time this operation was supposed to happen. If this is 0 then the operation is called at the right time. If this is 1000 (for example) then the operation was called one second late. This latency can happen because the sequence manager only kicks in every frame and frame rate can be low. 
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="sequence_8h-source.html">sequence.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>