Files
wagic/JGE/docs/html/class_j_animator_object.html
wagic.the.homebrew d45e3b101b
2008-11-02 09:50:16 +00:00

355 lines
14 KiB
HTML

<!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++: JAnimatorObject 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>JAnimatorObject Class Reference</h1><!-- doxytag: class="JAnimatorObject" --><code>#include &lt;JAnimator.h&gt;</code>
<p>
<div class="dynheader">
Collaboration diagram for JAnimatorObject:</div>
<div class="dynsection">
</div>
<p>
<a href="class_j_animator_object-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_object.html#9cd672a89ece88a9048869776f857de9">JAnimatorObject</a> ()</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_object.html#3f6814df2ac34961d030e9fa800e4d85">~JAnimatorObject</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_object.html#878b300a68462d8b3a454f8a85f51e61">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_object.html#c271d342be744f1356816b6b917ffdf2">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_object.html#4e3517b2e5b0e564ff223c1a1a764e3e">SetQuad</a> (<a class="el" href="class_j_quad.html">JQuad</a> *quad)</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_object.html#fb48e03d081f53bd74b90f36d631be63">SetPosition</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_object.html#dd40951eb097bc6b7a51fd25b7e7150c">SetRotation</a> (float angle)</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_object.html#2610e5914cd8becbac60aa1285444455">SetHScale</a> (float scale)</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_object.html#5d6f5fa25d13d2b8278f837623e49eca">SetVScale</a> (float scale)</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_object.html#7594a4b66008194f77aa4c16e8529eff">SetColor</a> (PIXEL_TYPE color)</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_object.html#a651364650b463b222a2258d5f74655e">SetFlip</a> (bool flag)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Animation object (image quad) in a frame. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9cd672a89ece88a9048869776f857de9"></a><!-- doxytag: member="JAnimatorObject::JAnimatorObject" ref="9cd672a89ece88a9048869776f857de9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JAnimatorObject::JAnimatorObject </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
</div>
</div><p>
<a class="anchor" name="3f6814df2ac34961d030e9fa800e4d85"></a><!-- doxytag: member="JAnimatorObject::~JAnimatorObject" ref="3f6814df2ac34961d030e9fa800e4d85" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">JAnimatorObject::~JAnimatorObject </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="878b300a68462d8b3a454f8a85f51e61"></a><!-- doxytag: member="JAnimatorObject::Update" ref="878b300a68462d8b3a454f8a85f51e61" args="(float dt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::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>
Update object.<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>
</div>
</div><p>
<a class="anchor" name="c271d342be744f1356816b6b917ffdf2"></a><!-- doxytag: member="JAnimatorObject::Render" ref="c271d342be744f1356816b6b917ffdf2" args="(float x, float y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::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 object.<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="4e3517b2e5b0e564ff223c1a1a764e3e"></a><!-- doxytag: member="JAnimatorObject::SetQuad" ref="4e3517b2e5b0e564ff223c1a1a764e3e" args="(JQuad *quad)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::SetQuad </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_j_quad.html">JQuad</a> *&nbsp;</td>
<td class="paramname"> <em>quad</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set something to show.<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>quad</em>&nbsp;</td><td>- Image quad. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="fb48e03d081f53bd74b90f36d631be63"></a><!-- doxytag: member="JAnimatorObject::SetPosition" ref="fb48e03d081f53bd74b90f36d631be63" args="(float x, float y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::SetPosition </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>
Set position of the object.<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. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em>&nbsp;</td><td>- Y position. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="dd40951eb097bc6b7a51fd25b7e7150c"></a><!-- doxytag: member="JAnimatorObject::SetRotation" ref="dd40951eb097bc6b7a51fd25b7e7150c" args="(float angle)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::SetRotation </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>angle</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set rotation factor of the object.<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>angle</em>&nbsp;</td><td>- Rotation angle in radian. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="2610e5914cd8becbac60aa1285444455"></a><!-- doxytag: member="JAnimatorObject::SetHScale" ref="2610e5914cd8becbac60aa1285444455" args="(float scale)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::SetHScale </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>scale</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set horizontal scale of the object.<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>scale</em>&nbsp;</td><td>- Horizontal scale. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5d6f5fa25d13d2b8278f837623e49eca"></a><!-- doxytag: member="JAnimatorObject::SetVScale" ref="5d6f5fa25d13d2b8278f837623e49eca" args="(float scale)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::SetVScale </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>scale</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set vertical scale of the object.<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>scale</em>&nbsp;</td><td>- Vertical scale. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7594a4b66008194f77aa4c16e8529eff"></a><!-- doxytag: member="JAnimatorObject::SetColor" ref="7594a4b66008194f77aa4c16e8529eff" args="(PIXEL_TYPE color)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::SetColor </td>
<td>(</td>
<td class="paramtype">PIXEL_TYPE&nbsp;</td>
<td class="paramname"> <em>color</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set blending color of the object.<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>color</em>&nbsp;</td><td>- Blending color. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a651364650b463b222a2258d5f74655e"></a><!-- doxytag: member="JAnimatorObject::SetFlip" ref="a651364650b463b222a2258d5f74655e" args="(bool flag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void JAnimatorObject::SetFlip </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>flag</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set horizontal flipping.<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>flag</em>&nbsp;</td><td>- flipping flag. </td></tr>
</table>
</dl>
</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>