صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
TorqueEngine
/
Torque2D
mirrorاز https://github.com/TorqueGameEngines/Torque2D.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
شاخه: gh-pages
شاخه‌ها تگ‌ها
Torque2D
/
Torque2DDocs
/
html
/
class_tickable.html

class_tickable.html 32 KB
لینک دائمی تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.9.8"/>
    7. 

  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
    8. 

  8. <title>Torque2D Reference: Tickable Class Reference</title>
    9. 

  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    10. 

  10. <script type="text/javascript" src="jquery.js"></script>
    11. 

  11. <script type="text/javascript" src="dynsections.js"></script>
    12. 

  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    13. 

  13. <script type="text/javascript" src="search/searchdata.js"></script>
    14. 

  14. <script type="text/javascript" src="search/search.js"></script>
    15. 

  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    16. 

  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    17. 

  17. </head>
    18. 

  18. <body>
    19. 

  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    20. 

  20. <div id="titlearea">
    21. 

  21. <table cellspacing="0" cellpadding="0">
    22. 

  22.  <tbody>
    23. 

  23.  <tr id="projectrow">
    24. 

  24.   <td id="projectalign">
    25. 

  25.    <div id="projectname">Torque2D Reference
    26. 

  26.    </div>
    27. 

  27.   </td>
    28. 

  28.  </tr>
    29. 

  29.  </tbody>
    30. 

  30. </table>
    31. 

  31. </div>
    32. 

  32. <!-- end header part -->
    33. 

  33. <!-- Generated by Doxygen 1.9.8 -->
    34. 

  34. <script type="text/javascript">
    35. 

  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    36. 

  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
    37. 

  37. /* @license-end */
    38. 

  38. </script>
    39. 

  39. <script type="text/javascript" src="menudata.js"></script>
    40. 

  40. <script type="text/javascript" src="menu.js"></script>
    41. 

  41. <script type="text/javascript">
    42. 

  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
    43. 

  43. $(function() {
    44. 

  44.   initMenu('',true,false,'search.php','Search');
    45. 

  45.   $(document).ready(function() { init_search(); });
    46. 

  46. });
    47. 

  47. /* @license-end */
    48. 

  48. </script>
    49. 

  49. <div id="main-nav"></div>
    50. 

  50. <!-- window showing the filter options -->
    51. 

  51. <div id="MSearchSelectWindow"
    52. 

  52.      onmouseover="return searchBox.OnSearchSelectShow()"
    53. 

  53.      onmouseout="return searchBox.OnSearchSelectHide()"
    54. 

  54.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    55. 

  55. </div>
    56. 

  56. 

  57. <!-- iframe showing the search results (closed by default) -->
    58. 

  58. <div id="MSearchResultsWindow">
    59. 

  59. <div id="MSearchResults">
    60. 

  60. <div class="SRPage">
    61. 

  61. <div id="SRIndex">
    62. 

  62. <div id="SRResults"></div>
    63. 

  63. <div class="SRStatus" id="Loading">Loading...</div>
    64. 

  64. <div class="SRStatus" id="Searching">Searching...</div>
    65. 

  65. <div class="SRStatus" id="NoMatches">No Matches</div>
    66. 

  66. </div>
    67. 

  67. </div>
    68. 

  68. </div>
    69. 

  69. </div>
    70. 

  70. 

  71. </div><!-- top -->
    72. 

  72. <div class="header">
    73. 

  73.   <div class="summary">
    74. 

  74. <a href="#pub-methods">Public Member Functions</a> &#124;
    75. 

  75. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
    76. 

  76. <a href="#pub-static-attribs">Static Public Attributes</a> &#124;
    77. 

  77. <a href="#pro-methods">Protected Member Functions</a> &#124;
    78. 

  78. <a href="class_tickable-members.html">List of all members</a>  </div>
    79. 

  79.   <div class="headertitle"><div class="title">Tickable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
    80. 

  80. </div><!--header-->
    81. 

  81. <div class="contents">
    82. 

  82. 

  83. <p><code>#include &lt;Tickable.h&gt;</code></p>
    84. 

  84. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
    85. 

  85.   <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Tickable:</div>
    86. 

  86. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
    87. 

  87. </div>
    88. 

  88. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
    89. 

  89.  <div class="center">
    90. 

  90.   <img src="class_tickable.png" usemap="#Tickable_map" alt=""/>
    91. 

  91.   <map id="Tickable_map" name="Tickable_map">
    92. 

  92. <area href="class_default_game.html" alt="DefaultGame" shape="rect" coords="0,56,161,80"/>
    93. 

  93. <area href="class_gui_control.html" alt="GuiControl" shape="rect" coords="171,56,332,80"/>
    94. 

  94. <area href="class_image_frame_provider_core.html" alt="ImageFrameProviderCore" shape="rect" coords="513,56,674,80"/>
    95. 

  95. <area href="class_remote_debugger_base.html" alt="RemoteDebuggerBase" shape="rect" coords="684,56,845,80"/>
    96. 

  96. <area href="class_scene.html" alt="Scene" shape="rect" coords="855,56,1016,80"/>
    97. 

  97. <area href="class_scene_window.html" alt="SceneWindow" shape="rect" coords="1026,56,1187,80"/>
    98. 

  98. <area href="class_gui_array_ctrl.html" title="Renders a grid of cells. Gives common functionality to a few controls that inherit from it,..." alt="GuiArrayCtrl" shape="rect" coords="342,112,503,136"/>
    99. 

  99. <area href="class_gui_canvas.html" alt="GuiCanvas" shape="rect" coords="342,168,503,192"/>
    100. 

  100. <area href="class_gui_chain_ctrl.html" alt="GuiChainCtrl" shape="rect" coords="342,224,503,248"/>
    101. 

  101. <area href="class_gui_color_picker_ctrl.html" alt="GuiColorPickerCtrl" shape="rect" coords="342,280,503,304"/>
    102. 

  102. <area href="class_gui_color_popup_b_g_ctrl.html" alt="GuiColorPopupBGCtrl" shape="rect" coords="342,336,503,360"/>
    103. 

  103. <area href="class_gui_color_popup_content_ctrl.html" alt="GuiColorPopupContentCtrl" shape="rect" coords="342,392,503,416"/>
    104. 

  104. <area href="class_gui_drag_and_drop_ctrl.html" alt="GuiDragAndDropCtrl" shape="rect" coords="342,448,503,472"/>
    105. 

  105. <area href="class_gui_drop_down_b_g_ctrl.html" alt="GuiDropDownBGCtrl" shape="rect" coords="342,504,503,528"/>
    106. 

  106. <area href="class_gui_easing_support.html" title="Can be inherited from to add the members and methods needed to easily add smooth transitions between ..." alt="GuiEasingSupport" shape="rect" coords="342,560,503,584"/>
    107. 

  107. <area href="class_gui_edit_ctrl.html" alt="GuiEditCtrl" shape="rect" coords="342,616,503,640"/>
    108. 

  108. <area href="class_gui_editor_ruler.html" alt="GuiEditorRuler" shape="rect" coords="342,672,503,696"/>
    109. 

  109. <area href="class_gui_expand_ctrl.html" alt="GuiExpandCtrl" shape="rect" coords="342,728,503,752"/>
    110. 

  110. <area href="class_gui_frame_set_ctrl.html" alt="GuiFrameSetCtrl" shape="rect" coords="342,784,503,808"/>
    111. 

  111. <area href="class_gui_graph_ctrl.html" alt="GuiGraphCtrl" shape="rect" coords="342,840,503,864"/>
    112. 

  112. <area href="class_gui_grid_ctrl.html" alt="GuiGridCtrl" shape="rect" coords="342,896,503,920"/>
    113. 

  113. <area href="class_gui_input_ctrl.html" alt="GuiInputCtrl" shape="rect" coords="342,952,503,976"/>
    114. 

  114. <area href="class_gui_inspector_field.html" alt="GuiInspectorField" shape="rect" coords="342,1008,503,1032"/>
    115. 

  115. <area href="class_gui_list_box_ctrl.html" alt="GuiListBoxCtrl" shape="rect" coords="342,1064,503,1088"/>
    116. 

  116. <area href="class_gui_menu_b_g_ctrl.html" alt="GuiMenuBGCtrl" shape="rect" coords="342,1120,503,1144"/>
    117. 

  117. <area href="class_gui_menu_bar_ctrl.html" alt="GuiMenuBarCtrl" shape="rect" coords="342,1176,503,1200"/>
    118. 

  118. <area href="class_gui_menu_item_ctrl.html" alt="GuiMenuItemCtrl" shape="rect" coords="342,1232,503,1256"/>
    119. 

  119. <area href="class_gui_menu_list_ctrl.html" alt="GuiMenuListCtrl" shape="rect" coords="342,1288,503,1312"/>
    120. 

  120. <area href="class_gui_message_vector_ctrl.html" alt="GuiMessageVectorCtrl" shape="rect" coords="342,1344,503,1368"/>
    121. 

  121. <area href="class_gui_particle_graph_inspector.html" alt="GuiParticleGraphInspector" shape="rect" coords="342,1400,503,1424"/>
    122. 

  122. <area href="class_gui_progress_ctrl.html" alt="GuiProgressCtrl" shape="rect" coords="342,1456,503,1480"/>
    123. 

  123. <area href="class_gui_scroll_ctrl.html" alt="GuiScrollCtrl" shape="rect" coords="342,1512,503,1536"/>
    124. 

  124. <area href="class_gui_slider_ctrl.html" alt="GuiSliderCtrl" shape="rect" coords="342,1568,503,1592"/>
    125. 

  125. <area href="class_gui_sprite_ctrl.html" alt="GuiSpriteCtrl" shape="rect" coords="342,1624,503,1648"/>
    126. 

  126. <area href="class_gui_tab_book_ctrl.html" alt="GuiTabBookCtrl" shape="rect" coords="342,1680,503,1704"/>
    127. 

  127. <area href="class_gui_tab_page_ctrl.html" alt="GuiTabPageCtrl" shape="rect" coords="342,1736,503,1760"/>
    128. 

  128. <area href="class_gui_text_edit_ctrl.html" alt="GuiTextEditCtrl" shape="rect" coords="342,1792,503,1816"/>
    129. 

  129. <area href="class_gui_window_ctrl.html" alt="GuiWindowCtrl" shape="rect" coords="342,1848,503,1872"/>
    130. 

  130. <area href="class_scene_window.html" alt="SceneWindow" shape="rect" coords="342,1904,503,1928"/>
    131. 

  131. <area href="class_image_frame_provider.html" alt="ImageFrameProvider" shape="rect" coords="513,112,674,136"/>
    132. 

  132. <area href="class_remote_debugger1.html" alt="RemoteDebugger1" shape="rect" coords="684,112,845,136"/>
    133. 

  133. <area href="class_editor_toy_scene_window.html" alt="EditorToySceneWindow" shape="rect" coords="1026,112,1187,136"/>
    134. 

  134.   </map>
    135. 

  135. </div></div>
    136. 

  136. <table class="memberdecls">
    137. 

  137. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
    138. 

  138. Public Member Functions</h2></td></tr>
    139. 

  139. <tr class="memitem:a5e3128cfbe9129b24c8631ca1ddcd21c" id="r_a5e3128cfbe9129b24c8631ca1ddcd21c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#a5e3128cfbe9129b24c8631ca1ddcd21c">Tickable</a> ()</td></tr>
    140. 

  140. <tr class="separator:a5e3128cfbe9129b24c8631ca1ddcd21c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    141. 

  141. <tr class="memitem:ad086b77217bcb4a79d71a5fadead250f" id="r_ad086b77217bcb4a79d71a5fadead250f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#ad086b77217bcb4a79d71a5fadead250f">~Tickable</a> ()</td></tr>
    142. 

  142. <tr class="separator:ad086b77217bcb4a79d71a5fadead250f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    143. 

  143. <tr class="memitem:a8ce3ce19eb4a8944f1c8f4b4dccb8b67" id="r_a8ce3ce19eb4a8944f1c8f4b4dccb8b67"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#a8ce3ce19eb4a8944f1c8f4b4dccb8b67">isProcessingTicks</a> () const</td></tr>
    144. 

  144. <tr class="separator:a8ce3ce19eb4a8944f1c8f4b4dccb8b67"><td class="memSeparator" colspan="2">&#160;</td></tr>
    145. 

  145. <tr class="memitem:a8c7201617a14b9ed862bbe4fe6527370" id="r_a8c7201617a14b9ed862bbe4fe6527370"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#a8c7201617a14b9ed862bbe4fe6527370">setProcessTicks</a> (bool tick=true)</td></tr>
    146. 

  146. <tr class="separator:a8c7201617a14b9ed862bbe4fe6527370"><td class="memSeparator" colspan="2">&#160;</td></tr>
    147. 

  147. </table><table class="memberdecls">
    148. 

  148. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
    149. 

  149. Static Public Member Functions</h2></td></tr>
    150. 

  150. <tr class="memitem:aedf561d239a439eccf0b5d06901167d7" id="r_aedf561d239a439eccf0b5d06901167d7"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#aedf561d239a439eccf0b5d06901167d7">advanceTime</a> (U32 timeDelta)</td></tr>
    151. 

  151. <tr class="separator:aedf561d239a439eccf0b5d06901167d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    152. 

  152. </table><table class="memberdecls">
    153. 

  153. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
    154. 

  154. Static Public Attributes</h2></td></tr>
    155. 

  155. <tr class="memitem:a328b0e594667be606174f8df66f98afb" id="r_a328b0e594667be606174f8df66f98afb"><td class="memItemLeft" align="right" valign="top">static const U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#a328b0e594667be606174f8df66f98afb">smTickShift</a> = 4</td></tr>
    156. 

  156. <tr class="memdesc:a328b0e594667be606174f8df66f98afb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shift value to control how often Ticks occur.  <br /></td></tr>
    157. 

  157. <tr class="separator:a328b0e594667be606174f8df66f98afb"><td class="memSeparator" colspan="2">&#160;</td></tr>
    158. 

  158. <tr class="memitem:a9c00bdc780fce65d2d57055093bb28c4" id="r_a9c00bdc780fce65d2d57055093bb28c4"><td class="memItemLeft" align="right" valign="top">static const U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#a9c00bdc780fce65d2d57055093bb28c4">smTickMs</a> = ( 1 &lt;&lt; <a class="el" href="class_tickable.html#a328b0e594667be606174f8df66f98afb">smTickShift</a> )</td></tr>
    159. 

  159. <tr class="memdesc:a9c00bdc780fce65d2d57055093bb28c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of milliseconds per tick, 32 in this case.  <br /></td></tr>
    160. 

  160. <tr class="separator:a9c00bdc780fce65d2d57055093bb28c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
    161. 

  161. <tr class="memitem:afec655d10b6a2d0eb2cd6d2362c626b5" id="r_afec655d10b6a2d0eb2cd6d2362c626b5"><td class="memItemLeft" align="right" valign="top">static const F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#afec655d10b6a2d0eb2cd6d2362c626b5">smTickSec</a> = ( F32( <a class="el" href="class_tickable.html#a9c00bdc780fce65d2d57055093bb28c4">Tickable::smTickMs</a> ) / 1000.f )</td></tr>
    162. 

  162. <tr class="memdesc:afec655d10b6a2d0eb2cd6d2362c626b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fraction of a second per tick.  <br /></td></tr>
    163. 

  163. <tr class="separator:afec655d10b6a2d0eb2cd6d2362c626b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    164. 

  164. <tr class="memitem:aab266025d7181bbfb16f3af77250eec8" id="r_aab266025d7181bbfb16f3af77250eec8"><td class="memItemLeft" align="right" valign="top">static const U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#aab266025d7181bbfb16f3af77250eec8">smTickMask</a> = ( <a class="el" href="class_tickable.html#a9c00bdc780fce65d2d57055093bb28c4">smTickMs</a> - 1 )</td></tr>
    165. 

  165. <tr class="separator:aab266025d7181bbfb16f3af77250eec8"><td class="memSeparator" colspan="2">&#160;</td></tr>
    166. 

  166. </table><table class="memberdecls">
    167. 

  167. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
    168. 

  168. Protected Member Functions</h2></td></tr>
    169. 

  169. <tr class="memitem:a6901acb62b785a45f32cafb96d36f33f" id="r_a6901acb62b785a45f32cafb96d36f33f"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#a6901acb62b785a45f32cafb96d36f33f">interpolateTick</a> (F32 delta)=0</td></tr>
    170. 

  170. <tr class="separator:a6901acb62b785a45f32cafb96d36f33f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    171. 

  171. <tr class="memitem:ac01d76136baea1c65146a1975af38e90" id="r_ac01d76136baea1c65146a1975af38e90"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#ac01d76136baea1c65146a1975af38e90">processTick</a> ()=0</td></tr>
    172. 

  172. <tr class="separator:ac01d76136baea1c65146a1975af38e90"><td class="memSeparator" colspan="2">&#160;</td></tr>
    173. 

  173. <tr class="memitem:a400778436529c299bbc717643edf04a1" id="r_a400778436529c299bbc717643edf04a1"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_tickable.html#a400778436529c299bbc717643edf04a1">advanceTime</a> (F32 timeDelta)=0</td></tr>
    174. 

  174. <tr class="separator:a400778436529c299bbc717643edf04a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
    175. 

  175. </table>
    176. 

  176. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    177. 

  177. <div class="textblock"><p>This interface allows you to let any object be ticked. You use it like so: </p><div class="fragment"><div class="line"><span class="keyword">class </span>FooClass : <span class="keyword">public</span> <a class="code hl_class" href="class_sim_object.html">SimObject</a>, <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_tickable.html">Tickable</a></div>
    178. 

  178. <div class="line">{</div>
    179. 

  179. <div class="line">   <span class="comment">// You still mark SimObject as Parent</span></div>
    180. 

  180. <div class="line">   typdef <a class="code hl_class" href="class_sim_object.html">SimObject</a> Parent;</div>
    181. 

  181. <div class="line"><span class="keyword">private</span>:</div>
    182. 

  182. <div class="line">...</div>
    183. 

  183. <div class="line"> </div>
    184. 

  184. <div class="line">protected:</div>
    185. 

  185. <div class="line">   <span class="comment">// These three methods are the interface for Tickable</span></div>
    186. 

  186. <div class="line">   <span class="keyword">virtual</span> <span class="keywordtype">void</span> interpolateTick( F32 delta );</div>
    187. 

  187. <div class="line">   <span class="keyword">virtual</span> <span class="keywordtype">void</span> processTick();</div>
    188. 

  188. <div class="line">   <span class="keyword">virtual</span> <span class="keywordtype">void</span> advanceTime( F32 timeDelta );</div>
    189. 

  189. <div class="line"> </div>
    190. 

  190. <div class="line"><span class="keyword">public</span>:</div>
    191. 

  191. <div class="line">...</div>
    192. 

  192. <div class="line">};</div>
    193. 

  193. <div class="ttc" id="aclass_sim_object_html"><div class="ttname"><a href="class_sim_object.html">SimObject</a></div><div class="ttdef"><b>Definition</b> simObject.h:234</div></div>
    194. 

  194. <div class="ttc" id="aclass_tickable_html"><div class="ttname"><a href="class_tickable.html">Tickable</a></div><div class="ttdef"><b>Definition</b> Tickable.h:82</div></div>
    195. 

  195. </div><!-- fragment --><p> Please note the three methods you must implement to use <a class="el" href="class_tickable.html">Tickable</a>, but don't worry. If you forget, the compiler will tell you so. Also note that the typedef for Parent should NOT BE SET to <a class="el" href="class_tickable.html">Tickable</a>, the compiler will <em>probably</em> also tell you if you forget that. Last, but assuridly not least is that you note the way that the inheritance is done: public <b>virtual</b> <a class="el" href="class_tickable.html">Tickable</a> It is very important that you keep the virtual keyword in there, otherwise proper behavior is not guaranteed. You have been warned.</p>
    196. 

  196. <p>The point of a tickable object is that the object gets ticks at a fixed rate which is one tick every 32ms. This means, also, that if an object doesn't get updated for 64ms, that the next update it will get two-ticks. Basically it comes down to this. You are assured to get one tick per 32ms of time passing provided that isProcessingTicks returns true when <a class="el" href="class_tickable.html">Tickable</a> calls it.</p>
    197. 

  197. <p>isProcessingTicks is a virtual method and you can (should you want to) override it and put some extended functionality to decide if you want to receive tick-notification or not.</p>
    198. 

  198. <p>The other half of this is that you get time-notification from advanceTime. advanceTime lets you know when time passes regardless of the return value of isProcessingTicks. The object WILL get the advanceTime call every single update. The argument passed to advanceTime is the time since the last call to advanceTime. Updates are not based on the 32ms tick time. Updates are dependant on frame-rate. So you may get 200 advanceTime calls in a second, or you may only get 20. There is no way of assuring consistent calls of advanceTime like there is with processTick. Both are useful for different things, and it is important to understand the differences between them.</p>
    199. 

  199. <p>Interpolation is the last part of the <a class="el" href="class_tickable.html">Tickable</a> interface. It is called every update, as long as isProcessingTicks evaluates to true on the object. This is used to interpolate between 32ms ticks. The argument passed to interpolateTick is the time since the last call to processTick.</p>
    200. 

  200. <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Support processBefore/After and move the GameBase processing over to use <a class="el" href="class_tickable.html">Tickable</a> </dd></dl>
    201. 

  201. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
    202. 

  202. <a id="a5e3128cfbe9129b24c8631ca1ddcd21c" name="a5e3128cfbe9129b24c8631ca1ddcd21c"></a>
    203. 

  203. <h2 class="memtitle"><span class="permalink"><a href="#a5e3128cfbe9129b24c8631ca1ddcd21c">&#9670;&#160;</a></span>Tickable()</h2>
    204. 

  204. 

  205. <div class="memitem">
    206. 

  206. <div class="memproto">
    207. 

  207.       <table class="memname">
    208. 

  208.         <tr>
    209. 

  209.           <td class="memname"><a class="el" href="class_tickable.html">Tickable</a> </td>
    210. 

  210.           <td>(</td>
    211. 

  211.           <td class="paramname"></td><td>)</td>
    212. 

  212.           <td></td>
    213. 

  213.         </tr>
    214. 

  214.       </table>
    215. 

  215. </div><div class="memdoc">
    216. 

  216. <p>Constructor This will add the object to the process list </p>
    217. 

  217. 

  218. </div>
    219. 

  219. </div>
    220. 

  220. <a id="ad086b77217bcb4a79d71a5fadead250f" name="ad086b77217bcb4a79d71a5fadead250f"></a>
    221. 

  221. <h2 class="memtitle"><span class="permalink"><a href="#ad086b77217bcb4a79d71a5fadead250f">&#9670;&#160;</a></span>~Tickable()</h2>
    222. 

  222. 

  223. <div class="memitem">
    224. 

  224. <div class="memproto">
    225. 

  225. <table class="mlabels">
    226. 

  226.   <tr>
    227. 

  227.   <td class="mlabels-left">
    228. 

  228.       <table class="memname">
    229. 

  229.         <tr>
    230. 

  230.           <td class="memname">~<a class="el" href="class_tickable.html">Tickable</a> </td>
    231. 

  231.           <td>(</td>
    232. 

  232.           <td class="paramname"></td><td>)</td>
    233. 

  233.           <td></td>
    234. 

  234.         </tr>
    235. 

  235.       </table>
    236. 

  236.   </td>
    237. 

  237.   <td class="mlabels-right">
    238. 

  238. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    239. 

  239.   </tr>
    240. 

  240. </table>
    241. 

  241. </div><div class="memdoc">
    242. 

  242. <p>Destructor Remove this object from the process list </p>
    243. 

  243. 

  244. </div>
    245. 

  245. </div>
    246. 

  246. <h2 class="groupheader">Member Function Documentation</h2>
    247. 

  247. <a id="a400778436529c299bbc717643edf04a1" name="a400778436529c299bbc717643edf04a1"></a>
    248. 

  248. <h2 class="memtitle"><span class="permalink"><a href="#a400778436529c299bbc717643edf04a1">&#9670;&#160;</a></span>advanceTime() <span class="overload">[1/2]</span></h2>
    249. 

  249. 

  250. <div class="memitem">
    251. 

  251. <div class="memproto">
    252. 

  252. <table class="mlabels">
    253. 

  253.   <tr>
    254. 

  254.   <td class="mlabels-left">
    255. 

  255.       <table class="memname">
    256. 

  256.         <tr>
    257. 

  257.           <td class="memname">virtual void advanceTime </td>
    258. 

  258.           <td>(</td>
    259. 

  259.           <td class="paramtype">F32&#160;</td>
    260. 

  260.           <td class="paramname"><em>timeDelta</em></td><td>)</td>
    261. 

  261.           <td></td>
    262. 

  262.         </tr>
    263. 

  263.       </table>
    264. 

  264.   </td>
    265. 

  265.   <td class="mlabels-right">
    266. 

  266. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
    267. 

  267.   </tr>
    268. 

  268. </table>
    269. 

  269. </div><div class="memdoc">
    270. 

  270. <p>This method is called once every frame regardless of the return value of isProcessingTicks and informs the object of the passage of time </p>
    271. 

  271. 

  272. <p>Implemented in <a class="el" href="class_image_frame_provider_core.html#af6fb95f4d0573e394a66d791adfa1cc7">ImageFrameProviderCore</a>, <a class="el" href="class_gui_sprite_ctrl.html#af6fb95f4d0573e394a66d791adfa1cc7">GuiSpriteCtrl</a>, <a class="el" href="class_scene_window.html#af6fb95f4d0573e394a66d791adfa1cc7">SceneWindow</a>, <a class="el" href="class_scene.html#af6fb95f4d0573e394a66d791adfa1cc7">Scene</a>, <a class="el" href="class_remote_debugger_base.html#af6fb95f4d0573e394a66d791adfa1cc7">RemoteDebuggerBase</a>, <a class="el" href="class_default_game.html#acc9ac5db8d1c6afe84403f3a525e59dd">DefaultGame</a>, and <a class="el" href="class_gui_control.html#af6fb95f4d0573e394a66d791adfa1cc7">GuiControl</a>.</p>
    273. 

  273. 

  274. </div>
    275. 

  275. </div>
    276. 

  276. <a id="aedf561d239a439eccf0b5d06901167d7" name="aedf561d239a439eccf0b5d06901167d7"></a>
    277. 

  277. <h2 class="memtitle"><span class="permalink"><a href="#aedf561d239a439eccf0b5d06901167d7">&#9670;&#160;</a></span>advanceTime() <span class="overload">[2/2]</span></h2>
    278. 

  278. 

  279. <div class="memitem">
    280. 

  280. <div class="memproto">
    281. 

  281. <table class="mlabels">
    282. 

  282.   <tr>
    283. 

  283.   <td class="mlabels-left">
    284. 

  284.       <table class="memname">
    285. 

  285.         <tr>
    286. 

  286.           <td class="memname">bool advanceTime </td>
    287. 

  287.           <td>(</td>
    288. 

  288.           <td class="paramtype">U32&#160;</td>
    289. 

  289.           <td class="paramname"><em>timeDelta</em></td><td>)</td>
    290. 

  290.           <td></td>
    291. 

  291.         </tr>
    292. 

  292.       </table>
    293. 

  293.   </td>
    294. 

  294.   <td class="mlabels-right">
    295. 

  295. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    296. 

  296.   </tr>
    297. 

  297. </table>
    298. 

  298. </div><div class="memdoc">
    299. 

  299. <p>This is called in clientProcess to advance the time for all <a class="el" href="class_tickable.html">Tickable</a> objects </p><dl class="section return"><dt>Returns</dt><dd>True if any ticks were sent </dd></dl>
    300. 

  300. <dl class="section see"><dt>See also</dt><dd>clientProcess </dd></dl>
    301. 

  301. 

  302. </div>
    303. 

  303. </div>
    304. 

  304. <a id="a6901acb62b785a45f32cafb96d36f33f" name="a6901acb62b785a45f32cafb96d36f33f"></a>
    305. 

  305. <h2 class="memtitle"><span class="permalink"><a href="#a6901acb62b785a45f32cafb96d36f33f">&#9670;&#160;</a></span>interpolateTick()</h2>
    306. 

  306. 

  307. <div class="memitem">
    308. 

  308. <div class="memproto">
    309. 

  309. <table class="mlabels">
    310. 

  310.   <tr>
    311. 

  311.   <td class="mlabels-left">
    312. 

  312.       <table class="memname">
    313. 

  313.         <tr>
    314. 

  314.           <td class="memname">virtual void interpolateTick </td>
    315. 

  315.           <td>(</td>
    316. 

  316.           <td class="paramtype">F32&#160;</td>
    317. 

  317.           <td class="paramname"><em>delta</em></td><td>)</td>
    318. 

  318.           <td></td>
    319. 

  319.         </tr>
    320. 

  320.       </table>
    321. 

  321.   </td>
    322. 

  322.   <td class="mlabels-right">
    323. 

  323. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
    324. 

  324.   </tr>
    325. 

  325. </table>
    326. 

  326. </div><div class="memdoc">
    327. 

  327. <p>This method is called every frame and lets the control interpolate between ticks so you can smooth things as long as isProcessingTicks returns true when it is called on the object </p>
    328. 

  328. 

  329. <p>Implemented in <a class="el" href="class_image_frame_provider_core.html#a62ec28263feafe2ebd8c2083c174c5a9">ImageFrameProviderCore</a>, <a class="el" href="class_gui_sprite_ctrl.html#a62ec28263feafe2ebd8c2083c174c5a9">GuiSpriteCtrl</a>, <a class="el" href="class_scene_window.html#a6ac268bfd7ed2654af2754a2229626a5">SceneWindow</a>, <a class="el" href="class_scene.html#a6ac268bfd7ed2654af2754a2229626a5">Scene</a>, <a class="el" href="class_remote_debugger_base.html#a62ec28263feafe2ebd8c2083c174c5a9">RemoteDebuggerBase</a>, <a class="el" href="class_default_game.html#a62ec28263feafe2ebd8c2083c174c5a9">DefaultGame</a>, and <a class="el" href="class_gui_control.html#a62ec28263feafe2ebd8c2083c174c5a9">GuiControl</a>.</p>
    330. 

  330. 

  331. </div>
    332. 

  332. </div>
    333. 

  333. <a id="a8ce3ce19eb4a8944f1c8f4b4dccb8b67" name="a8ce3ce19eb4a8944f1c8f4b4dccb8b67"></a>
    334. 

  334. <h2 class="memtitle"><span class="permalink"><a href="#a8ce3ce19eb4a8944f1c8f4b4dccb8b67">&#9670;&#160;</a></span>isProcessingTicks()</h2>
    335. 

  335. 

  336. <div class="memitem">
    337. 

  337. <div class="memproto">
    338. 

  338. <table class="mlabels">
    339. 

  339.   <tr>
    340. 

  340.   <td class="mlabels-left">
    341. 

  341.       <table class="memname">
    342. 

  342.         <tr>
    343. 

  343.           <td class="memname">virtual bool isProcessingTicks </td>
    344. 

  344.           <td>(</td>
    345. 

  345.           <td class="paramname"></td><td>)</td>
    346. 

  346.           <td> const</td>
    347. 

  347.         </tr>
    348. 

  348.       </table>
    349. 

  349.   </td>
    350. 

  350.   <td class="mlabels-right">
    351. 

  351. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
    352. 

  352.   </tr>
    353. 

  353. </table>
    354. 

  354. </div><div class="memdoc">
    355. 

  355. <p>Is this object wanting to receive tick notifications </p><dl class="section return"><dt>Returns</dt><dd>True if object wants tick notifications </dd></dl>
    356. 

  356. 

  357. </div>
    358. 

  358. </div>
    359. 

  359. <a id="ac01d76136baea1c65146a1975af38e90" name="ac01d76136baea1c65146a1975af38e90"></a>
    360. 

  360. <h2 class="memtitle"><span class="permalink"><a href="#ac01d76136baea1c65146a1975af38e90">&#9670;&#160;</a></span>processTick()</h2>
    361. 

  361. 

  362. <div class="memitem">
    363. 

  363. <div class="memproto">
    364. 

  364. <table class="mlabels">
    365. 

  365.   <tr>
    366. 

  366.   <td class="mlabels-left">
    367. 

  367.       <table class="memname">
    368. 

  368.         <tr>
    369. 

  369.           <td class="memname">virtual void processTick </td>
    370. 

  370.           <td>(</td>
    371. 

  371.           <td class="paramname"></td><td>)</td>
    372. 

  372.           <td></td>
    373. 

  373.         </tr>
    374. 

  374.       </table>
    375. 

  375.   </td>
    376. 

  376.   <td class="mlabels-right">
    377. 

  377. <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span>  </td>
    378. 

  378.   </tr>
    379. 

  379. </table>
    380. 

  380. </div><div class="memdoc">
    381. 

  381. <p>This method is called once every 32ms if isProcessingTicks returns true when called on the object </p>
    382. 

  382. 

  383. <p>Implemented in <a class="el" href="class_image_frame_provider_core.html#a395494ca30433dbf1aabb391b3844b3b">ImageFrameProviderCore</a>, <a class="el" href="class_gui_sprite_ctrl.html#a395494ca30433dbf1aabb391b3844b3b">GuiSpriteCtrl</a>, <a class="el" href="class_scene_window.html#a395494ca30433dbf1aabb391b3844b3b">SceneWindow</a>, <a class="el" href="class_scene.html#a395494ca30433dbf1aabb391b3844b3b">Scene</a>, <a class="el" href="class_gui_expand_ctrl.html#a395494ca30433dbf1aabb391b3844b3b">GuiExpandCtrl</a>, <a class="el" href="class_gui_control.html#a3fa9439f27c61f4ebd63e9e796524e53">GuiControl</a>, <a class="el" href="class_gui_easing_support.html#a395494ca30433dbf1aabb391b3844b3b">GuiEasingSupport</a>, <a class="el" href="class_gui_progress_ctrl.html#a395494ca30433dbf1aabb391b3844b3b">GuiProgressCtrl</a>, <a class="el" href="class_remote_debugger_base.html#a7543f5c09b50bb610c80991050bd0b4a">RemoteDebuggerBase</a>, and <a class="el" href="class_default_game.html#a7543f5c09b50bb610c80991050bd0b4a">DefaultGame</a>.</p>
    384. 

  384. 

  385. </div>
    386. 

  386. </div>
    387. 

  387. <a id="a8c7201617a14b9ed862bbe4fe6527370" name="a8c7201617a14b9ed862bbe4fe6527370"></a>
    388. 

  388. <h2 class="memtitle"><span class="permalink"><a href="#a8c7201617a14b9ed862bbe4fe6527370">&#9670;&#160;</a></span>setProcessTicks()</h2>
    389. 

  389. 

  390. <div class="memitem">
    391. 

  391. <div class="memproto">
    392. 

  392. <table class="mlabels">
    393. 

  393.   <tr>
    394. 

  394.   <td class="mlabels-left">
    395. 

  395.       <table class="memname">
    396. 

  396.         <tr>
    397. 

  397.           <td class="memname">void setProcessTicks </td>
    398. 

  398.           <td>(</td>
    399. 

  399.           <td class="paramtype">bool&#160;</td>
    400. 

  400.           <td class="paramname"><em>tick</em> = <code>true</code></td><td>)</td>
    401. 

  401.           <td></td>
    402. 

  402.         </tr>
    403. 

  403.       </table>
    404. 

  404.   </td>
    405. 

  405.   <td class="mlabels-right">
    406. 

  406. <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
    407. 

  407.   </tr>
    408. 

  408. </table>
    409. 

  409. </div><div class="memdoc">
    410. 

  410. <p>Sets this object as either tick processing or not </p><dl class="params"><dt>Parameters</dt><dd>
    411. 

  411.   <table class="params">
    412. 

  412.     <tr><td class="paramname">tick</td><td>True if this object should process ticks </td></tr>
    413. 

  413.   </table>
    414. 

  414.   </dd>
    415. 

  415. </dl>
    416. 

  416. 

  417. <p>Reimplemented in <a class="el" href="class_image_frame_provider_core.html#a94b8d13ff159fb7f3c958a23bf97470e">ImageFrameProviderCore</a>.</p>
    418. 

  418. 

  419. </div>
    420. 

  420. </div>
    421. 

  421. <h2 class="groupheader">Member Data Documentation</h2>
    422. 

  422. <a id="aab266025d7181bbfb16f3af77250eec8" name="aab266025d7181bbfb16f3af77250eec8"></a>
    423. 

  423. <h2 class="memtitle"><span class="permalink"><a href="#aab266025d7181bbfb16f3af77250eec8">&#9670;&#160;</a></span>smTickMask</h2>
    424. 

  424. 

  425. <div class="memitem">
    426. 

  426. <div class="memproto">
    427. 

  427. <table class="mlabels">
    428. 

  428.   <tr>
    429. 

  429.   <td class="mlabels-left">
    430. 

  430.       <table class="memname">
    431. 

  431.         <tr>
    432. 

  432.           <td class="memname">const U32 smTickMask = ( <a class="el" href="class_tickable.html#a9c00bdc780fce65d2d57055093bb28c4">smTickMs</a> - 1 )</td>
    433. 

  433.         </tr>
    434. 

  434.       </table>
    435. 

  435.   </td>
    436. 

  436.   <td class="mlabels-right">
    437. 

  437. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    438. 

  438.   </tr>
    439. 

  439. </table>
    440. 

  440. </div><div class="memdoc">
    441. 

  441. 

  442. </div>
    443. 

  443. </div>
    444. 

  444. <a id="a9c00bdc780fce65d2d57055093bb28c4" name="a9c00bdc780fce65d2d57055093bb28c4"></a>
    445. 

  445. <h2 class="memtitle"><span class="permalink"><a href="#a9c00bdc780fce65d2d57055093bb28c4">&#9670;&#160;</a></span>smTickMs</h2>
    446. 

  446. 

  447. <div class="memitem">
    448. 

  448. <div class="memproto">
    449. 

  449. <table class="mlabels">
    450. 

  450.   <tr>
    451. 

  451.   <td class="mlabels-left">
    452. 

  452.       <table class="memname">
    453. 

  453.         <tr>
    454. 

  454.           <td class="memname">const U32 smTickMs = ( 1 &lt;&lt; <a class="el" href="class_tickable.html#a328b0e594667be606174f8df66f98afb">smTickShift</a> )</td>
    455. 

  455.         </tr>
    456. 

  456.       </table>
    457. 

  457.   </td>
    458. 

  458.   <td class="mlabels-right">
    459. 

  459. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    460. 

  460.   </tr>
    461. 

  461. </table>
    462. 

  462. </div><div class="memdoc">
    463. 

  463. 

  464. <p>Number of milliseconds per tick, 32 in this case. </p>
    465. 

  465. 

  466. </div>
    467. 

  467. </div>
    468. 

  468. <a id="afec655d10b6a2d0eb2cd6d2362c626b5" name="afec655d10b6a2d0eb2cd6d2362c626b5"></a>
    469. 

  469. <h2 class="memtitle"><span class="permalink"><a href="#afec655d10b6a2d0eb2cd6d2362c626b5">&#9670;&#160;</a></span>smTickSec</h2>
    470. 

  470. 

  471. <div class="memitem">
    472. 

  472. <div class="memproto">
    473. 

  473. <table class="mlabels">
    474. 

  474.   <tr>
    475. 

  475.   <td class="mlabels-left">
    476. 

  476.       <table class="memname">
    477. 

  477.         <tr>
    478. 

  478.           <td class="memname">const F32 smTickSec = ( F32( <a class="el" href="class_tickable.html#a9c00bdc780fce65d2d57055093bb28c4">Tickable::smTickMs</a> ) / 1000.f )</td>
    479. 

  479.         </tr>
    480. 

  480.       </table>
    481. 

  481.   </td>
    482. 

  482.   <td class="mlabels-right">
    483. 

  483. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    484. 

  484.   </tr>
    485. 

  485. </table>
    486. 

  486. </div><div class="memdoc">
    487. 

  487. 

  488. <p>Fraction of a second per tick. </p>
    489. 

  489. 

  490. </div>
    491. 

  491. </div>
    492. 

  492. <a id="a328b0e594667be606174f8df66f98afb" name="a328b0e594667be606174f8df66f98afb"></a>
    493. 

  493. <h2 class="memtitle"><span class="permalink"><a href="#a328b0e594667be606174f8df66f98afb">&#9670;&#160;</a></span>smTickShift</h2>
    494. 

  494. 

  495. <div class="memitem">
    496. 

  496. <div class="memproto">
    497. 

  497. <table class="mlabels">
    498. 

  498.   <tr>
    499. 

  499.   <td class="mlabels-left">
    500. 

  500.       <table class="memname">
    501. 

  501.         <tr>
    502. 

  502.           <td class="memname">const U32 smTickShift = 4</td>
    503. 

  503.         </tr>
    504. 

  504.       </table>
    505. 

  505.   </td>
    506. 

  506.   <td class="mlabels-right">
    507. 

  507. <span class="mlabels"><span class="mlabel">static</span></span>  </td>
    508. 

  508.   </tr>
    509. 

  509. </table>
    510. 

  510. </div><div class="memdoc">
    511. 

  511. 

  512. <p>Shift value to control how often Ticks occur. </p>
    513. 

  513. 

  514. </div>
    515. 

  515. </div>
    516. 

  516. <hr/>The documentation for this class was generated from the following files:<ul>
    517. 

  517. <li>platform/<b>Tickable.h</b></li>
    518. 

  518. <li>platform/<b>Tickable.cc</b></li>
    519. 

  519. </ul>
    520. 

  520. </div><!-- contents -->
    521. 

  521. <!-- start footer part -->
    522. 

  522. <hr class="footer"/><address class="footer"><small>
    523. 

  523. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
    524. 

  524. </small></address>
    525. 

  525. </body>
    526. 

  526. </html>
    527.