class_taml_children.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: TamlChildren Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="class_taml_children-members.html">List of all members</a> </div>
  74. <div class="headertitle"><div class="title">TamlChildren Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span><div class="ingroups"><a class="el" href="group__taml_group.html">TAML Reference</a></div></div></div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <p><code>#include &lt;tamlChildren.h&gt;</code></p>
  78. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  79. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for TamlChildren:</div>
  80. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  81. </div>
  82. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  83. <div class="center">
  84. <img src="class_taml_children.png" usemap="#TamlChildren_map" alt=""/>
  85. <map id="TamlChildren_map" name="TamlChildren_map">
  86. <area href="class_particle_asset.html" alt="ParticleAsset" shape="rect" coords="0,56,161,80"/>
  87. <area href="class_scene.html" alt="Scene" shape="rect" coords="171,56,332,80"/>
  88. <area href="class_scene_object_set.html" alt="SceneObjectSet" shape="rect" coords="342,56,503,80"/>
  89. <area href="class_sim_set.html" alt="SimSet" shape="rect" coords="684,56,845,80"/>
  90. <area href="class_grouped_scene_controller.html" alt="GroupedSceneController" shape="rect" coords="342,112,503,136"/>
  91. <area href="class_module_definition.html" alt="ModuleDefinition" shape="rect" coords="513,112,674,136"/>
  92. <area href="class_name_tags.html" alt="NameTags" shape="rect" coords="684,112,845,136"/>
  93. <area href="class_sim_group.html" alt="SimGroup" shape="rect" coords="1026,112,1187,136"/>
  94. <area href="class_ambient_force_controller.html" alt="AmbientForceController" shape="rect" coords="342,168,503,192"/>
  95. <area href="class_gui_control.html" alt="GuiControl" shape="rect" coords="513,168,674,192"/>
  96. <area href="class_input_manager.html" alt="InputManager" shape="rect" coords="855,168,1016,192"/>
  97. <area href="class_net_connection.html" alt="NetConnection" shape="rect" coords="1026,168,1187,192"/>
  98. <area href="class_script_group.html" alt="ScriptGroup" shape="rect" coords="1197,168,1358,192"/>
  99. <area href="class_sim_data_block_group.html" alt="SimDataBlockGroup" shape="rect" coords="1368,168,1529,192"/>
  100. <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="684,224,845,248"/>
  101. <area href="class_gui_canvas.html" alt="GuiCanvas" shape="rect" coords="684,280,845,304"/>
  102. <area href="class_gui_chain_ctrl.html" alt="GuiChainCtrl" shape="rect" coords="684,336,845,360"/>
  103. <area href="class_gui_color_picker_ctrl.html" alt="GuiColorPickerCtrl" shape="rect" coords="684,392,845,416"/>
  104. <area href="class_gui_color_popup_b_g_ctrl.html" alt="GuiColorPopupBGCtrl" shape="rect" coords="684,448,845,472"/>
  105. <area href="class_gui_color_popup_content_ctrl.html" alt="GuiColorPopupContentCtrl" shape="rect" coords="684,504,845,528"/>
  106. <area href="class_gui_drag_and_drop_ctrl.html" alt="GuiDragAndDropCtrl" shape="rect" coords="684,560,845,584"/>
  107. <area href="class_gui_drop_down_b_g_ctrl.html" alt="GuiDropDownBGCtrl" shape="rect" coords="684,616,845,640"/>
  108. <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="684,672,845,696"/>
  109. <area href="class_gui_edit_ctrl.html" alt="GuiEditCtrl" shape="rect" coords="684,728,845,752"/>
  110. <area href="class_gui_editor_ruler.html" alt="GuiEditorRuler" shape="rect" coords="684,784,845,808"/>
  111. <area href="class_gui_expand_ctrl.html" alt="GuiExpandCtrl" shape="rect" coords="684,840,845,864"/>
  112. <area href="class_gui_frame_set_ctrl.html" alt="GuiFrameSetCtrl" shape="rect" coords="684,896,845,920"/>
  113. <area href="class_gui_graph_ctrl.html" alt="GuiGraphCtrl" shape="rect" coords="684,952,845,976"/>
  114. <area href="class_gui_grid_ctrl.html" alt="GuiGridCtrl" shape="rect" coords="684,1008,845,1032"/>
  115. <area href="class_gui_input_ctrl.html" alt="GuiInputCtrl" shape="rect" coords="684,1064,845,1088"/>
  116. <area href="class_gui_inspector_field.html" alt="GuiInspectorField" shape="rect" coords="684,1120,845,1144"/>
  117. <area href="class_gui_list_box_ctrl.html" alt="GuiListBoxCtrl" shape="rect" coords="684,1176,845,1200"/>
  118. <area href="class_gui_menu_b_g_ctrl.html" alt="GuiMenuBGCtrl" shape="rect" coords="684,1232,845,1256"/>
  119. <area href="class_gui_menu_bar_ctrl.html" alt="GuiMenuBarCtrl" shape="rect" coords="684,1288,845,1312"/>
  120. <area href="class_gui_menu_item_ctrl.html" alt="GuiMenuItemCtrl" shape="rect" coords="684,1344,845,1368"/>
  121. <area href="class_gui_menu_list_ctrl.html" alt="GuiMenuListCtrl" shape="rect" coords="684,1400,845,1424"/>
  122. <area href="class_gui_message_vector_ctrl.html" alt="GuiMessageVectorCtrl" shape="rect" coords="684,1456,845,1480"/>
  123. <area href="class_gui_particle_graph_inspector.html" alt="GuiParticleGraphInspector" shape="rect" coords="684,1512,845,1536"/>
  124. <area href="class_gui_progress_ctrl.html" alt="GuiProgressCtrl" shape="rect" coords="684,1568,845,1592"/>
  125. <area href="class_gui_scroll_ctrl.html" alt="GuiScrollCtrl" shape="rect" coords="684,1624,845,1648"/>
  126. <area href="class_gui_slider_ctrl.html" alt="GuiSliderCtrl" shape="rect" coords="684,1680,845,1704"/>
  127. <area href="class_gui_sprite_ctrl.html" alt="GuiSpriteCtrl" shape="rect" coords="684,1736,845,1760"/>
  128. <area href="class_gui_tab_book_ctrl.html" alt="GuiTabBookCtrl" shape="rect" coords="684,1792,845,1816"/>
  129. <area href="class_gui_tab_page_ctrl.html" alt="GuiTabPageCtrl" shape="rect" coords="684,1848,845,1872"/>
  130. <area href="class_gui_text_edit_ctrl.html" alt="GuiTextEditCtrl" shape="rect" coords="684,1904,845,1928"/>
  131. <area href="class_gui_window_ctrl.html" alt="GuiWindowCtrl" shape="rect" coords="684,1960,845,1984"/>
  132. <area href="class_scene_window.html" alt="SceneWindow" shape="rect" coords="684,2016,845,2040"/>
  133. <area href="class_u_input_manager.html" alt="UInputManager" shape="rect" coords="855,224,1016,248"/>
  134. <area href="class_game_connection.html" alt="GameConnection" shape="rect" coords="1026,224,1187,248"/>
  135. </map>
  136. </div></div>
  137. <table class="memberdecls">
  138. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  139. Public Member Functions</h2></td></tr>
  140. <tr class="memitem:a767537c3a5fb6a0434629973d72bb508" id="r_a767537c3a5fb6a0434629973d72bb508"><td class="memItemLeft" align="right" valign="top">virtual U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_children.html#a767537c3a5fb6a0434629973d72bb508">getTamlChildCount</a> (void) const =0</td></tr>
  141. <tr class="memdesc:a767537c3a5fb6a0434629973d72bb508"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when <a class="el" href="class_taml.html">Taml</a> attempts to compile a list of children. <br /></td></tr>
  142. <tr class="separator:a767537c3a5fb6a0434629973d72bb508"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a390d2b1b40d49b5b7e01c5fbbfdd67fa" id="r_a390d2b1b40d49b5b7e01c5fbbfdd67fa"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_children.html#a390d2b1b40d49b5b7e01c5fbbfdd67fa">getTamlChild</a> (const U32 childIndex) const =0</td></tr>
  144. <tr class="memdesc:a390d2b1b40d49b5b7e01c5fbbfdd67fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when <a class="el" href="class_taml.html">Taml</a> attempts to compile a list of children. <br /></td></tr>
  145. <tr class="separator:a390d2b1b40d49b5b7e01c5fbbfdd67fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a65773ca933808eb5205c494dc5483b4a" id="r_a65773ca933808eb5205c494dc5483b4a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_taml_children.html#a65773ca933808eb5205c494dc5483b4a">addTamlChild</a> (<a class="el" href="class_sim_object.html">SimObject</a> *pSimObject)=0</td></tr>
  147. <tr class="memdesc:a65773ca933808eb5205c494dc5483b4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when <a class="el" href="class_taml.html">Taml</a> attempts to populate an objects children during a read. <br /></td></tr>
  148. <tr class="separator:a65773ca933808eb5205c494dc5483b4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. </table>
  150. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  151. <div class="textblock"><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__taml_group.html">TAML Reference</a> </dd></dl>
  152. </div><h2 class="groupheader">Member Function Documentation</h2>
  153. <a id="a65773ca933808eb5205c494dc5483b4a" name="a65773ca933808eb5205c494dc5483b4a"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#a65773ca933808eb5205c494dc5483b4a">&#9670;&#160;</a></span>addTamlChild()</h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <table class="mlabels">
  158. <tr>
  159. <td class="mlabels-left">
  160. <table class="memname">
  161. <tr>
  162. <td class="memname">virtual void addTamlChild </td>
  163. <td>(</td>
  164. <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
  165. <td class="paramname"><em>pSimObject</em></td><td>)</td>
  166. <td></td>
  167. </tr>
  168. </table>
  169. </td>
  170. <td class="mlabels-right">
  171. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  172. </tr>
  173. </table>
  174. </div><div class="memdoc">
  175. <p>Called when <a class="el" href="class_taml.html">Taml</a> attempts to populate an objects children during a read. </p>
  176. <p>Implemented in <a class="el" href="class_particle_asset.html#a629e0ce1fcda5b3ba5158404d842832e">ParticleAsset</a>, <a class="el" href="class_scene.html#ae83b14bcb3497e2f143026fc6a087666">Scene</a>, <a class="el" href="class_scene_object_set.html#ae83b14bcb3497e2f143026fc6a087666">SceneObjectSet</a>, and <a class="el" href="class_sim_set.html#a629e0ce1fcda5b3ba5158404d842832e">SimSet</a>.</p>
  177. </div>
  178. </div>
  179. <a id="a390d2b1b40d49b5b7e01c5fbbfdd67fa" name="a390d2b1b40d49b5b7e01c5fbbfdd67fa"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#a390d2b1b40d49b5b7e01c5fbbfdd67fa">&#9670;&#160;</a></span>getTamlChild()</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="mlabels">
  184. <tr>
  185. <td class="mlabels-left">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">virtual <a class="el" href="class_sim_object.html">SimObject</a> * getTamlChild </td>
  189. <td>(</td>
  190. <td class="paramtype">const U32&#160;</td>
  191. <td class="paramname"><em>childIndex</em></td><td>)</td>
  192. <td> const</td>
  193. </tr>
  194. </table>
  195. </td>
  196. <td class="mlabels-right">
  197. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>Called when <a class="el" href="class_taml.html">Taml</a> attempts to compile a list of children. </p>
  202. <p>Implemented in <a class="el" href="class_particle_asset.html#a354d2adfbe00b9e5cc8ad41f51644050">ParticleAsset</a>, <a class="el" href="class_scene.html#a8bb1ac698c35206631255249a14a1ddb">Scene</a>, <a class="el" href="class_scene_object_set.html#a354d2adfbe00b9e5cc8ad41f51644050">SceneObjectSet</a>, and <a class="el" href="class_sim_set.html#a354d2adfbe00b9e5cc8ad41f51644050">SimSet</a>.</p>
  203. </div>
  204. </div>
  205. <a id="a767537c3a5fb6a0434629973d72bb508" name="a767537c3a5fb6a0434629973d72bb508"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#a767537c3a5fb6a0434629973d72bb508">&#9670;&#160;</a></span>getTamlChildCount()</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="mlabels">
  210. <tr>
  211. <td class="mlabels-left">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">virtual U32 getTamlChildCount </td>
  215. <td>(</td>
  216. <td class="paramtype">void&#160;</td>
  217. <td class="paramname"></td><td>)</td>
  218. <td> const</td>
  219. </tr>
  220. </table>
  221. </td>
  222. <td class="mlabels-right">
  223. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  224. </tr>
  225. </table>
  226. </div><div class="memdoc">
  227. <p>Called when <a class="el" href="class_taml.html">Taml</a> attempts to compile a list of children. </p>
  228. <p>Implemented in <a class="el" href="class_particle_asset.html#a57d9e0dc4985c861265fa15aaeb24b67">ParticleAsset</a>, <a class="el" href="class_scene.html#a57d9e0dc4985c861265fa15aaeb24b67">Scene</a>, <a class="el" href="class_scene_object_set.html#a57d9e0dc4985c861265fa15aaeb24b67">SceneObjectSet</a>, and <a class="el" href="class_sim_set.html#a57d9e0dc4985c861265fa15aaeb24b67">SimSet</a>.</p>
  229. </div>
  230. </div>
  231. <hr/>The documentation for this class was generated from the following file:<ul>
  232. <li>persistence/taml/<b>tamlChildren.h</b></li>
  233. </ul>
  234. </div><!-- contents -->
  235. <!-- start footer part -->
  236. <hr class="footer"/><address class="footer"><small>
  237. 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
  238. </small></address>
  239. </body>
  240. </html>