<!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: csAnimatedPixmap 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>csAnimatedPixmap Class Reference</h1><!-- doxytag: class="csAnimatedPixmap" --><!-- doxytag: inherits="csPixmap" -->A pixmap with a 2d animation.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="csanim2d_8h-source.html">cstool/csanim2d.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csAnimatedPixmap:</div>
<div class="dynsection">
<p><center><img src="classcsAnimatedPixmap__inherit__graph.png" border="0" usemap="#csAnimatedPixmap__inherit__map" alt="Inheritance graph"></center>
<map name="csAnimatedPixmap__inherit__map">
<area shape="rect" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple..." alt="" coords="37,7,120,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsAnimatedPixmap-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="classcsAnimatedPixmap.html#eab6e7928a878a327a943b7a4e6b4e77">Advance</a> (<a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> ElapsedTime)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">advance in time <a href="#eab6e7928a878a327a943b7a4e6b4e77"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimatedPixmap.html#bbf984fb053b460b76fc78dbb8a7aff7">csAnimatedPixmap</a> (<a class="el" href="classcsAnimationTemplate.html">csAnimationTemplate</a> *tpl)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an animated pixmap. <a href="#bbf984fb053b460b76fc78dbb8a7aff7"></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="classcsAnimatedPixmap.html#c60016f958c9cbbdd520daf605121e0b">DrawScaled</a> (<a class="el" href="structiGraphics3D.html">iGraphics3D</a> *g3d, int sx, int sy, int sw, int sh, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> Alpha=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the pixmap given the screen position and new size. <a href="#c60016f958c9cbbdd520daf605121e0b"></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="classcsAnimatedPixmap.html#c998cc158cc860a577f521c2d2e48281">DrawTiled</a> (<a class="el" href="structiGraphics3D.html">iGraphics3D</a> *g3d, int sx, int sy, int sw, int sh, int orgx, int orgy, <a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> Alpha=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Draw the pixmap tiled over an area. <a href="#c998cc158cc860a577f521c2d2e48281"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimatedPixmap.html#c662acd86e25cc506e6c958820138dde">GetTextureHandle</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return current texture handle <a href="#c662acd86e25cc506e6c958820138dde"></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="classcsAnimatedPixmap.html#48ec4164bddd601e943597bbcf327582">Height</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return current height of this pixmap <a href="#48ec4164bddd601e943597bbcf327582"></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="classcsAnimatedPixmap.html#615ce7c31150f207005557b726861b4f">Width</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return current width of this pixmap <a href="#615ce7c31150f207005557b726861b4f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnimatedPixmap.html#249c07c79c2e6b7e17825ca322320c22">~csAnimatedPixmap</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy this object. <a href="#249c07c79c2e6b7e17825ca322320c22"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A pixmap with a 2d animation.
<p>Definition at line <a class="el" href="csanim2d_8h-source.html#l00091">91</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="bbf984fb053b460b76fc78dbb8a7aff7"></a><!-- doxytag: member="csAnimatedPixmap::csAnimatedPixmap" ref="bbf984fb053b460b76fc78dbb8a7aff7" args="(csAnimationTemplate *tpl)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csAnimatedPixmap::csAnimatedPixmap </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsAnimationTemplate.html">csAnimationTemplate</a> * </td>
<td class="paramname"> <em>tpl</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an animated pixmap.
<p>
</div>
</div><p>
<a class="anchor" name="249c07c79c2e6b7e17825ca322320c22"></a><!-- doxytag: member="csAnimatedPixmap::~csAnimatedPixmap" ref="249c07c79c2e6b7e17825ca322320c22" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual csAnimatedPixmap::~csAnimatedPixmap </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy this object.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="eab6e7928a878a327a943b7a4e6b4e77"></a><!-- doxytag: member="csAnimatedPixmap::Advance" ref="eab6e7928a878a327a943b7a4e6b4e77" args="(csTicks ElapsedTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csAnimatedPixmap::Advance </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td>
<td class="paramname"> <em>ElapsedTime</em> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
advance in time
<p>
<p>Implements <a class="el" href="classcsPixmap.html#4320d55b7a6541c2520a64511df3ce0e">csPixmap</a>.</p>
</div>
</div><p>
<a class="anchor" name="c60016f958c9cbbdd520daf605121e0b"></a><!-- doxytag: member="csAnimatedPixmap::DrawScaled" ref="c60016f958c9cbbdd520daf605121e0b" args="(iGraphics3D *g3d, int sx, int sy, int sw, int sh, uint8 Alpha=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csAnimatedPixmap::DrawScaled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td>
<td class="paramname"> <em>g3d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"> <em>Alpha</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Draw the pixmap given the screen position and new size.
<p>
<p>Implements <a class="el" href="classcsPixmap.html#c51483cf186f7cb94700edbbcb8c77fe">csPixmap</a>.</p>
</div>
</div><p>
<a class="anchor" name="c998cc158cc860a577f521c2d2e48281"></a><!-- doxytag: member="csAnimatedPixmap::DrawTiled" ref="c998cc158cc860a577f521c2d2e48281" args="(iGraphics3D *g3d, int sx, int sy, int sw, int sh, int orgx, int orgy, uint8 Alpha=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csAnimatedPixmap::DrawTiled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td>
<td class="paramname"> <em>g3d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>sh</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>orgx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>orgy</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79">uint8</a> </td>
<td class="paramname"> <em>Alpha</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Draw the pixmap tiled over an area.
<p>
multiple draw commands with the same texture and same origin values will align properly. The orgx and orgy point to a pixel (perhaps offscreen) where the (0,0) pixel of this pixmap would be drawn.
<p>Implements <a class="el" href="classcsPixmap.html#18bafca32fff1ca7270db8da54d8dee0">csPixmap</a>.</p>
</div>
</div><p>
<a class="anchor" name="c662acd86e25cc506e6c958820138dde"></a><!-- doxytag: member="csAnimatedPixmap::GetTextureHandle" ref="c662acd86e25cc506e6c958820138dde" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="structiTextureHandle.html">iTextureHandle</a>* csAnimatedPixmap::GetTextureHandle </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
return current texture handle
<p>
<p>Implements <a class="el" href="classcsPixmap.html#fb18943f75e61dda86a73b0b5b52ebf9">csPixmap</a>.</p>
</div>
</div><p>
<a class="anchor" name="48ec4164bddd601e943597bbcf327582"></a><!-- doxytag: member="csAnimatedPixmap::Height" ref="48ec4164bddd601e943597bbcf327582" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csAnimatedPixmap::Height </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
return current height of this pixmap
<p>
<p>Implements <a class="el" href="classcsPixmap.html#adf2b381eab0d686b80bf2576fd4d3fa">csPixmap</a>.</p>
</div>
</div><p>
<a class="anchor" name="615ce7c31150f207005557b726861b4f"></a><!-- doxytag: member="csAnimatedPixmap::Width" ref="615ce7c31150f207005557b726861b4f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csAnimatedPixmap::Width </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
return current width of this pixmap
<p>
<p>Implements <a class="el" href="classcsPixmap.html#eca74d9a08f365f7d0d91a7416413be6">csPixmap</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
>
232
