Sophie

Sophie

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

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: cstool/csanim2d.h Source File (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><a href="classes.html"><span>Classes</span></a></li>
    <li class="current"><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>cstool/csanim2d.h</h1><a href="csanim2d_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2000 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">    Copyright (C) 2001 by W.C.A. Wijngaards</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00007"></a>00007 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00013"></a>00013 <span class="comment">    Library General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00016"></a>00016 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00017"></a>00017 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="preprocessor">#ifndef __CS_CSANIM2D_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSANIM2D_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="cspixmap_8h.html" title="2D pixmaps">cstool/cspixmap.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="csutil_2array_8h.html" title="Generic Array Template.">csutil/array.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="parray_8h.html" title="Pointer Array.">csutil/parray.h</a>"</span>
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">struct </span><a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>;
<a name="l00034"></a>00034 <span class="keyword">struct </span><a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a>;
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="keyword">class </span><a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a>;
<a name="l00037"></a>00037 <span class="keyword">class </span><a class="code" href="classcsAnimatedPixmap.html" title="A pixmap with a 2d animation.">csAnimatedPixmap</a>;
<a name="l00038"></a>00038 
<a name="l00040"></a><a class="code" href="classcsAnimationTemplate.html">00040</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsAnimationTemplate.html" title="A 2d animation template. This class is used to create animated pixmaps.">csAnimationTemplate</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">private</span>:
<a name="l00044"></a>00044   <a class="code" href="classcsPDelArray.html" title="An array of pointers.">csPDelArray&lt;csPixmap&gt;</a> Frames;
<a name="l00049"></a>00049   <a class="code" href="classcsArray.html" title="A templated array class.">csArray&lt;csTicks&gt;</a> FinishTimes;
<a name="l00050"></a>00050 
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00053"></a>00053   <a class="code" href="classcsAnimationTemplate.html" title="A 2d animation template. This class is used to create animated pixmaps.">csAnimationTemplate</a>();
<a name="l00055"></a>00055   ~<a class="code" href="classcsAnimationTemplate.html" title="A 2d animation template. This class is used to create animated pixmaps.">csAnimationTemplate</a>();
<a name="l00056"></a>00056 
<a name="l00058"></a><a class="code" href="classcsAnimationTemplate.html#10dc2ab6a572ad39f4a8d9e3c7b9704c">00058</a>   <span class="keyword">inline</span> <span class="keywordtype">size_t</span> GetFrameCount()<span class="keyword"> const</span>
<a name="l00059"></a>00059 <span class="keyword">  </span>{<span class="keywordflow">return</span> Frames.GetSize ();}
<a name="l00061"></a><a class="code" href="classcsAnimationTemplate.html#d6aafce70936077881ca5586f3e38846">00061</a>   <span class="keyword">inline</span> <a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> GetLength()<span class="keyword"> const</span>
<a name="l00062"></a>00062 <span class="keyword">  </span>{ 
<a name="l00063"></a>00063     <span class="keywordflow">if</span> (GetFrameCount() == 0)
<a name="l00064"></a>00064       <span class="keywordflow">return</span> 0;
<a name="l00065"></a>00065     <span class="keywordflow">else</span>
<a name="l00066"></a>00066       <span class="keywordflow">return</span> (<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a>)(FinishTimes.Get (GetFrameCount()-1)); 
<a name="l00067"></a>00067   }
<a name="l00069"></a><a class="code" href="classcsAnimationTemplate.html#fbdf45ab108795a7c2ea68a6965545da">00069</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> AddFrame(<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> Delay, <a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a> *s)
<a name="l00070"></a>00070   {FinishTimes.Push(GetLength() + Delay); Frames.Push (s);}
<a name="l00072"></a><a class="code" href="classcsAnimationTemplate.html#d9ccf58a0daed803f9086e06413ca14d">00072</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> AddFrame(<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> Delay, <a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *Tex)
<a name="l00073"></a>00073   {AddFrame(Delay, <span class="keyword">new</span> <a class="code" href="classcsSimplePixmap.html" title="This is the simple implementation of csPixmap that uses a single texture.">csSimplePixmap</a>(Tex));}
<a name="l00075"></a><a class="code" href="classcsAnimationTemplate.html#4093c9097566a8e7fb9c13eef340b21f">00075</a>   <span class="keyword">inline</span> <span class="keywordtype">void</span> AddFrame(<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> Delay, <a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *Tex, <span class="keywordtype">int</span> x, <span class="keywordtype">int</span> y,
<a name="l00076"></a>00076         <span class="keywordtype">int</span> w, <span class="keywordtype">int</span> h)
<a name="l00077"></a>00077   {AddFrame(Delay, <span class="keyword">new</span> <a class="code" href="classcsSimplePixmap.html" title="This is the simple implementation of csPixmap that uses a single texture.">csSimplePixmap</a>(Tex, x, y, w, h));}
<a name="l00078"></a>00078 
<a name="l00080"></a><a class="code" href="classcsAnimationTemplate.html#27d3cf5d62360840c43aed5f04241dc5">00080</a>   <span class="keyword">inline</span> <a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a> *GetFrame(<span class="keywordtype">size_t</span> n)<span class="keyword"> const</span>
<a name="l00081"></a>00081 <span class="keyword">  </span>{<span class="keywordflow">return</span> Frames.Get(n);}
<a name="l00083"></a>00083   <a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a> *GetFrameByTime(<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> Time);
<a name="l00084"></a>00084 
<a name="l00086"></a>00086   <a class="code" href="classcsAnimatedPixmap.html" title="A pixmap with a 2d animation.">csAnimatedPixmap</a> *CreateInstance();
<a name="l00087"></a>00087 };
<a name="l00088"></a>00088 
<a name="l00089"></a>00089 
<a name="l00091"></a><a class="code" href="classcsAnimatedPixmap.html">00091</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsAnimatedPixmap.html" title="A pixmap with a 2d animation.">csAnimatedPixmap</a> : <span class="keyword">public</span> <a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a>
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 <span class="keyword">public</span>:
<a name="l00095"></a>00095   <a class="code" href="classcsAnimatedPixmap.html" title="A pixmap with a 2d animation.">csAnimatedPixmap</a>(<a class="code" href="classcsAnimationTemplate.html" title="A 2d animation template. This class is used to create animated pixmaps.">csAnimationTemplate</a> *tpl);
<a name="l00097"></a>00097   <span class="keyword">virtual</span> ~<a class="code" href="classcsAnimatedPixmap.html" title="A pixmap with a 2d animation.">csAnimatedPixmap</a>();
<a name="l00098"></a>00098 
<a name="l00099"></a>00099   <span class="comment">// Implementation of csPixmap.</span>
<a name="l00100"></a>00100   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classcsPixmap.html#eca74d9a08f365f7d0d91a7416413be6" title="return current width of this pixmap">Width</a>();
<a name="l00101"></a>00101   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classcsPixmap.html#adf2b381eab0d686b80bf2576fd4d3fa" title="return current height of this pixmap">Height</a>();
<a name="l00102"></a>00102   <span class="keyword">virtual</span> <a class="code" href="structiTextureHandle.html" title="A texture handle as returned by iTextureManager.">iTextureHandle</a> *<a class="code" href="classcsPixmap.html#fb18943f75e61dda86a73b0b5b52ebf9" title="return current texture handle">GetTextureHandle</a>();
<a name="l00103"></a>00103   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsPixmap.html#c51483cf186f7cb94700edbbcb8c77fe" title="Draw the pixmap given the screen position and new size.">DrawScaled</a> (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> sw, <span class="keywordtype">int</span> sh,
<a name="l00104"></a>00104     <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0);
<a name="l00105"></a>00105   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsPixmap.html#18bafca32fff1ca7270db8da54d8dee0" title="Draw the pixmap tiled over an area.">DrawTiled</a> (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <span class="keywordtype">int</span> sx, <span class="keywordtype">int</span> sy, <span class="keywordtype">int</span> sw, <span class="keywordtype">int</span> sh,
<a name="l00106"></a>00106     <span class="keywordtype">int</span> orgx, <span class="keywordtype">int</span> orgy, <a class="code" href="group__util.html#gdde6aaee8457bee49c2a92621fe22b79" title="unsigned 8-bit integer (0..255)">uint8</a> Alpha = 0);
<a name="l00107"></a>00107   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classcsPixmap.html#4320d55b7a6541c2520a64511df3ce0e" title="advance in time">Advance</a>(<a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> ElapsedTime);
<a name="l00108"></a>00108 
<a name="l00109"></a>00109 <span class="keyword">private</span>:
<a name="l00110"></a>00110   <a class="code" href="classcsAnimationTemplate.html" title="A 2d animation template. This class is used to create animated pixmaps.">csAnimationTemplate</a> *Template;
<a name="l00111"></a>00111   <a class="code" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793" title="A time value measured in milliseconds (1/1000 of a second).">csTicks</a> CurrentTime;
<a name="l00112"></a>00112   <a class="code" href="classcsPixmap.html" title="This class is an simple set of inline routines good as an abstraction for simple...">csPixmap</a> *CurrentFrame;
<a name="l00113"></a>00113 };
<a name="l00114"></a>00114 
<a name="l00115"></a>00115 <span class="preprocessor">#endif // __CS_CSANIM2D_H__</span>
</pre></div><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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional