<!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: iSprite2DUVAnimation 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>iSprite2DUVAnimation Struct Reference<br>
<small>
[<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small>
</h1><!-- doxytag: class="iSprite2DUVAnimation" --><!-- doxytag: inherits="iBase" -->The animation works by having all frames of an animation sequence in a texture at different (u,v) locations, hence the name.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="sprite2d_8h-source.html">imesh/sprite2d.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSprite2DUVAnimation:</div>
<div class="dynsection">
<p><center><img src="structiSprite2DUVAnimation__inherit__graph.png" border="0" usemap="#iSprite2DUVAnimation__inherit__map" alt="Inheritance graph"></center>
<map name="iSprite2DUVAnimation__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="60,7,116,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiSprite2DUVAnimation-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 <br>
<a class="el" href="structiSprite2DUVAnimationFrame.html">iSprite2DUVAnimationFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSprite2DUVAnimation.html#64d438c46eeb342c9c1f880bca39df8f">CreateFrame</a> (int idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new frame that will be inserted before the idx'th frame. <a href="#64d438c46eeb342c9c1f880bca39df8f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiSprite2DUVAnimationFrame.html">iSprite2DUVAnimationFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSprite2DUVAnimation.html#f98be628ce09c91a3422ed07b206ffe9">GetFrame</a> (const char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the frame name in the animation. <a href="#f98be628ce09c91a3422ed07b206ffe9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <br>
<a class="el" href="structiSprite2DUVAnimationFrame.html">iSprite2DUVAnimationFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSprite2DUVAnimation.html#16582f5f22d733d7401f82fe2c9d3b7f">GetFrame</a> (int idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the idx'th frame in the animation. <a href="#16582f5f22d733d7401f82fe2c9d3b7f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSprite2DUVAnimation.html#99e6b07d24efed8ca7085e3ac1c026f4">GetFrameCount</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the number of frames in this animation. <a href="#99e6b07d24efed8ca7085e3ac1c026f4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSprite2DUVAnimation.html#b8ffbe9d21370d3221ff568de7fc3489">GetName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return the name of this sequence. <a href="#b8ffbe9d21370d3221ff568de7fc3489"></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="structiSprite2DUVAnimation.html#9abb5d0fd3cdc9dd415464728ebafc99">MoveFrame</a> (int frame, int idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the frame'th frame before the idx'th frame. <a href="#9abb5d0fd3cdc9dd415464728ebafc99"></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="structiSprite2DUVAnimation.html#a0ce8606892269d605b57e28504a8082">RemoveFrame</a> (int idx)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the idx'th from the animation. <a href="#a0ce8606892269d605b57e28504a8082"></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="structiSprite2DUVAnimation.html#3b9b447adc59726fe98f58c62b01765e">SetName</a> (const char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Give this sequence a name. <a href="#3b9b447adc59726fe98f58c62b01765e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The animation works by having all frames of an animation sequence in a texture at different (u,v) locations, hence the name.
<p>
So it is basically a set of (u,v) coordinates plus a duration number. for every frame.
<p>Definition at line <a class="el" href="sprite2d_8h-source.html#l00122">122</a> of file <a class="el" href="sprite2d_8h-source.html">sprite2d.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="64d438c46eeb342c9c1f880bca39df8f"></a><!-- doxytag: member="iSprite2DUVAnimation::CreateFrame" ref="64d438c46eeb342c9c1f880bca39df8f" args="(int idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiSprite2DUVAnimationFrame.html">iSprite2DUVAnimationFrame</a>* iSprite2DUVAnimation::CreateFrame </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a new frame that will be inserted before the idx'th frame.
<p>
Set `idx' to -1 to append the frame to the sequence.
</div>
</div><p>
<a class="anchor" name="f98be628ce09c91a3422ed07b206ffe9"></a><!-- doxytag: member="iSprite2DUVAnimation::GetFrame" ref="f98be628ce09c91a3422ed07b206ffe9" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiSprite2DUVAnimationFrame.html">iSprite2DUVAnimationFrame</a>* iSprite2DUVAnimation::GetFrame </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the frame name in the animation.
<p>
</div>
</div><p>
<a class="anchor" name="16582f5f22d733d7401f82fe2c9d3b7f"></a><!-- doxytag: member="iSprite2DUVAnimation::GetFrame" ref="16582f5f22d733d7401f82fe2c9d3b7f" args="(int idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiSprite2DUVAnimationFrame.html">iSprite2DUVAnimationFrame</a>* iSprite2DUVAnimation::GetFrame </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the idx'th frame in the animation.
<p>
Set idx to -1 to get the current to be played.
</div>
</div><p>
<a class="anchor" name="99e6b07d24efed8ca7085e3ac1c026f4"></a><!-- doxytag: member="iSprite2DUVAnimation::GetFrameCount" ref="99e6b07d24efed8ca7085e3ac1c026f4" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iSprite2DUVAnimation::GetFrameCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the number of frames in this animation.
<p>
</div>
</div><p>
<a class="anchor" name="b8ffbe9d21370d3221ff568de7fc3489"></a><!-- doxytag: member="iSprite2DUVAnimation::GetName" ref="b8ffbe9d21370d3221ff568de7fc3489" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* iSprite2DUVAnimation::GetName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
return the name of this sequence.
<p>
</div>
</div><p>
<a class="anchor" name="9abb5d0fd3cdc9dd415464728ebafc99"></a><!-- doxytag: member="iSprite2DUVAnimation::MoveFrame" ref="9abb5d0fd3cdc9dd415464728ebafc99" args="(int frame, int idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSprite2DUVAnimation::MoveFrame </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>frame</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idx</em></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>
Move the frame'th frame before the idx'th frame.
<p>
Set idx to -1 to move the frame to the end of the sequence.
</div>
</div><p>
<a class="anchor" name="a0ce8606892269d605b57e28504a8082"></a><!-- doxytag: member="iSprite2DUVAnimation::RemoveFrame" ref="a0ce8606892269d605b57e28504a8082" args="(int idx)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSprite2DUVAnimation::RemoveFrame </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>idx</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove the idx'th from the animation.
<p>
</div>
</div><p>
<a class="anchor" name="3b9b447adc59726fe98f58c62b01765e"></a><!-- doxytag: member="iSprite2DUVAnimation::SetName" ref="3b9b447adc59726fe98f58c62b01765e" args="(const char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSprite2DUVAnimation::SetName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Give this sequence a name.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>imesh/<a class="el" href="sprite2d_8h-source.html">sprite2d.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
>
3774
