<!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: iSpriteAction 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>iSpriteAction Struct Reference<br> <small> [<a class="el" href="group__meshplugins.html">Mesh plugins</a>]</small> </h1><!-- doxytag: class="iSpriteAction" --><!-- doxytag: inherits="iBase" -->An action frameset for 3D sprite animation. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="sprite3d_8h-source.html">imesh/sprite3d.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for iSpriteAction:</div> <div class="dynsection"> <p><center><img src="structiSpriteAction__inherit__graph.png" border="0" usemap="#iSpriteAction__inherit__map" alt="Inheritance graph"></center> <map name="iSpriteAction__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="28,7,84,33"></map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div> <p> <a href="structiSpriteAction-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="structiSpriteAction.html#54ac2bed5f4e3380b019e218cbe63842">AddFrame</a> (<a class="el" href="structiSpriteFrame.html">iSpriteFrame</a> *frame, int delay, float displacement)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Add a frame to this action. <a href="#54ac2bed5f4e3380b019e218cbe63842"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiSpriteFrame.html">iSpriteFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteAction.html#e52d3cfc6ae34d12f5fa001fcd8ef284">GetFrame</a> (int f)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the specified frame. <a href="#e52d3cfc6ae34d12f5fa001fcd8ef284"></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="structiSpriteAction.html#41ab190feeb5574b5e238e1f240fee04">GetFrameCount</a> ()=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of frames in this action. <a href="#41ab190feeb5574b5e238e1f240fee04"></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="structiSpriteAction.html#a08bebbe4f5e2ce6fc0a6a72d9807e97">GetFrameDelay</a> (int f)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the delay for the specified frame. <a href="#a08bebbe4f5e2ce6fc0a6a72d9807e97"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteAction.html#1cd5417c666c0f595f96f3128eae25a6">GetFrameDisplacement</a> (int f)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the displacement for the specified frame. <a href="#1cd5417c666c0f595f96f3128eae25a6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteAction.html#dc6515595612f080e02e55e02e94347e">GetName</a> () const =0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name. <a href="#dc6515595612f080e02e55e02e94347e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="structiSpriteFrame.html">iSpriteFrame</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSpriteAction.html#8efc8d0c3f085df2208fc66c0b70bff4">GetNextFrame</a> (int f)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next frame after the specified one. <a href="#8efc8d0c3f085df2208fc66c0b70bff4"></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="structiSpriteAction.html#a6abdb9b3b1c1ec7a70be3feeabbac05">SetName</a> (char const *)=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the name. <a href="#a6abdb9b3b1c1ec7a70be3feeabbac05"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> An action frameset for 3D sprite animation. <p>Definition at line <a class="el" href="sprite3d_8h-source.html#l00107">107</a> of file <a class="el" href="sprite3d_8h-source.html">sprite3d.h</a>.</p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="54ac2bed5f4e3380b019e218cbe63842"></a><!-- doxytag: member="iSpriteAction::AddFrame" ref="54ac2bed5f4e3380b019e218cbe63842" args="(iSpriteFrame *frame, int delay, float displacement)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iSpriteAction::AddFrame </td> <td>(</td> <td class="paramtype"><a class="el" href="structiSpriteFrame.html">iSpriteFrame</a> * </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>delay</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float </td> <td class="paramname"> <em>displacement</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> Add a frame to this action. <p> </div> </div><p> <a class="anchor" name="e52d3cfc6ae34d12f5fa001fcd8ef284"></a><!-- doxytag: member="iSpriteAction::GetFrame" ref="e52d3cfc6ae34d12f5fa001fcd8ef284" args="(int f)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiSpriteFrame.html">iSpriteFrame</a>* iSpriteAction::GetFrame </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>f</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the specified frame. <p> </div> </div><p> <a class="anchor" name="41ab190feeb5574b5e238e1f240fee04"></a><!-- doxytag: member="iSpriteAction::GetFrameCount" ref="41ab190feeb5574b5e238e1f240fee04" args="()=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int iSpriteAction::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> Get the number of frames in this action. <p> </div> </div><p> <a class="anchor" name="a08bebbe4f5e2ce6fc0a6a72d9807e97"></a><!-- doxytag: member="iSpriteAction::GetFrameDelay" ref="a08bebbe4f5e2ce6fc0a6a72d9807e97" args="(int f)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual int iSpriteAction::GetFrameDelay </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>f</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the delay for the specified frame. <p> </div> </div><p> <a class="anchor" name="1cd5417c666c0f595f96f3128eae25a6"></a><!-- doxytag: member="iSpriteAction::GetFrameDisplacement" ref="1cd5417c666c0f595f96f3128eae25a6" args="(int f)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual float iSpriteAction::GetFrameDisplacement </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>f</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the displacement for the specified frame. <p> </div> </div><p> <a class="anchor" name="dc6515595612f080e02e55e02e94347e"></a><!-- doxytag: member="iSpriteAction::GetName" ref="dc6515595612f080e02e55e02e94347e" args="() const =0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual char const* iSpriteAction::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> Get the name. <p> </div> </div><p> <a class="anchor" name="8efc8d0c3f085df2208fc66c0b70bff4"></a><!-- doxytag: member="iSpriteAction::GetNextFrame" ref="8efc8d0c3f085df2208fc66c0b70bff4" args="(int f)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="structiSpriteFrame.html">iSpriteFrame</a>* iSpriteAction::GetNextFrame </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>f</em> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get the next frame after the specified one. <p> </div> </div><p> <a class="anchor" name="a6abdb9b3b1c1ec7a70be3feeabbac05"></a><!-- doxytag: member="iSpriteAction::SetName" ref="a6abdb9b3b1c1ec7a70be3feeabbac05" args="(char const *)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void iSpriteAction::SetName </td> <td>(</td> <td class="paramtype">char const * </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set the name. <p> </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li>imesh/<a class="el" href="sprite3d_8h-source.html">sprite3d.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>