Mahtan/wagic
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5db6b807bad7d998457d042126f46f7298c1ed78
wagic/JGE/docs/html/class_j_animator_frame.html
wagic.the.homebrew d45e3b101b
2008-11-02 09:50:16 +00:00

234 lines
9.3 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>JGE++: JAnimatorFrame Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>JAnimatorFrame Class Reference</h1><!-- doxytag: class="JAnimatorFrame" --><code>#include &lt;JAnimator.h&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for JAnimatorFrame:</div>
<div class="dynsection">
</div>
<p>
<a href="class_j_animator_frame-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_animator_frame.html#9aa32e6329b038e6b66756f2aa9b75bd">JAnimatorFrame</a> (<a class="el" href="class_j_animator.html">JAnimator</a> *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_animator_frame.html#9abf82d4deeecbd79f9304a965f25246">~JAnimatorFrame</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_animator_frame.html#7b8e1ffad9933dfd292371c84efe21ee">AddObject</a> (<a class="el" href="class_j_animator_object.html">JAnimatorObject</a> *obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_animator_frame.html#47aba9caf56c4027e0cf285c025dc148">SetFrameTime</a> (float duration)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_animator_frame.html#cc83cbb5b4f0685b1d9309280970f1fa">Update</a> (float dt)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_animator_frame.html#911ff0c8920f0150a050d6a2d2b7dc32">Render</a> (float x, float y)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_animator_frame.html#6f29a5e0811fa239be58e13c5eb4afd2">Start</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A single frame of an animation. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9aa32e6329b038e6b66756f2aa9b75bd"></a><!-- doxytag: member="JAnimatorFrame::JAnimatorFrame" ref="9aa32e6329b038e6b66756f2aa9b75bd" args="(JAnimator *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JAnimatorFrame::JAnimatorFrame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_j_animator.html">JAnimator</a> *&nbsp;</td>
<td class="paramname"> <em>parent</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parent</em>&nbsp;</td><td>- Parent of the frame. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9abf82d4deeecbd79f9304a965f25246"></a><!-- doxytag: member="JAnimatorFrame::~JAnimatorFrame" ref="9abf82d4deeecbd79f9304a965f25246" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JAnimatorFrame::~JAnimatorFrame </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="7b8e1ffad9933dfd292371c84efe21ee"></a><!-- doxytag: member="JAnimatorFrame::AddObject" ref="7b8e1ffad9933dfd292371c84efe21ee" args="(JAnimatorObject *obj)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorFrame::AddObject </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_j_animator_object.html">JAnimatorObject</a> *&nbsp;</td>
<td class="paramname"> <em>obj</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a new object into the frame.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>obj</em>&nbsp;</td><td>- New animation object. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="47aba9caf56c4027e0cf285c025dc148"></a><!-- doxytag: member="JAnimatorFrame::SetFrameTime" ref="47aba9caf56c4027e0cf285c025dc148" args="(float duration)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorFrame::SetFrameTime </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>duration</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set play time of the frame.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>duration</em>&nbsp;</td><td>- Time to play (in second). </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="cc83cbb5b4f0685b1d9309280970f1fa"></a><!-- doxytag: member="JAnimatorFrame::Update" ref="cc83cbb5b4f0685b1d9309280970f1fa" args="(float dt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool JAnimatorFrame::Update </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>dt</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Frame update.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dt</em>&nbsp;</td><td>- Time elapsed since last update (in second).</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the frame is done. </dd></dl>
</div>
</div><p>
<a class="anchor" name="911ff0c8920f0150a050d6a2d2b7dc32"></a><!-- doxytag: member="JAnimatorFrame::Render" ref="911ff0c8920f0150a050d6a2d2b7dc32" args="(float x, float y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorFrame::Render </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>y</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Render frame.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>x</em>&nbsp;</td><td>- X position for rendering. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>- Y position for rendering. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6f29a5e0811fa239be58e13c5eb4afd2"></a><!-- doxytag: member="JAnimatorFrame::Start" ref="6f29a5e0811fa239be58e13c5eb4afd2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorFrame::Start </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start playing the frame.
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 22 00:28:22 2007 for JGE++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink