1365 lines
55 KiB
HTML
1365 lines
55 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++: JSprite 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 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 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>JSprite Class Reference</h1><!-- doxytag: class="JSprite" --><code>#include <JSprite.h></code>
|
|
<p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for JSprite:</div>
|
|
<div class="dynsection">
|
|
</div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for JSprite:</div>
|
|
<div class="dynsection">
|
|
</div>
|
|
|
|
<p>
|
|
<a href="class_j_sprite-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 Types</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f">ANIMATION_TYPE</a> { <br>
|
|
<a class="el" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f1f034bfaee18258f0658b1d9cf09ce01">ANIMATION_TYPE_LOOPING</a>,
|
|
<a class="el" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031fab81e12365c0f69d8842ce449fa7610c">ANIMATION_TYPE_ONCE_AND_STAY</a>,
|
|
<a class="el" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f3818aa09ff532ab98ca9618189c2515a">ANIMATION_TYPE_ONCE_AND_BACK</a>,
|
|
<a class="el" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f1a8e3d1068c5ad334d7f4ecd785b87ec">ANIMATION_TYPE_ONCE_AND_GONE</a>,
|
|
<br>
|
|
<a class="el" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031fb40f498d492d7efc3d0746531c885654">ANIMATION_TYPE_PINGPONG</a>
|
|
<br>
|
|
}</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#6a7d0295053eae90250591dc7d8cc67b">JSprite</a> (JTexture *tex=NULL, float x=0.0f, float y=0.0f, float width=0.0f, float height=0.0f, bool flipped=false)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#fa0111c412e816eaa3d27eb3b84a4732">Update</a> (float dt)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#6dce11d10a097e171bcbfbf4681d3bb0">Render</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#71727c100d1915b2fa02c9602dee8914">SetAnimationType</a> (int type)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#61676dea2decaf5f16840cea14b95750">SetActive</a> (bool f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#ec9d9ec6720168289cd73bde83b42e07">IsActive</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#d170931753a3281b7113ddd39c53a3ea">SetId</a> (int id)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#a7042e28e9ba3fa15b769b4ed3215f20">GetId</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#f7fef8a4463578f30c112e9fd6a9c91d">SetFlip</a> (bool flip, int index=-1)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#924baaf2e83351ac6b10d97416643aaa">AddFrame</a> (float x, float y, float width, float height, bool flipped=false)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#5146b0fb9fe58353a6e0f8182151c00f">AddFrame</a> (JTexture *tex, float x, float y, float width, float height, bool flipped=false)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#f04fa7900f974954d8c0462d3ac5551c">SetDuration</a> (float duration)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#2c7508494691e8d7795e84e623f85885">GetCurrentFrameIndex</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#63d116265006aeebc94dac8f38a62807">SetCurrentFrameIndex</a> (int frame)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_j_quad.html">JQuad</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#8ada556e9e3748d7ceb833828cf53d2f">GetCurrentFrame</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#01e450ab5aeaaf4bcd9bd0644face029">GetFrameCount</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_j_quad.html">JQuad</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#3d525c742e533527e42d838b5bb2072f">GetFrame</a> (int index)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#c55e9a51d7e9a18bb5e212c7ab54f176">RestartAnimation</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#6eea4abf66216b26d391a1551cbd1598">StartAnimation</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#21bf7eb4647cccd40bafa7ca3c376dd0">StopAnimation</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#cfcf746099ca280ac7dd9b8c16b7f4b9">IsAnimating</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#a827ef27e57ed8f8404f74c95e7dcdb3">Move</a> (float x, float y)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#c804db210beb1f6fd0af307a098654b1">SetPosition</a> (float x, float y)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#f6ffe7fbf20b6fee5f16ec9659efb7ed">SetX</a> (float x)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#6a6185b5c251e42a324547c47b0395e7">SetY</a> (float y)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#dc38bd89dfe47c2aa0d6658fdad80413">GetX</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#98dc9694e2d8bc094ceb3db0fc0f3206">GetY</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#8805f11f05cf0f11bf5a3e62c6840ea7">GetXVelocity</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#3ea3a0b390846dd63bec966c4aab2304">GetYVelocity</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#47783c0d2b630603b67d96bd0e7f8517">SetAlpha</a> (float alpha)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#c99a62614087ea32708c4556d0851aaa">GetAlpha</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#dcb4fb7e619de8a88390f74b9aa3c39b">SetScale</a> (float hscale, float vscale)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#eb94c1ee508f37435c531293c4ff5cd7">SetScale</a> (float scale)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#995b569214511e70c2fba7cfabdc64da">GetScale</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#fcdd2f4739f43fe0daa2ef405fd87553">SetRotation</a> (float rot)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#8b766100695abf64680b91811df16757">GetRotation</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#db0405f1d4fc0a4fc90661cf28a6753a">SetSpeed</a> (float speed)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#da6cf28796db95c79723005cf99b138f">GetSpeed</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#801cb135f704a8d18bf1c992e660ddd8">SetDirection</a> (float angle)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#6838f49241c8a6167c99283bd1c99273">SetDirection</a> (float x, float y)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#ac359f535a1431297644b4f60b049100">GetDirection</a> ()</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#7b6f90e8786d660f6f32820a3408e073">SetHotSpot</a> (float x, float y, int index=-1)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_j_sprite.html#d8debf9c816d651c14ea98e08a946e2f">SetColor</a> (PIXEL_TYPE color)</td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Sprite is a container of single static image or animation frames. <hr><h2>Member Enumeration Documentation</h2>
|
|
<a class="anchor" name="dd8a97654d2ae471e4572c4f60f1031f"></a><!-- doxytag: member="JSprite::ANIMATION_TYPE" ref="dd8a97654d2ae471e4572c4f60f1031f" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f">JSprite::ANIMATION_TYPE</a> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Type of animation. <dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"><em><a class="anchor" name="dd8a97654d2ae471e4572c4f60f1031f1f034bfaee18258f0658b1d9cf09ce01"></a><!-- doxytag: member="ANIMATION_TYPE_LOOPING" ref="dd8a97654d2ae471e4572c4f60f1031f1f034bfaee18258f0658b1d9cf09ce01" args="" -->ANIMATION_TYPE_LOOPING</em> </td><td>
|
|
Repeat playing (Default). </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="dd8a97654d2ae471e4572c4f60f1031fab81e12365c0f69d8842ce449fa7610c"></a><!-- doxytag: member="ANIMATION_TYPE_ONCE_AND_STAY" ref="dd8a97654d2ae471e4572c4f60f1031fab81e12365c0f69d8842ce449fa7610c" args="" -->ANIMATION_TYPE_ONCE_AND_STAY</em> </td><td>
|
|
Play to the end and stay at last frame. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="dd8a97654d2ae471e4572c4f60f1031f3818aa09ff532ab98ca9618189c2515a"></a><!-- doxytag: member="ANIMATION_TYPE_ONCE_AND_BACK" ref="dd8a97654d2ae471e4572c4f60f1031f3818aa09ff532ab98ca9618189c2515a" args="" -->ANIMATION_TYPE_ONCE_AND_BACK</em> </td><td>
|
|
Play to end and then stay at first frame. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="dd8a97654d2ae471e4572c4f60f1031f1a8e3d1068c5ad334d7f4ecd785b87ec"></a><!-- doxytag: member="ANIMATION_TYPE_ONCE_AND_GONE" ref="dd8a97654d2ae471e4572c4f60f1031f1a8e3d1068c5ad334d7f4ecd785b87ec" args="" -->ANIMATION_TYPE_ONCE_AND_GONE</em> </td><td>
|
|
Play animation once only. </td></tr>
|
|
<tr><td valign="top"><em><a class="anchor" name="dd8a97654d2ae471e4572c4f60f1031fb40f498d492d7efc3d0746531c885654"></a><!-- doxytag: member="ANIMATION_TYPE_PINGPONG" ref="dd8a97654d2ae471e4572c4f60f1031fb40f498d492d7efc3d0746531c885654" args="" -->ANIMATION_TYPE_PINGPONG</em> </td><td>
|
|
Play forward then backward and repeat. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" name="6a7d0295053eae90250591dc7d8cc67b"></a><!-- doxytag: member="JSprite::JSprite" ref="6a7d0295053eae90250591dc7d8cc67b" args="(JTexture *tex=NULL, float x=0.0f, float y=0.0f, float width=0.0f, float height=0.0f, bool flipped=false)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">JSprite::JSprite </td>
|
|
<td>(</td>
|
|
<td class="paramtype">JTexture * </td>
|
|
<td class="paramname"> <em>tex</em> = <code>NULL</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em> = <code>0.0f</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em> = <code>0.0f</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>width</em> = <code>0.0f</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>height</em> = <code>0.0f</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>flipped</em> = <code>false</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>tex</em> </td><td>- Texture for the first frame and the following frames. NULL to indicate no starting frame. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>- X of the frame in texture. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y of the frame in texture. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>- Width of the frame. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>- Height of the frame. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>flipped</em> </td><td>- Indicate if the frame is horizontally flipped. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="fa0111c412e816eaa3d27eb3b84a4732"></a><!-- doxytag: member="JSprite::Update" ref="fa0111c412e816eaa3d27eb3b84a4732" args="(float dt)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void JSprite::Update </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>dt</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Update animation.<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> </td><td>- Delta time since last update (in second). </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
<p>Reimplemented in <a class="el" href="class_j_game_object.html#5fdbb3739b6be505405015f42ee2712c">JGameObject</a>.</p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6dce11d10a097e171bcbfbf4681d3bb0"></a><!-- doxytag: member="JSprite::Render" ref="6dce11d10a097e171bcbfbf4681d3bb0" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void JSprite::Render </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Render current frame.
|
|
<p>Reimplemented in <a class="el" href="class_j_game_object.html#ea4e3cd8caa63779982008d8bde164ea">JGameObject</a>.</p>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="71727c100d1915b2fa02c9602dee8914"></a><!-- doxytag: member="JSprite::SetAnimationType" ref="71727c100d1915b2fa02c9602dee8914" args="(int type)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetAnimationType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>type</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set animation type.<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>type</em> </td><td>- Animation type.</td></tr>
|
|
</table>
|
|
</dl>
|
|
<div class="fragment"><pre class="fragment"> <a class="code" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f1f034bfaee18258f0658b1d9cf09ce01" title="Repeat playing (Default).">ANIMATION_TYPE_LOOPING</a> - Repeat playing (Default).
|
|
<a class="code" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f1a8e3d1068c5ad334d7f4ecd785b87ec" title="Play animation once only.">ANIMATION_TYPE_ONCE_AND_GONE</a> - Play animation once only.
|
|
<a class="code" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031f3818aa09ff532ab98ca9618189c2515a" title="Play to end and then stay at first frame.">ANIMATION_TYPE_ONCE_AND_BACK</a> - Play to end and then stay at first frame.
|
|
<a class="code" href="class_j_sprite.html#dd8a97654d2ae471e4572c4f60f1031fb40f498d492d7efc3d0746531c885654" title="Play forward then backward and repeat.">ANIMATION_TYPE_PINGPONG</a> - Play forward then backward and repeat.
|
|
</pre></div>
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="61676dea2decaf5f16840cea14b95750"></a><!-- doxytag: member="JSprite::SetActive" ref="61676dea2decaf5f16840cea14b95750" args="(bool f)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetActive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>f</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Enable/Disable sprite.<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>f</em> </td><td>- True to enable, false to disable. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ec9d9ec6720168289cd73bde83b42e07"></a><!-- doxytag: member="JSprite::IsActive" ref="ec9d9ec6720168289cd73bde83b42e07" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool JSprite::IsActive </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get current active status.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Active status. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d170931753a3281b7113ddd39c53a3ea"></a><!-- doxytag: member="JSprite::SetId" ref="d170931753a3281b7113ddd39c53a3ea" args="(int id)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>id</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Give sprite an id.<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>id</em> </td><td>- Id. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a7042e28e9ba3fa15b769b4ed3215f20"></a><!-- doxytag: member="JSprite::GetId" ref="a7042e28e9ba3fa15b769b4ed3215f20" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int JSprite::GetId </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get sprite id.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Sprite id. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f7fef8a4463578f30c112e9fd6a9c91d"></a><!-- doxytag: member="JSprite::SetFlip" ref="f7fef8a4463578f30c112e9fd6a9c91d" args="(bool flip, int index=-1)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetFlip </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>flip</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>index</em> = <code>-1</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Flip a frame or all frames horizontally when rendering.<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>flip</em> </td><td>- True to flip. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>- Frame index, -1 to flip all frames. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="924baaf2e83351ac6b10d97416643aaa"></a><!-- doxytag: member="JSprite::AddFrame" ref="924baaf2e83351ac6b10d97416643aaa" args="(float x, float y, float width, float height, bool flipped=false)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::AddFrame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>height</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>flipped</em> = <code>false</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Add new animation 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> </td><td>- X of the frame in texture. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y of the frame in texture. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>- Width of the frame. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>- Height of the frame. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>flipped</em> </td><td>- Indicate if the frame is horizontally flipped. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="5146b0fb9fe58353a6e0f8182151c00f"></a><!-- doxytag: member="JSprite::AddFrame" ref="5146b0fb9fe58353a6e0f8182151c00f" args="(JTexture *tex, float x, float y, float width, float height, bool flipped=false)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::AddFrame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">JTexture * </td>
|
|
<td class="paramname"> <em>tex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>height</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"> <em>flipped</em> = <code>false</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Add new animation 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>tex</em> </td><td>- Texture for this frame and the following frames. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>- X of the frame in texture. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y of the frame in texture. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>width</em> </td><td>- Width of the frame. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>height</em> </td><td>- Height of the frame. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>flipped</em> </td><td>- Indicate if the frame is horizontally flipped. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f04fa7900f974954d8c0462d3ac5551c"></a><!-- doxytag: member="JSprite::SetDuration" ref="f04fa7900f974954d8c0462d3ac5551c" args="(float duration)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetDuration </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>duration</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set playback duration for each 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> </td><td>- Playback duration (in second) for each frame. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="2c7508494691e8d7795e84e623f85885"></a><!-- doxytag: member="JSprite::GetCurrentFrameIndex" ref="2c7508494691e8d7795e84e623f85885" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int JSprite::GetCurrentFrameIndex </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get index of current frame.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Index of current frame. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="63d116265006aeebc94dac8f38a62807"></a><!-- doxytag: member="JSprite::SetCurrentFrameIndex" ref="63d116265006aeebc94dac8f38a62807" args="(int frame)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetCurrentFrameIndex </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>frame</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set current frame to a particular index.<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>frame</em> </td><td>- The new index of current frame. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8ada556e9e3748d7ceb833828cf53d2f"></a><!-- doxytag: member="JSprite::GetCurrentFrame" ref="8ada556e9e3748d7ceb833828cf53d2f" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_j_quad.html">JQuad</a>* JSprite::GetCurrentFrame </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get current frame image (quad).<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Quad object. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="01e450ab5aeaaf4bcd9bd0644face029"></a><!-- doxytag: member="JSprite::GetFrameCount" ref="01e450ab5aeaaf4bcd9bd0644face029" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int JSprite::GetFrameCount </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get numer of animation frames.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Numer of animation frames. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="3d525c742e533527e42d838b5bb2072f"></a><!-- doxytag: member="JSprite::GetFrame" ref="3d525c742e533527e42d838b5bb2072f" args="(int index)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_j_quad.html">JQuad</a>* JSprite::GetFrame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>index</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get frame image (quad).<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Quad object. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c55e9a51d7e9a18bb5e212c7ab54f176"></a><!-- doxytag: member="JSprite::RestartAnimation" ref="c55e9a51d7e9a18bb5e212c7ab54f176" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::RestartAnimation </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Restart animation.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6eea4abf66216b26d391a1551cbd1598"></a><!-- doxytag: member="JSprite::StartAnimation" ref="6eea4abf66216b26d391a1551cbd1598" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::StartAnimation </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Start animation.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="21bf7eb4647cccd40bafa7ca3c376dd0"></a><!-- doxytag: member="JSprite::StopAnimation" ref="21bf7eb4647cccd40bafa7ca3c376dd0" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::StopAnimation </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Stop animation.
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="cfcf746099ca280ac7dd9b8c16b7f4b9"></a><!-- doxytag: member="JSprite::IsAnimating" ref="cfcf746099ca280ac7dd9b8c16b7f4b9" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool JSprite::IsAnimating </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get animation status.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>animation status </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a827ef27e57ed8f8404f74c95e7dcdb3"></a><!-- doxytag: member="JSprite::Move" ref="a827ef27e57ed8f8404f74c95e7dcdb3" args="(float x, float y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::Move </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Move some distance from the current position.<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> </td><td>- X distance to move. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y distance to move. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c804db210beb1f6fd0af307a098654b1"></a><!-- doxytag: member="JSprite::SetPosition" ref="c804db210beb1f6fd0af307a098654b1" args="(float x, float y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em></td><td> </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 sprite.<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> </td><td>- X position. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y position. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="f6ffe7fbf20b6fee5f16ec9659efb7ed"></a><!-- doxytag: member="JSprite::SetX" ref="f6ffe7fbf20b6fee5f16ec9659efb7ed" args="(float x)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetX </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set X position of the sprite.<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> </td><td>- X position. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6a6185b5c251e42a324547c47b0395e7"></a><!-- doxytag: member="JSprite::SetY" ref="6a6185b5c251e42a324547c47b0395e7" args="(float y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetY </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set Y position of the sprite.<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>y</em> </td><td>- Y position. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="dc38bd89dfe47c2aa0d6658fdad80413"></a><!-- doxytag: member="JSprite::GetX" ref="dc38bd89dfe47c2aa0d6658fdad80413" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetX </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get X position of the sprite.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>X position. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="98dc9694e2d8bc094ceb3db0fc0f3206"></a><!-- doxytag: member="JSprite::GetY" ref="98dc9694e2d8bc094ceb3db0fc0f3206" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetY </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get Y position of the sprite.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Y position. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8805f11f05cf0f11bf5a3e62c6840ea7"></a><!-- doxytag: member="JSprite::GetXVelocity" ref="8805f11f05cf0f11bf5a3e62c6840ea7" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetXVelocity </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get X velocity.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>X velocity. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="3ea3a0b390846dd63bec966c4aab2304"></a><!-- doxytag: member="JSprite::GetYVelocity" ref="3ea3a0b390846dd63bec966c4aab2304" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetYVelocity </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get Y velocity.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Y velocity. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="47783c0d2b630603b67d96bd0e7f8517"></a><!-- doxytag: member="JSprite::SetAlpha" ref="47783c0d2b630603b67d96bd0e7f8517" args="(float alpha)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetAlpha </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>alpha</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set alpha value for rendering.<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>alpha</em> </td><td>- Alpha value. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="c99a62614087ea32708c4556d0851aaa"></a><!-- doxytag: member="JSprite::GetAlpha" ref="c99a62614087ea32708c4556d0851aaa" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetAlpha </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get alpha value.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Alpha value. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="dcb4fb7e619de8a88390f74b9aa3c39b"></a><!-- doxytag: member="JSprite::SetScale" ref="dcb4fb7e619de8a88390f74b9aa3c39b" args="(float hscale, float vscale)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetScale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>hscale</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>vscale</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set scale of the sprite.<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>hscale</em> </td><td>- Horizontal scale. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>vscale</em> </td><td>- Vertical scale. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="eb94c1ee508f37435c531293c4ff5cd7"></a><!-- doxytag: member="JSprite::SetScale" ref="eb94c1ee508f37435c531293c4ff5cd7" args="(float scale)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetScale </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>scale</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set scale of the sprite.<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> </td><td>- Scale for both horizontal and vertical dimension. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="995b569214511e70c2fba7cfabdc64da"></a><!-- doxytag: member="JSprite::GetScale" ref="995b569214511e70c2fba7cfabdc64da" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetScale </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get scale of the sprite.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Scale of horizontal (assume same as the vertical). </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="fcdd2f4739f43fe0daa2ef405fd87553"></a><!-- doxytag: member="JSprite::SetRotation" ref="fcdd2f4739f43fe0daa2ef405fd87553" args="(float rot)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetRotation </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>rot</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set rotation factor of the sprite.<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>rot</em> </td><td>- Rotation angle in radian. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="8b766100695abf64680b91811df16757"></a><!-- doxytag: member="JSprite::GetRotation" ref="8b766100695abf64680b91811df16757" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetRotation </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get rotation factor of the sprite.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Rotation angle in radian. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="db0405f1d4fc0a4fc90661cf28a6753a"></a><!-- doxytag: member="JSprite::SetSpeed" ref="db0405f1d4fc0a4fc90661cf28a6753a" args="(float speed)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetSpeed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>speed</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set moving speed of the sprite.<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>speed</em> </td><td>- Moving speed. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="da6cf28796db95c79723005cf99b138f"></a><!-- doxytag: member="JSprite::GetSpeed" ref="da6cf28796db95c79723005cf99b138f" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetSpeed </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get moving speed of the sprite.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Moving speed. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="801cb135f704a8d18bf1c992e660ddd8"></a><!-- doxytag: member="JSprite::SetDirection" ref="801cb135f704a8d18bf1c992e660ddd8" args="(float angle)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetDirection </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>angle</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set moving direction of the sprite.<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> </td><td>- Moving angle in radian. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6838f49241c8a6167c99283bd1c99273"></a><!-- doxytag: member="JSprite::SetDirection" ref="6838f49241c8a6167c99283bd1c99273" args="(float x, float y)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetDirection </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set moving direction of the sprite based on a targeting position.<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> </td><td>- X position of the target. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y position of the target. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="ac359f535a1431297644b4f60b049100"></a><!-- doxytag: member="JSprite::GetDirection" ref="ac359f535a1431297644b4f60b049100" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">float JSprite::GetDirection </td>
|
|
<td>(</td>
|
|
<td class="paramname"> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Get moving direction of the sprite.<p>
|
|
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Moving angle in radian. </dd></dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="7b6f90e8786d660f6f32820a3408e073"></a><!-- doxytag: member="JSprite::SetHotSpot" ref="7b6f90e8786d660f6f32820a3408e073" args="(float x, float y, int index=-1)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetHotSpot </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"> <em>index</em> = <code>-1</code></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set anchor point of a frame or all frames of the sprite. All rotation and collision operations are based on this anchor point.<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> </td><td>- X position of the anchor point. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>- Y position of the anchor point. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>- Frame index, -1 for all frames. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d8debf9c816d651c14ea98e08a946e2f"></a><!-- doxytag: member="JSprite::SetColor" ref="d8debf9c816d651c14ea98e08a946e2f" args="(PIXEL_TYPE color)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void JSprite::SetColor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">PIXEL_TYPE </td>
|
|
<td class="paramname"> <em>color</em> </td>
|
|
<td> ) </td>
|
|
<td width="100%"></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Set color of the sprite for rendering.<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> </td><td>- Color. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Oct 22 00:28:23 2007 for JGE++ by
|
|
<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>
|