<!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: csAnimationTemplate Class 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>csAnimationTemplate Class Reference</h1><!-- doxytag: class="csAnimationTemplate" -->A 2d animation template. This class is used to create animated pixmaps.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csanim2d_8h-source.html">cstool/csanim2d.h</a>></code>
<p>
<p>
<a href="classcsAnimationTemplate-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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#4093c9097566a8e7fb9c13eef340b21f">AddFrame</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> Delay, <a class="el" href="structiTextureHandle.html">iTextureHandle</a> *Tex, int x, int y, int w, int h)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">add a frame (giving the length of this frame) <a href="#4093c9097566a8e7fb9c13eef340b21f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#d9ccf58a0daed803f9086e06413ca14d">AddFrame</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> Delay, <a class="el" href="structiTextureHandle.html">iTextureHandle</a> *Tex)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">add a frame (giving the length of this frame) <a href="#d9ccf58a0daed803f9086e06413ca14d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#fbdf45ab108795a7c2ea68a6965545da">AddFrame</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> Delay, <a class="el" href="classcsPixmap.html">csPixmap</a> *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">add a frame. (giving the length of this frame) <a href="#fbdf45ab108795a7c2ea68a6965545da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsAnimatedPixmap.html">csAnimatedPixmap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#58f31d8a2c1947f3bde10561e27b2cf5">CreateInstance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create an instance of this animation <a href="#58f31d8a2c1947f3bde10561e27b2cf5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#4a4178128d922b8b46540f3a1441d3ff">csAnimationTemplate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">build a new animation <a href="#4a4178128d922b8b46540f3a1441d3ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsPixmap.html">csPixmap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#27d3cf5d62360840c43aed5f04241dc5">GetFrame</a> (size_t n) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a frame by number <a href="#27d3cf5d62360840c43aed5f04241dc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsPixmap.html">csPixmap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#a4bedc3dae27c886edcad843c7bc258d">GetFrameByTime</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> Time)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a frame by time <a href="#a4bedc3dae27c886edcad843c7bc258d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#10dc2ab6a572ad39f4a8d9e3c7b9704c">GetFrameCount</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get number of frames <a href="#10dc2ab6a572ad39f4a8d9e3c7b9704c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#d6aafce70936077881ca5586f3e38846">GetLength</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get total length of animation (all delays added together) <a href="#d6aafce70936077881ca5586f3e38846"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimationTemplate.html#c74b84885cee40083ac50ea7c5e9f50f">~csAnimationTemplate</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">destructor <a href="#c74b84885cee40083ac50ea7c5e9f50f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A 2d animation template. This class is used to create animated pixmaps.
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00040">40</a> of file <a class="el" href="csanim2d_8h-source.html">csanim2d.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="4a4178128d922b8b46540f3a1441d3ff"></a><!-- doxytag: member="csAnimationTemplate::csAnimationTemplate" ref="4a4178128d922b8b46540f3a1441d3ff" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csAnimationTemplate::csAnimationTemplate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
build a new animation
<p>
</div>
</div><p>
<a class="anchor" name="c74b84885cee40083ac50ea7c5e9f50f"></a><!-- doxytag: member="csAnimationTemplate::~csAnimationTemplate" ref="c74b84885cee40083ac50ea7c5e9f50f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csAnimationTemplate::~csAnimationTemplate </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
destructor
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4093c9097566a8e7fb9c13eef340b21f"></a><!-- doxytag: member="csAnimationTemplate::AddFrame" ref="4093c9097566a8e7fb9c13eef340b21f" args="(csTicks Delay, iTextureHandle *Tex, int x, int y, int w, int h)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csAnimationTemplate::AddFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>Delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiTextureHandle.html">iTextureHandle</a> * </td>
<td class="paramname"> <em>Tex</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>w</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>h</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
add a frame (giving the length of this frame)
<p>
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00075">75</a> of file <a class="el" href="csanim2d_8h-source.html">csanim2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d9ccf58a0daed803f9086e06413ca14d"></a><!-- doxytag: member="csAnimationTemplate::AddFrame" ref="d9ccf58a0daed803f9086e06413ca14d" args="(csTicks Delay, iTextureHandle *Tex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csAnimationTemplate::AddFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>Delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiTextureHandle.html">iTextureHandle</a> * </td>
<td class="paramname"> <em>Tex</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
add a frame (giving the length of this frame)
<p>
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00072">72</a> of file <a class="el" href="csanim2d_8h-source.html">csanim2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="fbdf45ab108795a7c2ea68a6965545da"></a><!-- doxytag: member="csAnimationTemplate::AddFrame" ref="fbdf45ab108795a7c2ea68a6965545da" args="(csTicks Delay, csPixmap *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void csAnimationTemplate::AddFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>Delay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsPixmap.html">csPixmap</a> * </td>
<td class="paramname"> <em>s</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
add a frame. (giving the length of this frame)
<p>
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00069">69</a> of file <a class="el" href="csanim2d_8h-source.html">csanim2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="58f31d8a2c1947f3bde10561e27b2cf5"></a><!-- doxytag: member="csAnimationTemplate::CreateInstance" ref="58f31d8a2c1947f3bde10561e27b2cf5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsAnimatedPixmap.html">csAnimatedPixmap</a>* csAnimationTemplate::CreateInstance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create an instance of this animation
<p>
</div>
</div><p>
<a class="anchor" name="27d3cf5d62360840c43aed5f04241dc5"></a><!-- doxytag: member="csAnimationTemplate::GetFrame" ref="27d3cf5d62360840c43aed5f04241dc5" args="(size_t n) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsPixmap.html">csPixmap</a>* csAnimationTemplate::GetFrame </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get a frame by number
<p>
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00080">80</a> of file <a class="el" href="csanim2d_8h-source.html">csanim2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a4bedc3dae27c886edcad843c7bc258d"></a><!-- doxytag: member="csAnimationTemplate::GetFrameByTime" ref="a4bedc3dae27c886edcad843c7bc258d" args="(csTicks Time)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsPixmap.html">csPixmap</a>* csAnimationTemplate::GetFrameByTime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>Time</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get a frame by time
<p>
</div>
</div><p>
<a class="anchor" name="10dc2ab6a572ad39f4a8d9e3c7b9704c"></a><!-- doxytag: member="csAnimationTemplate::GetFrameCount" ref="10dc2ab6a572ad39f4a8d9e3c7b9704c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t csAnimationTemplate::GetFrameCount </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get number of frames
<p>
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00058">58</a> of file <a class="el" href="csanim2d_8h-source.html">csanim2d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d6aafce70936077881ca5586f3e38846"></a><!-- doxytag: member="csAnimationTemplate::GetLength" ref="d6aafce70936077881ca5586f3e38846" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> csAnimationTemplate::GetLength </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get total length of animation (all delays added together)
<p>
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00061">61</a> of file <a class="el" href="csanim2d_8h-source.html">csanim2d.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>cstool/<a class="el" href="csanim2d_8h-source.html">csanim2d.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
>
235
