classRenderProxy.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473
  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: RenderProxy 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. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classRenderProxy-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">RenderProxy Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classSimObject.html">SimObject</a>.</p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:a9931a7cc9203bc2829ac7f877a84272f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a9931a7cc9203bc2829ac7f877a84272f">getAnimation</a> ()</td></tr>
  60. <tr class="separator:a9931a7cc9203bc2829ac7f877a84272f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a929e352e707bec4a0acd8fa84e22bbcd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a929e352e707bec4a0acd8fa84e22bbcd">getAnimationFrame</a> ()</td></tr>
  62. <tr class="separator:a929e352e707bec4a0acd8fa84e22bbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ac74847657014520d9da68bdfb911037c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#ac74847657014520d9da68bdfb911037c">getAnimationTime</a> ()</td></tr>
  64. <tr class="separator:ac74847657014520d9da68bdfb911037c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a0ed4e78a041748252573309e10a966da"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a0ed4e78a041748252573309e10a966da">getAnimationTimeScale</a> ()</td></tr>
  66. <tr class="separator:a0ed4e78a041748252573309e10a966da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a5306210649eb454064d7f4863d68eb99"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a5306210649eb454064d7f4863d68eb99">getImage</a> ()</td></tr>
  68. <tr class="separator:a5306210649eb454064d7f4863d68eb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a7ceb4080fb16c0f85a8011cc5db618a1"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a7ceb4080fb16c0f85a8011cc5db618a1">getImageFrame</a> ()</td></tr>
  70. <tr class="separator:a7ceb4080fb16c0f85a8011cc5db618a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a7dc02f8ddc441a80d397be3f295a0ce9"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a7dc02f8ddc441a80d397be3f295a0ce9">getIsAnimationFinished</a> ()</td></tr>
  72. <tr class="separator:a7dc02f8ddc441a80d397be3f295a0ce9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a4b3aa591264f3398e4a7100d9d76ad58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a4b3aa591264f3398e4a7100d9d76ad58">isStaticFrameProvider</a> ()</td></tr>
  74. <tr class="separator:a4b3aa591264f3398e4a7100d9d76ad58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a50a0a39c4b496964ae39dc1cf6bc0205"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a50a0a39c4b496964ae39dc1cf6bc0205">pauseAnimation</a> (bool enable)</td></tr>
  76. <tr class="separator:a50a0a39c4b496964ae39dc1cf6bc0205"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a7d3afdb0571cb230f0094a328682691b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a7d3afdb0571cb230f0094a328682691b">playAnimation</a> (string animationAssetId)</td></tr>
  78. <tr class="separator:a7d3afdb0571cb230f0094a328682691b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:aab0b1a423b173bc7f83e19bb4a437d99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#aab0b1a423b173bc7f83e19bb4a437d99">setAnimationFrame</a> (int frame)</td></tr>
  80. <tr class="separator:aab0b1a423b173bc7f83e19bb4a437d99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:aea03a067699dfb3e1055c8b59a1a2090"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#aea03a067699dfb3e1055c8b59a1a2090">setAnimationTimeScale</a> (float timeScale)</td></tr>
  82. <tr class="separator:aea03a067699dfb3e1055c8b59a1a2090"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ab9a305372441b49a9ea75a897251af81"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#ab9a305372441b49a9ea75a897251af81">setImage</a> (string imageAssetId,[int frame])</td></tr>
  84. <tr class="separator:ab9a305372441b49a9ea75a897251af81"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a8a1e56ed67fe805f175989eb89ca58be"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a8a1e56ed67fe805f175989eb89ca58be">setImageFrame</a> (int frame)</td></tr>
  86. <tr class="separator:a8a1e56ed67fe805f175989eb89ca58be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a84c1367b486680bcf22987540e217cfb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRenderProxy.html#a84c1367b486680bcf22987540e217cfb">stopAnimation</a> ()</td></tr>
  88. <tr class="separator:a84c1367b486680bcf22987540e217cfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="inherit_header pub_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  90. <tr class="memitem:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1c1f9babb145bfdf63e60223663dff3c">call</a> (functionName,[args]*)</td></tr>
  91. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a3b4f0f3ccdfa27b8008f8559a83539bc">clone</a> ([bool copyDynamicFields?=false]?)</td></tr>
  93. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a7a4721d0a51e952c211e9b0fea4d8090">delete</a> ()</td></tr>
  95. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#accd2600060dbaee3a3b41aed4034c63c">dump</a> ()</td></tr>
  97. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a1810f5aba25efd242c24232c2c2bbd1a">dumpClassHierarchy</a> ()</td></tr>
  99. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adeaebc2111072105cbb6961df917d223">getClassName</a> ()</td></tr>
  101. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <tr class="memitem:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#afbb3b5d0356df264b7343d135b697bcf">getClassNamespace</a> ()</td></tr>
  103. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a771f0adf4c566c3ac2f7c5c32e75d43c">getDynamicField</a> (index)</td></tr>
  105. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#affd866a31305bc1e70c572b2be76069b">getDynamicFieldCount</a> ()</td></tr>
  107. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af219f6b5498fbd8671e298303c28b1dc">getField</a> (int index)</td></tr>
  109. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0d14fc4334b31b14e243de86cc1609a4">getFieldCount</a> ()</td></tr>
  111. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a6c87209e1a998d8b35e1cde74839bfcc">getFieldType</a> (fieldName)</td></tr>
  113. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#adf03af9303912906eada72ccf10115e8">getFieldValue</a> (fieldName)</td></tr>
  115. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ad35d7fe358fa34d2eba803c7506791f3">getGroup</a> ()</td></tr>
  117. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a67283be3f45257d1e0c474c563ebb6b6">getId</a> ()</td></tr>
  119. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a137797d39611f3f3108b30852d28622c">getInternalName</a> ()</td></tr>
  121. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a510119ff902e4e96165a7475370be836">getName</a> ()</td></tr>
  123. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa71cf6ba84b0de85019204261a9136b7">getProgenitorFile</a> ()</td></tr>
  125. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a0f693104a44b07db870d4e54f2db4c08">getSuperClassNamespace</a> ()</td></tr>
  127. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aec389cbe6ac7aff8ce7196e7dbc007df">getType</a> ()</td></tr>
  129. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#af4da33de69819e293d90cf52fcbda6da">isChildOfGroup</a> ()</td></tr>
  131. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a35273f559aecabece437c22ee8aee443">isMemberOfClass</a> (string classname)</td></tr>
  133. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8a1d5ac5403526378c7abb0916c55c3c">isMethod</a> (const char *methodName)</td></tr>
  135. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a8ca0e6f21ff100da6bcd59f51d34fb8e">isMethod</a> (string method name)</td></tr>
  137. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9fed7ee24702928365ad45e6eaba4d12">isTimerActive</a> ()</td></tr>
  139. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa92c3478d4ff5780f0f027598480d772">save</a> (<a class="el" href="group__FileSystemFunctions.html#ga71bebb057a0d6ad1c522cd19584b51d9">fileName</a>,[selectedOnly]?)</td></tr>
  141. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aabc265010a7a59dcec211ddd8f0ac5a7">schedule</a> (time, command,[arg]*)</td></tr>
  143. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa3e15ecdee7ab3ece234913bc4e783c0">setClassNamespace</a> ()</td></tr>
  145. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ae099b2a1810ca2e23ac11d239ae0197e">setFieldValue</a> (fieldName, value)</td></tr>
  147. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5aaca360a719feabae0e4e57b921deae">setInternalName</a> (string InternalName)</td></tr>
  149. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a4f673cd959711ae09927e7c44dae5fdb">setName</a> (newName)</td></tr>
  151. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa8f68d1e6d8c6601c39b3f676f0e9c70">setProgenitorFile</a> (file)</td></tr>
  153. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a9cbf471b97387d5bdefb88f92094ad54">setSuperClassNamespace</a> ()</td></tr>
  155. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#a5447439ba5620b2ac00dc0ef97ef2142">startTimer</a> (callbackFunction, float timePeriod,[repeat]?)</td></tr>
  157. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#aa6f6bfef028c7b053444cbd48567d286">stopTimer</a> ()</td></tr>
  159. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. </table><table class="memberdecls">
  161. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  162. Additional Inherited Members</h2></td></tr>
  163. <tr class="inherit_header pub_static_methods_classSimObject"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classSimObject')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classSimObject.html">SimObject</a></td></tr>
  164. <tr class="memitem:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memItemLeft" align="right" valign="top">static S32 QSORT_CALLBACK&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classSimObject.html#ac7926551c6df020f767d8d87f5a3d575">compareFields</a> (const void *a, const void *b)</td></tr>
  165. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. </table>
  167. <h2 class="groupheader">Member Function Documentation</h2>
  168. <a class="anchor" id="a9931a7cc9203bc2829ac7f877a84272f"></a>
  169. <div class="memitem">
  170. <div class="memproto">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">string getAnimation </td>
  174. <td>(</td>
  175. <td class="paramname"></td><td>)</td>
  176. <td></td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>Gets current animation asset Id. </p>
  181. <dl class="section return"><dt>Returns</dt><dd>(string AnimationAssetId) The current animation asset Id. </dd></dl>
  182. </div>
  183. </div>
  184. <a class="anchor" id="a929e352e707bec4a0acd8fa84e22bbcd"></a>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">int getAnimationFrame </td>
  190. <td>(</td>
  191. <td class="paramname"></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Gets current animation frame. </p>
  197. <dl class="section return"><dt>Returns</dt><dd>(int frame) The current animation frame </dd></dl>
  198. </div>
  199. </div>
  200. <a class="anchor" id="ac74847657014520d9da68bdfb911037c"></a>
  201. <div class="memitem">
  202. <div class="memproto">
  203. <table class="memname">
  204. <tr>
  205. <td class="memname">float getAnimationTime </td>
  206. <td>(</td>
  207. <td class="paramname"></td><td>)</td>
  208. <td></td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. <p>Gets current animation time. </p>
  213. <dl class="section return"><dt>Returns</dt><dd>(float time) The current animation time </dd></dl>
  214. </div>
  215. </div>
  216. <a class="anchor" id="a0ed4e78a041748252573309e10a966da"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <table class="memname">
  220. <tr>
  221. <td class="memname">float getAnimationTimeScale </td>
  222. <td>(</td>
  223. <td class="paramname"></td><td>)</td>
  224. <td></td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Get the animation time scale for this render-proxy. </p>
  229. <dl class="section return"><dt>Returns</dt><dd>(float) Returns the animation time scale for this render-proxy. </dd></dl>
  230. </div>
  231. </div>
  232. <a class="anchor" id="a5306210649eb454064d7f4863d68eb99"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <table class="memname">
  236. <tr>
  237. <td class="memname">string getImage </td>
  238. <td>(</td>
  239. <td class="paramname"></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </div><div class="memdoc">
  244. <p>Gets current image asset Id. </p>
  245. <dl class="section return"><dt>Returns</dt><dd>(string imageAssetId) The image being displayed </dd></dl>
  246. </div>
  247. </div>
  248. <a class="anchor" id="a7ceb4080fb16c0f85a8011cc5db618a1"></a>
  249. <div class="memitem">
  250. <div class="memproto">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">int getImageFrame </td>
  254. <td>(</td>
  255. <td class="paramname"></td><td>)</td>
  256. <td></td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>Gets current image Frame. </p>
  261. <dl class="section return"><dt>Returns</dt><dd>(int frame) The frame currently being displayed </dd></dl>
  262. </div>
  263. </div>
  264. <a class="anchor" id="a7dc02f8ddc441a80d397be3f295a0ce9"></a>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname">bool getIsAnimationFinished </td>
  270. <td>(</td>
  271. <td class="paramname"></td><td>)</td>
  272. <td></td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. <p>Checks animation status. </p>
  277. <dl class="section return"><dt>Returns</dt><dd>(bool finished) Whether or not the animation is finished </dd></dl>
  278. </div>
  279. </div>
  280. <a class="anchor" id="a4b3aa591264f3398e4a7100d9d76ad58"></a>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="memname">
  284. <tr>
  285. <td class="memname">bool isStaticFrameProvider </td>
  286. <td>(</td>
  287. <td class="paramname"></td><td>)</td>
  288. <td></td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <p>Gets whether the render-proxy is in static or dynamic (animated)mode. </p>
  293. <dl class="section return"><dt>Returns</dt><dd>Returns whether the render-proxy is in static or dynamic (animated)mode. </dd></dl>
  294. </div>
  295. </div>
  296. <a class="anchor" id="a50a0a39c4b496964ae39dc1cf6bc0205"></a>
  297. <div class="memitem">
  298. <div class="memproto">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">void pauseAnimation </td>
  302. <td>(</td>
  303. <td class="paramtype">bool&#160;</td>
  304. <td class="paramname"><em>enable</em></td><td>)</td>
  305. <td></td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Pause the current animation </p>
  310. <dl class="params"><dt>Parameters</dt><dd>
  311. <table class="params">
  312. <tr><td class="paramname">enable</td><td>If true, pause the animation. If false, continue animating </td></tr>
  313. </table>
  314. </dd>
  315. </dl>
  316. </div>
  317. </div>
  318. <a class="anchor" id="a7d3afdb0571cb230f0094a328682691b"></a>
  319. <div class="memitem">
  320. <div class="memproto">
  321. <table class="memname">
  322. <tr>
  323. <td class="memname">bool playAnimation </td>
  324. <td>(</td>
  325. <td class="paramtype">string&#160;</td>
  326. <td class="paramname"><em>animationAssetId</em></td><td>)</td>
  327. <td></td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Plays an animation. </p>
  332. <dl class="params"><dt>Parameters</dt><dd>
  333. <table class="params">
  334. <tr><td class="paramname">animationAssetId</td><td>The animation asset Id to play </td></tr>
  335. </table>
  336. </dd>
  337. </dl>
  338. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
  339. </div>
  340. </div>
  341. <a class="anchor" id="aab0b1a423b173bc7f83e19bb4a437d99"></a>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname">void setAnimationFrame </td>
  347. <td>(</td>
  348. <td class="paramtype">int&#160;</td>
  349. <td class="paramname"><em>frame</em></td><td>)</td>
  350. <td></td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Sets the current animation frame. </p>
  355. <dl class="params"><dt>Parameters</dt><dd>
  356. <table class="params">
  357. <tr><td class="paramname">frame</td><td>Which frame of the animation to display </td></tr>
  358. </table>
  359. </dd>
  360. </dl>
  361. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  362. </div>
  363. </div>
  364. <a class="anchor" id="aea03a067699dfb3e1055c8b59a1a2090"></a>
  365. <div class="memitem">
  366. <div class="memproto">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">void setAnimationTimeScale </td>
  370. <td>(</td>
  371. <td class="paramtype">float&#160;</td>
  372. <td class="paramname"><em>timeScale</em></td><td>)</td>
  373. <td></td>
  374. </tr>
  375. </table>
  376. </div><div class="memdoc">
  377. <p>Change the rate of animation. </p>
  378. <dl class="params"><dt>Parameters</dt><dd>
  379. <table class="params">
  380. <tr><td class="paramname">timeScale</td><td>Value which will scale the frame animation speed. 1 by default. </td></tr>
  381. </table>
  382. </dd>
  383. </dl>
  384. </div>
  385. </div>
  386. <a class="anchor" id="ab9a305372441b49a9ea75a897251af81"></a>
  387. <div class="memitem">
  388. <div class="memproto">
  389. <table class="memname">
  390. <tr>
  391. <td class="memname">bool setImage </td>
  392. <td>(</td>
  393. <td class="paramtype">string&#160;</td>
  394. <td class="paramname"><em>imageAssetId</em></td><td>)</td>
  395. <td></td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Sets imageAssetId/Frame. </p>
  400. <dl class="params"><dt>Parameters</dt><dd>
  401. <table class="params">
  402. <tr><td class="paramname">imageAssetId</td><td>The image asset Id to display </td></tr>
  403. <tr><td class="paramname">frame</td><td>The frame of the image to display </td></tr>
  404. </table>
  405. </dd>
  406. </dl>
  407. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
  408. </div>
  409. </div>
  410. <a class="anchor" id="a8a1e56ed67fe805f175989eb89ca58be"></a>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">bool setImageFrame </td>
  416. <td>(</td>
  417. <td class="paramtype">int&#160;</td>
  418. <td class="paramname"><em>frame</em></td><td>)</td>
  419. <td></td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>Sets image frame. </p>
  424. <dl class="params"><dt>Parameters</dt><dd>
  425. <table class="params">
  426. <tr><td class="paramname">frame</td><td>The frame to display </td></tr>
  427. </table>
  428. </dd>
  429. </dl>
  430. <dl class="section return"><dt>Returns</dt><dd>Returns true on success. </dd></dl>
  431. </div>
  432. </div>
  433. <a class="anchor" id="a84c1367b486680bcf22987540e217cfb"></a>
  434. <div class="memitem">
  435. <div class="memproto">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname">void stopAnimation </td>
  439. <td>(</td>
  440. <td class="paramname"></td><td>)</td>
  441. <td></td>
  442. </tr>
  443. </table>
  444. </div><div class="memdoc">
  445. <p>Stop the current animation </p>
  446. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  447. </div>
  448. </div>
  449. </div><!-- contents -->
  450. <!-- start footer part -->
  451. <hr class="footer"/><address class="footer"><small>
  452. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  453. <img class="footer" src="doxygen.png" alt="doxygen"/>
  454. </a> 1.8.3.1
  455. </small></address>
  456. </body>
  457. </html>