classImageAsset.html 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972
  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: ImageAsset 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="classImageAsset-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">ImageAsset Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classAssetBase.html">AssetBase</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:a89761268277b6a304e39e742cc53cb14"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a89761268277b6a304e39e742cc53cb14">addExplicitCell</a> (int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight)</td></tr>
  60. <tr class="separator:a89761268277b6a304e39e742cc53cb14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:ace05af2d367962adebace1e8332c328c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#ace05af2d367962adebace1e8332c328c">clearExplicitCells</a> ()</td></tr>
  62. <tr class="separator:ace05af2d367962adebace1e8332c328c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:ad28721af7e6bac798773a7c11039516b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#ad28721af7e6bac798773a7c11039516b">getCellCountX</a> ()</td></tr>
  64. <tr class="separator:ad28721af7e6bac798773a7c11039516b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a25f2445a474e1f3af1be733e38ec11ce"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a25f2445a474e1f3af1be733e38ec11ce">getCellCountY</a> ()</td></tr>
  66. <tr class="separator:a25f2445a474e1f3af1be733e38ec11ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:a3f3d4449bfdd018eab1dd272a28da923"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a3f3d4449bfdd018eab1dd272a28da923">getCellHeight</a> ()</td></tr>
  68. <tr class="separator:a3f3d4449bfdd018eab1dd272a28da923"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a83487022db1f231e6d7b306a03dd6679"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a83487022db1f231e6d7b306a03dd6679">getCellOffsetX</a> ()</td></tr>
  70. <tr class="separator:a83487022db1f231e6d7b306a03dd6679"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a124a689acee8249a51c472eb9c0cfb74"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a124a689acee8249a51c472eb9c0cfb74">getCellOffsetY</a> ()</td></tr>
  72. <tr class="separator:a124a689acee8249a51c472eb9c0cfb74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a2cfa18dd3b3f6367ba531645dfee1b05"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a2cfa18dd3b3f6367ba531645dfee1b05">getCellRowOrder</a> ()</td></tr>
  74. <tr class="separator:a2cfa18dd3b3f6367ba531645dfee1b05"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:af69760426104338b44f17c7edbf31580"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#af69760426104338b44f17c7edbf31580">getCellStrideX</a> ()</td></tr>
  76. <tr class="separator:af69760426104338b44f17c7edbf31580"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a2c751c09813b6f3cdba40d4068122684"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a2c751c09813b6f3cdba40d4068122684">getCellStrideY</a> ()</td></tr>
  78. <tr class="separator:a2c751c09813b6f3cdba40d4068122684"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a28244879294fd8e42fea5f67149b44d5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a28244879294fd8e42fea5f67149b44d5">getCellWidth</a> ()</td></tr>
  80. <tr class="separator:a28244879294fd8e42fea5f67149b44d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a868b408711e9625e1d5d1b5febb40734"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a868b408711e9625e1d5d1b5febb40734">getExplicitCellCount</a> ()</td></tr>
  82. <tr class="separator:a868b408711e9625e1d5d1b5febb40734"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:af446a6d01315daca721b4b7c6695bfe4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#af446a6d01315daca721b4b7c6695bfe4">getFilterMode</a> ()</td></tr>
  84. <tr class="separator:af446a6d01315daca721b4b7c6695bfe4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:abfd277e66cb84f3fe518d814054152e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#abfd277e66cb84f3fe518d814054152e6">getForce16Bit</a> ()</td></tr>
  86. <tr class="separator:abfd277e66cb84f3fe518d814054152e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a134a0d63775c91ff4a3ab9fa8ac7438a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a134a0d63775c91ff4a3ab9fa8ac7438a">getFrameCount</a> ()</td></tr>
  88. <tr class="separator:a134a0d63775c91ff4a3ab9fa8ac7438a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a36eb1343e434e55871f47eafb7496a0c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a36eb1343e434e55871f47eafb7496a0c">getFrameSize</a> (int frame)</td></tr>
  90. <tr class="separator:a36eb1343e434e55871f47eafb7496a0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:acd444497c1a023cefb08e89990f84162"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#acd444497c1a023cefb08e89990f84162">getImageFile</a> ()</td></tr>
  92. <tr class="separator:acd444497c1a023cefb08e89990f84162"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:afa384d0e84f13612d4f7847f77242afc"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#afa384d0e84f13612d4f7847f77242afc">getImageHeight</a> ()</td></tr>
  94. <tr class="separator:afa384d0e84f13612d4f7847f77242afc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ac5e183e466cec9e8f813a8478ce233b9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#ac5e183e466cec9e8f813a8478ce233b9">getImageSize</a> ()</td></tr>
  96. <tr class="separator:ac5e183e466cec9e8f813a8478ce233b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:aded69ad10c2446f9225fb3be50077c8f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#aded69ad10c2446f9225fb3be50077c8f">getImageWidth</a> ()</td></tr>
  98. <tr class="separator:aded69ad10c2446f9225fb3be50077c8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ae636c1ff92c472c26b342c7444fc3047"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#ae636c1ff92c472c26b342c7444fc3047">getIsImagePOT</a> ()</td></tr>
  100. <tr class="separator:ae636c1ff92c472c26b342c7444fc3047"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ac76a3c58e047c46c251095105a2e8b15"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#ac76a3c58e047c46c251095105a2e8b15">insertExplicitCell</a> (int cellIndex, int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight)</td></tr>
  102. <tr class="separator:ac76a3c58e047c46c251095105a2e8b15"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a3e5d9f8eef4c7bbb381dd46c30906aac"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a3e5d9f8eef4c7bbb381dd46c30906aac">removeExplicitCell</a> (int cellIndex)</td></tr>
  104. <tr class="separator:a3e5d9f8eef4c7bbb381dd46c30906aac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a1b2cf41bc1dcdad3b5f5cfccde762dfa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a1b2cf41bc1dcdad3b5f5cfccde762dfa">setCellCountX</a> (countX)</td></tr>
  106. <tr class="separator:a1b2cf41bc1dcdad3b5f5cfccde762dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a74cc4e3d67657f28e850c40de4fa30e0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a74cc4e3d67657f28e850c40de4fa30e0">setCellCountY</a> (countY)</td></tr>
  108. <tr class="separator:a74cc4e3d67657f28e850c40de4fa30e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a1fe763c3e58593e398905989d2260098"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a1fe763c3e58593e398905989d2260098">setCellHeight</a> (Height)</td></tr>
  110. <tr class="separator:a1fe763c3e58593e398905989d2260098"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a0c69218226dd4bf63505c239ab3b261d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a0c69218226dd4bf63505c239ab3b261d">setCellOffsetX</a> (offsetX)</td></tr>
  112. <tr class="separator:a0c69218226dd4bf63505c239ab3b261d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a4e660709e2f9e8ec43cf8876085856fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a4e660709e2f9e8ec43cf8876085856fb">setCellOffsetY</a> (offsetY)</td></tr>
  114. <tr class="separator:a4e660709e2f9e8ec43cf8876085856fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a385e3aaf527ad86225b7b53223b782f4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a385e3aaf527ad86225b7b53223b782f4">setCellRowOrder</a> (rowOrder?)</td></tr>
  116. <tr class="separator:a385e3aaf527ad86225b7b53223b782f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a79377caef373282289238d3d82b460f9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a79377caef373282289238d3d82b460f9">setCellStrideX</a> (strideX)</td></tr>
  118. <tr class="separator:a79377caef373282289238d3d82b460f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a695a30cd50d00c538dc8f2d225f3a1ea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a695a30cd50d00c538dc8f2d225f3a1ea">setCellStrideY</a> (strideY)</td></tr>
  120. <tr class="separator:a695a30cd50d00c538dc8f2d225f3a1ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:adbba11ca7c89cfeac612bf36ea6de895"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#adbba11ca7c89cfeac612bf36ea6de895">setCellWidth</a> (Width)</td></tr>
  122. <tr class="separator:adbba11ca7c89cfeac612bf36ea6de895"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:afa1f934a502625979286f337cdf4d6df"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#afa1f934a502625979286f337cdf4d6df">setExplicitCell</a> (int cellIndex, int cellOffsetX, int cellOffsetY, int cellWidth, int cellHeight)</td></tr>
  124. <tr class="separator:afa1f934a502625979286f337cdf4d6df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a3ef9ea57ef0585d49d323889549750a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#a3ef9ea57ef0585d49d323889549750a3">setFilterMode</a> (mode)</td></tr>
  126. <tr class="separator:a3ef9ea57ef0585d49d323889549750a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ac449323fec68260724288c149a12c05d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#ac449323fec68260724288c149a12c05d">setForce16Bit</a> (force16Bit?)</td></tr>
  128. <tr class="separator:ac449323fec68260724288c149a12c05d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:af4543314564a8aaf4a5f6ab3d9b16d27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classImageAsset.html#af4543314564a8aaf4a5f6ab3d9b16d27">setImageFile</a> (ImageFile)</td></tr>
  130. <tr class="separator:af4543314564a8aaf4a5f6ab3d9b16d27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="inherit_header pub_methods_classAssetBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAssetBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classAssetBase.html">AssetBase</a></td></tr>
  132. <tr class="memitem:af221d4adee530465ded020e194496030 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#af221d4adee530465ded020e194496030">getAssetId</a> ()</td></tr>
  133. <tr class="separator:af221d4adee530465ded020e194496030 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAssetBase.html#a00b3d3cf0e2bb08d4c268f34610bfaa6">refreshAsset</a> ()</td></tr>
  135. <tr class="separator:a00b3d3cf0e2bb08d4c268f34610bfaa6 inherit pub_methods_classAssetBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <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>
  137. <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>
  138. <tr class="separator:a1c1f9babb145bfdf63e60223663dff3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:a3b4f0f3ccdfa27b8008f8559a83539bc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <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>
  142. <tr class="separator:a7a4721d0a51e952c211e9b0fea4d8090 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <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>
  144. <tr class="separator:accd2600060dbaee3a3b41aed4034c63c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <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>
  146. <tr class="separator:a1810f5aba25efd242c24232c2c2bbd1a inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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>
  148. <tr class="separator:adeaebc2111072105cbb6961df917d223 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <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>
  150. <tr class="separator:afbb3b5d0356df264b7343d135b697bcf inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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>
  152. <tr class="separator:a771f0adf4c566c3ac2f7c5c32e75d43c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <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>
  154. <tr class="separator:affd866a31305bc1e70c572b2be76069b inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <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>
  156. <tr class="separator:af219f6b5498fbd8671e298303c28b1dc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <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>
  158. <tr class="separator:a0d14fc4334b31b14e243de86cc1609a4 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <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>
  160. <tr class="separator:a6c87209e1a998d8b35e1cde74839bfcc inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <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>
  162. <tr class="separator:adf03af9303912906eada72ccf10115e8 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <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>
  164. <tr class="separator:ad35d7fe358fa34d2eba803c7506791f3 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <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>
  166. <tr class="separator:a67283be3f45257d1e0c474c563ebb6b6 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <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>
  168. <tr class="separator:a137797d39611f3f3108b30852d28622c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <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>
  170. <tr class="separator:a510119ff902e4e96165a7475370be836 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <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>
  172. <tr class="separator:aa71cf6ba84b0de85019204261a9136b7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <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>
  174. <tr class="separator:a0f693104a44b07db870d4e54f2db4c08 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <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>
  176. <tr class="separator:aec389cbe6ac7aff8ce7196e7dbc007df inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <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>
  178. <tr class="separator:af4da33de69819e293d90cf52fcbda6da inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <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>
  180. <tr class="separator:a35273f559aecabece437c22ee8aee443 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <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>
  182. <tr class="separator:a8a1d5ac5403526378c7abb0916c55c3c inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <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>
  184. <tr class="separator:a8ca0e6f21ff100da6bcd59f51d34fb8e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <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>
  186. <tr class="separator:a9fed7ee24702928365ad45e6eaba4d12 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <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>
  188. <tr class="separator:aa92c3478d4ff5780f0f027598480d772 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <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>
  190. <tr class="separator:aabc265010a7a59dcec211ddd8f0ac5a7 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <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>
  192. <tr class="separator:aa3e15ecdee7ab3ece234913bc4e783c0 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <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>
  194. <tr class="separator:ae099b2a1810ca2e23ac11d239ae0197e inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <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>
  196. <tr class="separator:a5aaca360a719feabae0e4e57b921deae inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <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>
  198. <tr class="separator:a4f673cd959711ae09927e7c44dae5fdb inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <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>
  200. <tr class="separator:aa8f68d1e6d8c6601c39b3f676f0e9c70 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <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>
  202. <tr class="separator:a9cbf471b97387d5bdefb88f92094ad54 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <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>
  204. <tr class="separator:a5447439ba5620b2ac00dc0ef97ef2142 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <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>
  206. <tr class="separator:aa6f6bfef028c7b053444cbd48567d286 inherit pub_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. </table><table class="memberdecls">
  208. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
  209. Additional Inherited Members</h2></td></tr>
  210. <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>
  211. <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>
  212. <tr class="separator:ac7926551c6df020f767d8d87f5a3d575 inherit pub_static_methods_classSimObject"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. </table>
  214. <h2 class="groupheader">Member Function Documentation</h2>
  215. <a class="anchor" id="a89761268277b6a304e39e742cc53cb14"></a>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <table class="memname">
  219. <tr>
  220. <td class="memname">bool addExplicitCell </td>
  221. <td>(</td>
  222. <td class="paramtype">int&#160;</td>
  223. <td class="paramname"><em>cellOffsetX</em>, </td>
  224. </tr>
  225. <tr>
  226. <td class="paramkey"></td>
  227. <td></td>
  228. <td class="paramtype">int&#160;</td>
  229. <td class="paramname"><em>cellOffsetY</em>, </td>
  230. </tr>
  231. <tr>
  232. <td class="paramkey"></td>
  233. <td></td>
  234. <td class="paramtype">int&#160;</td>
  235. <td class="paramname"><em>cellWidth</em>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype">int&#160;</td>
  241. <td class="paramname"><em>cellHeight</em>&#160;</td>
  242. </tr>
  243. <tr>
  244. <td></td>
  245. <td>)</td>
  246. <td></td><td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Add an explicit cell. </p>
  251. <dl class="params"><dt>Parameters</dt><dd>
  252. <table class="params">
  253. <tr><td class="paramname">cellOffsetX</td><td>The offset in the X axis to the top-left of the cell. </td></tr>
  254. <tr><td class="paramname">cellOffsetY</td><td>The offset in the Y axis to the top-left of the cell. </td></tr>
  255. <tr><td class="paramname">cellWidth</td><td>The width of the cell. </td></tr>
  256. <tr><td class="paramname">cellHeight</td><td>The height of the cell. The image asset must be in explicit mode for this operation to succeed. </td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  261. </div>
  262. </div>
  263. <a class="anchor" id="ace05af2d367962adebace1e8332c328c"></a>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">bool clearExplicitCells </td>
  269. <td>(</td>
  270. <td class="paramname"></td><td>)</td>
  271. <td></td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. <p>Clears all explicit cells. The image asset stays in explicit mode however with no explicit cells a single full-frame cell becomes default. </p>
  276. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  277. </div>
  278. </div>
  279. <a class="anchor" id="ad28721af7e6bac798773a7c11039516b"></a>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">int getCellCountX </td>
  285. <td>(</td>
  286. <td class="paramname"></td><td>)</td>
  287. <td></td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Gets the CELL count X. </p>
  292. <dl class="section return"><dt>Returns</dt><dd>The CELL count X. </dd></dl>
  293. </div>
  294. </div>
  295. <a class="anchor" id="a25f2445a474e1f3af1be733e38ec11ce"></a>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">int getCellCountY </td>
  301. <td>(</td>
  302. <td class="paramname"></td><td>)</td>
  303. <td></td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <p>Gets the CELL count Y. </p>
  308. <dl class="section return"><dt>Returns</dt><dd>The CELL count Y. </dd></dl>
  309. </div>
  310. </div>
  311. <a class="anchor" id="a3f3d4449bfdd018eab1dd272a28da923"></a>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <table class="memname">
  315. <tr>
  316. <td class="memname">int getCellHeight </td>
  317. <td>(</td>
  318. <td class="paramname"></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>Gets the CELL height. </p>
  324. <dl class="section return"><dt>Returns</dt><dd>The CELL height. </dd></dl>
  325. </div>
  326. </div>
  327. <a class="anchor" id="a83487022db1f231e6d7b306a03dd6679"></a>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="memname">
  331. <tr>
  332. <td class="memname">int getCellOffsetX </td>
  333. <td>(</td>
  334. <td class="paramname"></td><td>)</td>
  335. <td></td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>Gets the CELL offset X. </p>
  340. <dl class="section return"><dt>Returns</dt><dd>The CELL offset X. </dd></dl>
  341. </div>
  342. </div>
  343. <a class="anchor" id="a124a689acee8249a51c472eb9c0cfb74"></a>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="memname">
  347. <tr>
  348. <td class="memname">int getCellOffsetY </td>
  349. <td>(</td>
  350. <td class="paramname"></td><td>)</td>
  351. <td></td>
  352. </tr>
  353. </table>
  354. </div><div class="memdoc">
  355. <p>Gets the CELL offset Y. </p>
  356. <dl class="section return"><dt>Returns</dt><dd>The CELL offset Y. </dd></dl>
  357. </div>
  358. </div>
  359. <a class="anchor" id="a2cfa18dd3b3f6367ba531645dfee1b05"></a>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <table class="memname">
  363. <tr>
  364. <td class="memname">bool getCellRowOrder </td>
  365. <td>(</td>
  366. <td class="paramname"></td><td>)</td>
  367. <td></td>
  368. </tr>
  369. </table>
  370. </div><div class="memdoc">
  371. <p>Gets whether CELL row order should be used or not. </p>
  372. <dl class="section return"><dt>Returns</dt><dd>Whether CELL row order should be used or not. </dd></dl>
  373. </div>
  374. </div>
  375. <a class="anchor" id="af69760426104338b44f17c7edbf31580"></a>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <table class="memname">
  379. <tr>
  380. <td class="memname">int getCellStrideX </td>
  381. <td>(</td>
  382. <td class="paramname"></td><td>)</td>
  383. <td></td>
  384. </tr>
  385. </table>
  386. </div><div class="memdoc">
  387. <p>Gets the CELL stride X. </p>
  388. <dl class="section return"><dt>Returns</dt><dd>The CELL stride X. </dd></dl>
  389. </div>
  390. </div>
  391. <a class="anchor" id="a2c751c09813b6f3cdba40d4068122684"></a>
  392. <div class="memitem">
  393. <div class="memproto">
  394. <table class="memname">
  395. <tr>
  396. <td class="memname">int getCellStrideY </td>
  397. <td>(</td>
  398. <td class="paramname"></td><td>)</td>
  399. <td></td>
  400. </tr>
  401. </table>
  402. </div><div class="memdoc">
  403. <p>Gets the CELL stride Y. </p>
  404. <dl class="section return"><dt>Returns</dt><dd>The CELL stride Y. </dd></dl>
  405. </div>
  406. </div>
  407. <a class="anchor" id="a28244879294fd8e42fea5f67149b44d5"></a>
  408. <div class="memitem">
  409. <div class="memproto">
  410. <table class="memname">
  411. <tr>
  412. <td class="memname">int getCellWidth </td>
  413. <td>(</td>
  414. <td class="paramname"></td><td>)</td>
  415. <td></td>
  416. </tr>
  417. </table>
  418. </div><div class="memdoc">
  419. <p>Gets the CELL width. </p>
  420. <dl class="section return"><dt>Returns</dt><dd>The CELL width. </dd></dl>
  421. </div>
  422. </div>
  423. <a class="anchor" id="a868b408711e9625e1d5d1b5febb40734"></a>
  424. <div class="memitem">
  425. <div class="memproto">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname">int getExplicitCellCount </td>
  429. <td>(</td>
  430. <td class="paramname"></td><td>)</td>
  431. <td></td>
  432. </tr>
  433. </table>
  434. </div><div class="memdoc">
  435. <p>Gets the explicit cell count. </p>
  436. <dl class="section return"><dt>Returns</dt><dd>The explicit cell count. </dd></dl>
  437. </div>
  438. </div>
  439. <a class="anchor" id="af446a6d01315daca721b4b7c6695bfe4"></a>
  440. <div class="memitem">
  441. <div class="memproto">
  442. <table class="memname">
  443. <tr>
  444. <td class="memname">string getFilterMode </td>
  445. <td>(</td>
  446. <td class="paramname"></td><td>)</td>
  447. <td></td>
  448. </tr>
  449. </table>
  450. </div><div class="memdoc">
  451. <p>Gets the filter mode. </p>
  452. <dl class="section return"><dt>Returns</dt><dd>The filter mode. </dd></dl>
  453. </div>
  454. </div>
  455. <a class="anchor" id="abfd277e66cb84f3fe518d814054152e6"></a>
  456. <div class="memitem">
  457. <div class="memproto">
  458. <table class="memname">
  459. <tr>
  460. <td class="memname">bool getForce16Bit </td>
  461. <td>(</td>
  462. <td class="paramname"></td><td>)</td>
  463. <td></td>
  464. </tr>
  465. </table>
  466. </div><div class="memdoc">
  467. <p>Gets whether 16-bit image is forced or not. </p>
  468. <dl class="section return"><dt>Returns</dt><dd>Whether 16-bit image is forced or not. </dd></dl>
  469. </div>
  470. </div>
  471. <a class="anchor" id="a134a0d63775c91ff4a3ab9fa8ac7438a"></a>
  472. <div class="memitem">
  473. <div class="memproto">
  474. <table class="memname">
  475. <tr>
  476. <td class="memname">int getFrameCount </td>
  477. <td>(</td>
  478. <td class="paramname"></td><td>)</td>
  479. <td></td>
  480. </tr>
  481. </table>
  482. </div><div class="memdoc">
  483. <p>Gets the frame count. </p>
  484. <dl class="section return"><dt>Returns</dt><dd>The frame count. </dd></dl>
  485. </div>
  486. </div>
  487. <a class="anchor" id="a36eb1343e434e55871f47eafb7496a0c"></a>
  488. <div class="memitem">
  489. <div class="memproto">
  490. <table class="memname">
  491. <tr>
  492. <td class="memname">string getFrameSize </td>
  493. <td>(</td>
  494. <td class="paramtype">int&#160;</td>
  495. <td class="paramname"><em>frame</em></td><td>)</td>
  496. <td></td>
  497. </tr>
  498. </table>
  499. </div><div class="memdoc">
  500. <p>Gets the specified frames size. </p>
  501. <dl class="params"><dt>Parameters</dt><dd>
  502. <table class="params">
  503. <tr><td class="paramname">frame</td><td>The frame number to use. </td></tr>
  504. </table>
  505. </dd>
  506. </dl>
  507. <dl class="section return"><dt>Returns</dt><dd>The specified frames size. </dd></dl>
  508. </div>
  509. </div>
  510. <a class="anchor" id="acd444497c1a023cefb08e89990f84162"></a>
  511. <div class="memitem">
  512. <div class="memproto">
  513. <table class="memname">
  514. <tr>
  515. <td class="memname">string getImageFile </td>
  516. <td>(</td>
  517. <td class="paramname"></td><td>)</td>
  518. <td></td>
  519. </tr>
  520. </table>
  521. </div><div class="memdoc">
  522. <p>Gets the image file. </p>
  523. <dl class="section return"><dt>Returns</dt><dd>Returns the bitmap image file. </dd></dl>
  524. </div>
  525. </div>
  526. <a class="anchor" id="afa384d0e84f13612d4f7847f77242afc"></a>
  527. <div class="memitem">
  528. <div class="memproto">
  529. <table class="memname">
  530. <tr>
  531. <td class="memname">int getImageHeight </td>
  532. <td>(</td>
  533. <td class="paramname"></td><td>)</td>
  534. <td></td>
  535. </tr>
  536. </table>
  537. </div><div class="memdoc">
  538. <p>Gets the image height. </p>
  539. <dl class="section return"><dt>Returns</dt><dd>The image width. </dd></dl>
  540. </div>
  541. </div>
  542. <a class="anchor" id="ac5e183e466cec9e8f813a8478ce233b9"></a>
  543. <div class="memitem">
  544. <div class="memproto">
  545. <table class="memname">
  546. <tr>
  547. <td class="memname">string getImageSize </td>
  548. <td>(</td>
  549. <td class="paramname"></td><td>)</td>
  550. <td></td>
  551. </tr>
  552. </table>
  553. </div><div class="memdoc">
  554. <p>Gets the image size. </p>
  555. <dl class="section return"><dt>Returns</dt><dd>The image size. </dd></dl>
  556. </div>
  557. </div>
  558. <a class="anchor" id="aded69ad10c2446f9225fb3be50077c8f"></a>
  559. <div class="memitem">
  560. <div class="memproto">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname">int getImageWidth </td>
  564. <td>(</td>
  565. <td class="paramname"></td><td>)</td>
  566. <td></td>
  567. </tr>
  568. </table>
  569. </div><div class="memdoc">
  570. <p>Gets the image width. </p>
  571. <dl class="section return"><dt>Returns</dt><dd>The image width. </dd></dl>
  572. </div>
  573. </div>
  574. <a class="anchor" id="ae636c1ff92c472c26b342c7444fc3047"></a>
  575. <div class="memitem">
  576. <div class="memproto">
  577. <table class="memname">
  578. <tr>
  579. <td class="memname">bool getIsImagePOT </td>
  580. <td>(</td>
  581. <td class="paramname"></td><td>)</td>
  582. <td></td>
  583. </tr>
  584. </table>
  585. </div><div class="memdoc">
  586. <p>Gets whether the image has a power-of-two dimensions or not. </p>
  587. <dl class="section return"><dt>Returns</dt><dd>Whether the image has a power-of-two dimensions or not. </dd></dl>
  588. </div>
  589. </div>
  590. <a class="anchor" id="ac76a3c58e047c46c251095105a2e8b15"></a>
  591. <div class="memitem">
  592. <div class="memproto">
  593. <table class="memname">
  594. <tr>
  595. <td class="memname">bool insertExplicitCell </td>
  596. <td>(</td>
  597. <td class="paramtype">int&#160;</td>
  598. <td class="paramname"><em>cellIndex</em>, </td>
  599. </tr>
  600. <tr>
  601. <td class="paramkey"></td>
  602. <td></td>
  603. <td class="paramtype">int&#160;</td>
  604. <td class="paramname"><em>cellOffsetX</em>, </td>
  605. </tr>
  606. <tr>
  607. <td class="paramkey"></td>
  608. <td></td>
  609. <td class="paramtype">int&#160;</td>
  610. <td class="paramname"><em>cellOffsetY</em>, </td>
  611. </tr>
  612. <tr>
  613. <td class="paramkey"></td>
  614. <td></td>
  615. <td class="paramtype">int&#160;</td>
  616. <td class="paramname"><em>cellWidth</em>, </td>
  617. </tr>
  618. <tr>
  619. <td class="paramkey"></td>
  620. <td></td>
  621. <td class="paramtype">int&#160;</td>
  622. <td class="paramname"><em>cellHeight</em>&#160;</td>
  623. </tr>
  624. <tr>
  625. <td></td>
  626. <td>)</td>
  627. <td></td><td></td>
  628. </tr>
  629. </table>
  630. </div><div class="memdoc">
  631. <p>Insert an explicit cell at the specified index. </p>
  632. <dl class="params"><dt>Parameters</dt><dd>
  633. <table class="params">
  634. <tr><td class="paramname">cellIndex</td><td>The zero-based index to insert the cell. This will work when no cells are present. If the index is beyond the cell count then the cell is simply added. </td></tr>
  635. <tr><td class="paramname">cellOffsetX</td><td>The offset in the X axis to the top-left of the cell. </td></tr>
  636. <tr><td class="paramname">cellOffsetY</td><td>The offset in the Y axis to the top-left of the cell. </td></tr>
  637. <tr><td class="paramname">cellWidth</td><td>The width of the cell. </td></tr>
  638. <tr><td class="paramname">cellHeight</td><td>The height of the cell. The image asset must be in explicit mode for this operation to succeed. </td></tr>
  639. </table>
  640. </dd>
  641. </dl>
  642. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  643. </div>
  644. </div>
  645. <a class="anchor" id="a3e5d9f8eef4c7bbb381dd46c30906aac"></a>
  646. <div class="memitem">
  647. <div class="memproto">
  648. <table class="memname">
  649. <tr>
  650. <td class="memname">bool removeExplicitCell </td>
  651. <td>(</td>
  652. <td class="paramtype">int&#160;</td>
  653. <td class="paramname"><em>cellIndex</em></td><td>)</td>
  654. <td></td>
  655. </tr>
  656. </table>
  657. </div><div class="memdoc">
  658. <p>Remove an explicit cell from the specified index. </p>
  659. <dl class="params"><dt>Parameters</dt><dd>
  660. <table class="params">
  661. <tr><td class="paramname">cellIndex</td><td>The zero-based index to remove the cell from. </td></tr>
  662. </table>
  663. </dd>
  664. </dl>
  665. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  666. </div>
  667. </div>
  668. <a class="anchor" id="a1b2cf41bc1dcdad3b5f5cfccde762dfa"></a>
  669. <div class="memitem">
  670. <div class="memproto">
  671. <table class="memname">
  672. <tr>
  673. <td class="memname">void setCellCountX </td>
  674. <td>(</td>
  675. <td class="paramtype">countX&#160;</td>
  676. <td class="paramname"></td><td>)</td>
  677. <td></td>
  678. </tr>
  679. </table>
  680. </div><div class="memdoc">
  681. <p>Sets the CELL count X. </p>
  682. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  683. </div>
  684. </div>
  685. <a class="anchor" id="a74cc4e3d67657f28e850c40de4fa30e0"></a>
  686. <div class="memitem">
  687. <div class="memproto">
  688. <table class="memname">
  689. <tr>
  690. <td class="memname">void setCellCountY </td>
  691. <td>(</td>
  692. <td class="paramtype">countY&#160;</td>
  693. <td class="paramname"></td><td>)</td>
  694. <td></td>
  695. </tr>
  696. </table>
  697. </div><div class="memdoc">
  698. <p>Sets the CELL count Y. </p>
  699. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  700. </div>
  701. </div>
  702. <a class="anchor" id="a1fe763c3e58593e398905989d2260098"></a>
  703. <div class="memitem">
  704. <div class="memproto">
  705. <table class="memname">
  706. <tr>
  707. <td class="memname">void setCellHeight </td>
  708. <td>(</td>
  709. <td class="paramtype">Height&#160;</td>
  710. <td class="paramname"></td><td>)</td>
  711. <td></td>
  712. </tr>
  713. </table>
  714. </div><div class="memdoc">
  715. <p>Sets the CELL height. </p>
  716. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  717. </div>
  718. </div>
  719. <a class="anchor" id="a0c69218226dd4bf63505c239ab3b261d"></a>
  720. <div class="memitem">
  721. <div class="memproto">
  722. <table class="memname">
  723. <tr>
  724. <td class="memname">void setCellOffsetX </td>
  725. <td>(</td>
  726. <td class="paramtype">offsetX&#160;</td>
  727. <td class="paramname"></td><td>)</td>
  728. <td></td>
  729. </tr>
  730. </table>
  731. </div><div class="memdoc">
  732. <p>Sets the CELL offset X. </p>
  733. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  734. </div>
  735. </div>
  736. <a class="anchor" id="a4e660709e2f9e8ec43cf8876085856fb"></a>
  737. <div class="memitem">
  738. <div class="memproto">
  739. <table class="memname">
  740. <tr>
  741. <td class="memname">void setCellOffsetY </td>
  742. <td>(</td>
  743. <td class="paramtype">offsetY&#160;</td>
  744. <td class="paramname"></td><td>)</td>
  745. <td></td>
  746. </tr>
  747. </table>
  748. </div><div class="memdoc">
  749. <p>Sets the CELL offset Y. </p>
  750. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  751. </div>
  752. </div>
  753. <a class="anchor" id="a385e3aaf527ad86225b7b53223b782f4"></a>
  754. <div class="memitem">
  755. <div class="memproto">
  756. <table class="memname">
  757. <tr>
  758. <td class="memname">void setCellRowOrder </td>
  759. <td>(</td>
  760. <td class="paramtype">rowOrder?&#160;</td>
  761. <td class="paramname"></td><td>)</td>
  762. <td></td>
  763. </tr>
  764. </table>
  765. </div><div class="memdoc">
  766. <p>Sets whether CELL row order should be used or not. </p>
  767. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  768. </div>
  769. </div>
  770. <a class="anchor" id="a79377caef373282289238d3d82b460f9"></a>
  771. <div class="memitem">
  772. <div class="memproto">
  773. <table class="memname">
  774. <tr>
  775. <td class="memname">void setCellStrideX </td>
  776. <td>(</td>
  777. <td class="paramtype">strideX&#160;</td>
  778. <td class="paramname"></td><td>)</td>
  779. <td></td>
  780. </tr>
  781. </table>
  782. </div><div class="memdoc">
  783. <p>Sets the CELL stride X. </p>
  784. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  785. </div>
  786. </div>
  787. <a class="anchor" id="a695a30cd50d00c538dc8f2d225f3a1ea"></a>
  788. <div class="memitem">
  789. <div class="memproto">
  790. <table class="memname">
  791. <tr>
  792. <td class="memname">void setCellStrideY </td>
  793. <td>(</td>
  794. <td class="paramtype">strideY&#160;</td>
  795. <td class="paramname"></td><td>)</td>
  796. <td></td>
  797. </tr>
  798. </table>
  799. </div><div class="memdoc">
  800. <p>Sets the CELL stride Y. </p>
  801. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  802. </div>
  803. </div>
  804. <a class="anchor" id="adbba11ca7c89cfeac612bf36ea6de895"></a>
  805. <div class="memitem">
  806. <div class="memproto">
  807. <table class="memname">
  808. <tr>
  809. <td class="memname">void setCellWidth </td>
  810. <td>(</td>
  811. <td class="paramtype">Width&#160;</td>
  812. <td class="paramname"></td><td>)</td>
  813. <td></td>
  814. </tr>
  815. </table>
  816. </div><div class="memdoc">
  817. <p>Sets the CELL width. </p>
  818. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  819. </div>
  820. </div>
  821. <a class="anchor" id="afa1f934a502625979286f337cdf4d6df"></a>
  822. <div class="memitem">
  823. <div class="memproto">
  824. <table class="memname">
  825. <tr>
  826. <td class="memname">bool setExplicitCell </td>
  827. <td>(</td>
  828. <td class="paramtype">int&#160;</td>
  829. <td class="paramname"><em>cellIndex</em>, </td>
  830. </tr>
  831. <tr>
  832. <td class="paramkey"></td>
  833. <td></td>
  834. <td class="paramtype">int&#160;</td>
  835. <td class="paramname"><em>cellOffsetX</em>, </td>
  836. </tr>
  837. <tr>
  838. <td class="paramkey"></td>
  839. <td></td>
  840. <td class="paramtype">int&#160;</td>
  841. <td class="paramname"><em>cellOffsetY</em>, </td>
  842. </tr>
  843. <tr>
  844. <td class="paramkey"></td>
  845. <td></td>
  846. <td class="paramtype">int&#160;</td>
  847. <td class="paramname"><em>cellWidth</em>, </td>
  848. </tr>
  849. <tr>
  850. <td class="paramkey"></td>
  851. <td></td>
  852. <td class="paramtype">int&#160;</td>
  853. <td class="paramname"><em>cellHeight</em>&#160;</td>
  854. </tr>
  855. <tr>
  856. <td></td>
  857. <td>)</td>
  858. <td></td><td></td>
  859. </tr>
  860. </table>
  861. </div><div class="memdoc">
  862. <p>Set an explicit cell at the specified index. </p>
  863. <dl class="params"><dt>Parameters</dt><dd>
  864. <table class="params">
  865. <tr><td class="paramname">cellIndex</td><td>The zero-based index to insert the cell. This will work when no cells are present. If the index is beyond the cell count then the cell is simply added. </td></tr>
  866. <tr><td class="paramname">cellOffsetX</td><td>The offset in the X axis to the top-left of the cell. </td></tr>
  867. <tr><td class="paramname">cellOffsetY</td><td>The offset in the Y axis to the top-left of the cell. </td></tr>
  868. <tr><td class="paramname">cellWidth</td><td>The width of the cell. </td></tr>
  869. <tr><td class="paramname">cellHeight</td><td>The height of the cell. The image asset must be in explicit mode for this operation to succeed. </td></tr>
  870. </table>
  871. </dd>
  872. </dl>
  873. <dl class="section return"><dt>Returns</dt><dd>Whether the operation was successful or not. </dd></dl>
  874. </div>
  875. </div>
  876. <a class="anchor" id="a3ef9ea57ef0585d49d323889549750a3"></a>
  877. <div class="memitem">
  878. <div class="memproto">
  879. <table class="memname">
  880. <tr>
  881. <td class="memname">void setFilterMode </td>
  882. <td>(</td>
  883. <td class="paramtype">mode&#160;</td>
  884. <td class="paramname"></td><td>)</td>
  885. <td></td>
  886. </tr>
  887. </table>
  888. </div><div class="memdoc">
  889. <p>Sets the filter mode. </p>
  890. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  891. </div>
  892. </div>
  893. <a class="anchor" id="ac449323fec68260724288c149a12c05d"></a>
  894. <div class="memitem">
  895. <div class="memproto">
  896. <table class="memname">
  897. <tr>
  898. <td class="memname">void setForce16Bit </td>
  899. <td>(</td>
  900. <td class="paramtype">force16Bit?&#160;</td>
  901. <td class="paramname"></td><td>)</td>
  902. <td></td>
  903. </tr>
  904. </table>
  905. </div><div class="memdoc">
  906. <p>Sets whether 16-bit image is forced or not. </p>
  907. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  908. </div>
  909. </div>
  910. <a class="anchor" id="af4543314564a8aaf4a5f6ab3d9b16d27"></a>
  911. <div class="memitem">
  912. <div class="memproto">
  913. <table class="memname">
  914. <tr>
  915. <td class="memname">void setImageFile </td>
  916. <td>(</td>
  917. <td class="paramtype">ImageFile&#160;</td>
  918. <td class="paramname"></td><td>)</td>
  919. <td></td>
  920. </tr>
  921. </table>
  922. </div><div class="memdoc">
  923. <p>Sets the image file (bitmap file). </p>
  924. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  925. </div>
  926. </div>
  927. </div><!-- contents -->
  928. <!-- start footer part -->
  929. <hr class="footer"/><address class="footer"><small>
  930. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  931. <img class="footer" src="doxygen.png" alt="doxygen"/>
  932. </a> 1.8.3.1
  933. </small></address>
  934. </body>
  935. </html>