<!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: iSequence 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iSequence Struct Reference</h1><!-- doxytag: class="iSequence" --><!-- doxytag: inherits="iBase" -->A sequence of operations tagged with relative time information.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="sequence_8h-source.html">ivaria/sequence.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSequence:</div>
<div class="dynsection">
<p><center><img src="structiSequence__inherit__graph.png" border="0" usemap="#iSequence__inherit__map" alt="Inheritance graph"></center>
<map name="iSequence__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="21,7,77,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiSequence-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSequence.html#72b9e0c68e2cf8dc0790dacaa43d7499">AddCondition</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> time, <a class="el" href="structiSequenceCondition.html">iSequenceCondition</a> *condition, <a class="el" href="structiSequence.html">iSequence</a> *trueSequence, <a class="el" href="structiSequence.html">iSequence</a> *falseSequence, <a class="el" href="structiBase.html">iBase</a> *params=0, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> sequence_id=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a standard operation to perform a condition and execute the right sequence depending on the result. <a href="#72b9e0c68e2cf8dc0790dacaa43d7499"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSequence.html#6235199c95de0e37a2eecbb7f6023ae4">AddLoop</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> time, <a class="el" href="structiSequenceCondition.html">iSequenceCondition</a> *condition, <a class="el" href="structiSequence.html">iSequence</a> *sequence, <a class="el" href="structiBase.html">iBase</a> *params=0, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> sequence_id=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform the sequence for as long as the condition is valid. <a href="#6235199c95de0e37a2eecbb7f6023ae4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSequence.html#9815fcc0e9b612a268a16540d279c60b">AddOperation</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> time, <a class="el" href="structiSequenceOperation.html">iSequenceOperation</a> *operation, <a class="el" href="structiBase.html">iBase</a> *params=0, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> sequence_id=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an operation to this sequence. <a href="#9815fcc0e9b612a268a16540d279c60b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSequence.html#5b0a17f9d80269100f7c831ca532b5de">AddRunSequence</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> time, <a class="el" href="structiSequence.html">iSequence</a> *sequence, <a class="el" href="structiBase.html">iBase</a> *params=0, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> sequence_id=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a standard operation to execute another sequence. <a href="#5b0a17f9d80269100f7c831ca532b5de"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSequence.html#8c5472743b56446b8d0122306ad393fd">Clear</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear all operations in this sequence (call <a class="el" href="structiBase.html#3a44d46ca155e6ab0c0179db01011bb0" title="Decrement the reference count.">DecRef()</a>). <a href="#8c5472743b56446b8d0122306ad393fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structcsSequenceOp.html">csSequenceOp</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSequence.html#cb02ed2752044b3957f40d2d661751f6">GetFirstSequence</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ugly but necessary for sequence to self-modify. <a href="#cb02ed2752044b3957f40d2d661751f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSequence.html#a493f3372a7ab9c772c1c45c433f9489">IsEmpty</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if this sequence is empty. <a href="#a493f3372a7ab9c772c1c45c433f9489"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A sequence of operations tagged with relative time information.
<p>
All operations added to this sequence will be executed relative to the time the sequence itself is executed. The execute order of operations added at the same relative time is undefined.<p>
Main creators of instances implementing this interface:<ul>
<li><a class="el" href="structiSequenceManager.html#69d23730f8a8de4c409000a13862bc6a" title="Create a new empty sequence.">iSequenceManager::NewSequence()</a></li></ul>
<p>
Main users of this interface:<ul>
<li><a class="el" href="structiSequenceManager.html" title="The sequence manager.">iSequenceManager</a> </li></ul>
<p>Definition at line <a class="el" href="sequence_8h-source.html#l00113">113</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="72b9e0c68e2cf8dc0790dacaa43d7499"></a><!-- doxytag: member="iSequence::AddCondition" ref="72b9e0c68e2cf8dc0790dacaa43d7499" args="(csTicks time, iSequenceCondition *condition, iSequence *trueSequence, iSequence *falseSequence, iBase *params=0, uint sequence_id=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSequence::AddCondition </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiSequenceCondition.html">iSequenceCondition</a> * </td>
<td class="paramname"> <em>condition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiSequence.html">iSequence</a> * </td>
<td class="paramname"> <em>trueSequence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiSequence.html">iSequence</a> * </td>
<td class="paramname"> <em>falseSequence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiBase.html">iBase</a> * </td>
<td class="paramname"> <em>params</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>sequence_id</em> = <code>0</code></td><td> </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>
Add a standard operation to perform a condition and execute the right sequence depending on the result.
<p>
This function will call <a class="el" href="structiBase.html#426a2763702fbbc33a213f849042284a" title="Increment the number of references to this object.">IncRef()</a> on the condition, but NOT on the sequences.
</div>
</div><p>
<a class="anchor" name="6235199c95de0e37a2eecbb7f6023ae4"></a><!-- doxytag: member="iSequence::AddLoop" ref="6235199c95de0e37a2eecbb7f6023ae4" args="(csTicks time, iSequenceCondition *condition, iSequence *sequence, iBase *params=0, uint sequence_id=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSequence::AddLoop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiSequenceCondition.html">iSequenceCondition</a> * </td>
<td class="paramname"> <em>condition</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiSequence.html">iSequence</a> * </td>
<td class="paramname"> <em>sequence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiBase.html">iBase</a> * </td>
<td class="paramname"> <em>params</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>sequence_id</em> = <code>0</code></td><td> </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>
Perform the sequence for as long as the condition is valid.
<p>
This function will call <a class="el" href="structiBase.html#426a2763702fbbc33a213f849042284a" title="Increment the number of references to this object.">IncRef()</a> on the condition, but NOT on the sequence.
</div>
</div><p>
<a class="anchor" name="9815fcc0e9b612a268a16540d279c60b"></a><!-- doxytag: member="iSequence::AddOperation" ref="9815fcc0e9b612a268a16540d279c60b" args="(csTicks time, iSequenceOperation *operation, iBase *params=0, uint sequence_id=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSequence::AddOperation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiSequenceOperation.html">iSequenceOperation</a> * </td>
<td class="paramname"> <em>operation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiBase.html">iBase</a> * </td>
<td class="paramname"> <em>params</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>sequence_id</em> = <code>0</code></td><td> </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>
Add an operation to this sequence.
<p>
This function will call <a class="el" href="structiBase.html#426a2763702fbbc33a213f849042284a" title="Increment the number of references to this object.">IncRef()</a> on the operation.
</div>
</div><p>
<a class="anchor" name="5b0a17f9d80269100f7c831ca532b5de"></a><!-- doxytag: member="iSequence::AddRunSequence" ref="5b0a17f9d80269100f7c831ca532b5de" args="(csTicks time, iSequence *sequence, iBase *params=0, uint sequence_id=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSequence::AddRunSequence </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiSequence.html">iSequence</a> * </td>
<td class="paramname"> <em>sequence</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiBase.html">iBase</a> * </td>
<td class="paramname"> <em>params</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>sequence_id</em> = <code>0</code></td><td> </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>
Add a standard operation to execute another sequence.
<p>
This function will NOT call <a class="el" href="structiBase.html#426a2763702fbbc33a213f849042284a" title="Increment the number of references to this object.">IncRef()</a> on the sequence.
</div>
</div><p>
<a class="anchor" name="8c5472743b56446b8d0122306ad393fd"></a><!-- doxytag: member="iSequence::Clear" ref="8c5472743b56446b8d0122306ad393fd" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSequence::Clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear all operations in this sequence (call <a class="el" href="structiBase.html#3a44d46ca155e6ab0c0179db01011bb0" title="Decrement the reference count.">DecRef()</a>).
<p>
</div>
</div><p>
<a class="anchor" name="cb02ed2752044b3957f40d2d661751f6"></a><!-- doxytag: member="iSequence::GetFirstSequence" ref="cb02ed2752044b3957f40d2d661751f6" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structcsSequenceOp.html">csSequenceOp</a>* iSequence::GetFirstSequence </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ugly but necessary for sequence to self-modify.
<p>
</div>
</div><p>
<a class="anchor" name="a493f3372a7ab9c772c1c45c433f9489"></a><!-- doxytag: member="iSequence::IsEmpty" ref="a493f3372a7ab9c772c1c45c433f9489" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iSequence::IsEmpty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if this sequence is empty.
<p>
</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3595
