classClass_1_1SpriteBase.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: SpriteBase Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">TorqueScript Reference
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.3.1 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="namespaceFunctions.html"><span>Functions</span></a></li>
  33. <li><a href="usergroup0.html"><span>Classes</span></a></li>
  34. </ul>
  35. </div>
  36. <div id="navrow2" class="tabs2">
  37. <ul class="tablist">
  38. <li><a href="classes.html"><span>Classes&#160;A-Z</span></a></li>
  39. </ul>
  40. </div>
  41. <div id="nav-path" class="navpath">
  42. <ul>
  43. <li class="navelem"><a class="el" href="namespaceClass.html">Class</a></li><li class="navelem"><a class="el" href="classClass_1_1SpriteBase.html">SpriteBase</a></li> </ul>
  44. </div>
  45. </div><!-- top -->
  46. <div class="header">
  47. <div class="summary">
  48. <a href="#pub-methods">Methods</a> &#124;
  49. <a href="classClass_1_1SpriteBase-members.html">List of all members</a> </div>
  50. <div class="headertitle">
  51. <div class="title">SpriteBase Class Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <table class="memberdecls">
  55. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  56. Methods</h2></td></tr>
  57. <tr class="memitem:ae8f3a782de22abb59715830c2e9177c3"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#ae8f3a782de22abb59715830c2e9177c3">SpriteBase::getAnimation</a> (...)</td></tr>
  58. <tr class="separator:ae8f3a782de22abb59715830c2e9177c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59. <tr class="memitem:a6ea375334231663d21ef4d45c0fb2c60"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a6ea375334231663d21ef4d45c0fb2c60">SpriteBase::getAnimationFrame</a> (...)</td></tr>
  60. <tr class="separator:a6ea375334231663d21ef4d45c0fb2c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a75e900b8d8478cbcf553ac49c11e28ec"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a75e900b8d8478cbcf553ac49c11e28ec">SpriteBase::getAnimationTime</a> (...)</td></tr>
  62. <tr class="separator:a75e900b8d8478cbcf553ac49c11e28ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a33dc4c8f756a567b7d85f63d502ea768"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a33dc4c8f756a567b7d85f63d502ea768">SpriteBase::getAnimationTimeScale</a> (...)</td></tr>
  64. <tr class="separator:a33dc4c8f756a567b7d85f63d502ea768"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a7e9eaaa89b4548b757dff43e2f46026a"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a7e9eaaa89b4548b757dff43e2f46026a">SpriteBase::getImage</a> (...)</td></tr>
  66. <tr class="separator:a7e9eaaa89b4548b757dff43e2f46026a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:aa54dca12b34701eb597d52e3a418a959"><td class="memItemLeft" align="right" valign="top">S32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#aa54dca12b34701eb597d52e3a418a959">SpriteBase::getImageFrame</a> (...)</td></tr>
  68. <tr class="separator:aa54dca12b34701eb597d52e3a418a959"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:adae298059d5ab1d3ed23b4c15c5d10bd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#adae298059d5ab1d3ed23b4c15c5d10bd">SpriteBase::getIsAnimationFinished</a> (...)</td></tr>
  70. <tr class="separator:adae298059d5ab1d3ed23b4c15c5d10bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a8754125e5f2c1841942f4f2ca72207b9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a8754125e5f2c1841942f4f2ca72207b9">SpriteBase::isStaticFrameProvider</a> (...)</td></tr>
  72. <tr class="separator:a8754125e5f2c1841942f4f2ca72207b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a5a957fb09e6b3a4afdb7b687f7fb598f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a5a957fb09e6b3a4afdb7b687f7fb598f">SpriteBase::pauseAnimation</a> (...)</td></tr>
  74. <tr class="separator:a5a957fb09e6b3a4afdb7b687f7fb598f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a85800dd6cf860471e7587b8a84db8b91"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a85800dd6cf860471e7587b8a84db8b91">SpriteBase::playAnimation</a> (...)</td></tr>
  76. <tr class="separator:a85800dd6cf860471e7587b8a84db8b91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a3029c6670c7816e59bd4208d99f04eca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a3029c6670c7816e59bd4208d99f04eca">SpriteBase::setAnimationFrame</a> (...)</td></tr>
  78. <tr class="separator:a3029c6670c7816e59bd4208d99f04eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a2a757f50e5df90f0fbf1b1a228299a6b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a2a757f50e5df90f0fbf1b1a228299a6b">SpriteBase::setAnimationTimeScale</a> (...)</td></tr>
  80. <tr class="separator:a2a757f50e5df90f0fbf1b1a228299a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:ad12306edae1db0c1ce880ee104e960e5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#ad12306edae1db0c1ce880ee104e960e5">SpriteBase::setImage</a> (...)</td></tr>
  82. <tr class="separator:ad12306edae1db0c1ce880ee104e960e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a4a524da661eba41d57fa47d5cf071c6a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a4a524da661eba41d57fa47d5cf071c6a">SpriteBase::setImageFrame</a> (...)</td></tr>
  84. <tr class="separator:a4a524da661eba41d57fa47d5cf071c6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a76db1e853b6e9b0a898154f88ebd7170"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classClass_1_1SpriteBase.html#a76db1e853b6e9b0a898154f88ebd7170">SpriteBase::stopAnimation</a> (...)</td></tr>
  86. <tr class="separator:a76db1e853b6e9b0a898154f88ebd7170"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table>
  88. <h2 class="groupheader">Methods</h2>
  89. <a class="anchor" id="ae8f3a782de22abb59715830c2e9177c3"></a>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">const char* SpriteBase::getAnimation </td>
  95. <td>(</td>
  96. <td class="paramtype">&#160;</td>
  97. <td class="paramname"><em>...</em></td><td>)</td>
  98. <td></td>
  99. </tr>
  100. </table>
  101. </div><div class="memdoc">
  102. </div>
  103. </div>
  104. <a class="anchor" id="a6ea375334231663d21ef4d45c0fb2c60"></a>
  105. <div class="memitem">
  106. <div class="memproto">
  107. <table class="memname">
  108. <tr>
  109. <td class="memname">S32 SpriteBase::getAnimationFrame </td>
  110. <td>(</td>
  111. <td class="paramtype">&#160;</td>
  112. <td class="paramname"><em>...</em></td><td>)</td>
  113. <td></td>
  114. </tr>
  115. </table>
  116. </div><div class="memdoc">
  117. </div>
  118. </div>
  119. <a class="anchor" id="a75e900b8d8478cbcf553ac49c11e28ec"></a>
  120. <div class="memitem">
  121. <div class="memproto">
  122. <table class="memname">
  123. <tr>
  124. <td class="memname">F32 SpriteBase::getAnimationTime </td>
  125. <td>(</td>
  126. <td class="paramtype">&#160;</td>
  127. <td class="paramname"><em>...</em></td><td>)</td>
  128. <td></td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. </div>
  133. </div>
  134. <a class="anchor" id="a33dc4c8f756a567b7d85f63d502ea768"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <table class="memname">
  138. <tr>
  139. <td class="memname">F32 SpriteBase::getAnimationTimeScale </td>
  140. <td>(</td>
  141. <td class="paramtype">&#160;</td>
  142. <td class="paramname"><em>...</em></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. </div>
  148. </div>
  149. <a class="anchor" id="a7e9eaaa89b4548b757dff43e2f46026a"></a>
  150. <div class="memitem">
  151. <div class="memproto">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">const char* SpriteBase::getImage </td>
  155. <td>(</td>
  156. <td class="paramtype">&#160;</td>
  157. <td class="paramname"><em>...</em></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <a class="anchor" id="aa54dca12b34701eb597d52e3a418a959"></a>
  165. <div class="memitem">
  166. <div class="memproto">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">S32 SpriteBase::getImageFrame </td>
  170. <td>(</td>
  171. <td class="paramtype">&#160;</td>
  172. <td class="paramname"><em>...</em></td><td>)</td>
  173. <td></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <a class="anchor" id="adae298059d5ab1d3ed23b4c15c5d10bd"></a>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">bool SpriteBase::getIsAnimationFinished </td>
  185. <td>(</td>
  186. <td class="paramtype">&#160;</td>
  187. <td class="paramname"><em>...</em></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. </div>
  193. </div>
  194. <a class="anchor" id="a8754125e5f2c1841942f4f2ca72207b9"></a>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">bool SpriteBase::isStaticFrameProvider </td>
  200. <td>(</td>
  201. <td class="paramtype">&#160;</td>
  202. <td class="paramname"><em>...</em></td><td>)</td>
  203. <td></td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. </div>
  208. </div>
  209. <a class="anchor" id="a5a957fb09e6b3a4afdb7b687f7fb598f"></a>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">void SpriteBase::pauseAnimation </td>
  215. <td>(</td>
  216. <td class="paramtype">&#160;</td>
  217. <td class="paramname"><em>...</em></td><td>)</td>
  218. <td></td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. </div>
  223. </div>
  224. <a class="anchor" id="a85800dd6cf860471e7587b8a84db8b91"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">bool SpriteBase::playAnimation </td>
  230. <td>(</td>
  231. <td class="paramtype">&#160;</td>
  232. <td class="paramname"><em>...</em></td><td>)</td>
  233. <td></td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. </div>
  238. </div>
  239. <a class="anchor" id="a3029c6670c7816e59bd4208d99f04eca"></a>
  240. <div class="memitem">
  241. <div class="memproto">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">void SpriteBase::setAnimationFrame </td>
  245. <td>(</td>
  246. <td class="paramtype">&#160;</td>
  247. <td class="paramname"><em>...</em></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </div><div class="memdoc">
  252. </div>
  253. </div>
  254. <a class="anchor" id="a2a757f50e5df90f0fbf1b1a228299a6b"></a>
  255. <div class="memitem">
  256. <div class="memproto">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">void SpriteBase::setAnimationTimeScale </td>
  260. <td>(</td>
  261. <td class="paramtype">&#160;</td>
  262. <td class="paramname"><em>...</em></td><td>)</td>
  263. <td></td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. </div>
  268. </div>
  269. <a class="anchor" id="ad12306edae1db0c1ce880ee104e960e5"></a>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="memname">
  273. <tr>
  274. <td class="memname">bool SpriteBase::setImage </td>
  275. <td>(</td>
  276. <td class="paramtype">&#160;</td>
  277. <td class="paramname"><em>...</em></td><td>)</td>
  278. <td></td>
  279. </tr>
  280. </table>
  281. </div><div class="memdoc">
  282. </div>
  283. </div>
  284. <a class="anchor" id="a4a524da661eba41d57fa47d5cf071c6a"></a>
  285. <div class="memitem">
  286. <div class="memproto">
  287. <table class="memname">
  288. <tr>
  289. <td class="memname">bool <a class="elRef" doxygen="Torque2D.tag:../../torque2D/html/" href="../../torque2D/html/class_image_frame_provider_core.html#ae5dd46aad47a2109fba6ecae78d4510a">SpriteBase::setImageFrame</a> </td>
  290. <td>(</td>
  291. <td class="paramtype">&#160;</td>
  292. <td class="paramname"><em>...</em></td><td>)</td>
  293. <td></td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. </div>
  298. </div>
  299. <a class="anchor" id="a76db1e853b6e9b0a898154f88ebd7170"></a>
  300. <div class="memitem">
  301. <div class="memproto">
  302. <table class="memname">
  303. <tr>
  304. <td class="memname">void SpriteBase::stopAnimation </td>
  305. <td>(</td>
  306. <td class="paramtype">&#160;</td>
  307. <td class="paramname"><em>...</em></td><td>)</td>
  308. <td></td>
  309. </tr>
  310. </table>
  311. </div><div class="memdoc">
  312. </div>
  313. </div>
  314. </div><!-- contents -->
  315. <!-- start footer part -->
  316. <hr class="footer"/><address class="footer"><small>
  317. Generated on Mon Apr 15 2013 10:42:56 for TorqueScript Reference by &#160;<a href="http://www.doxygen.org/index.html">
  318. <img class="footer" src="doxygen.png" alt="doxygen"/>
  319. </a> 1.8.3.1
  320. </small></address>
  321. </body>
  322. </html>