class_sim_id_dictionary.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  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: SimIdDictionary 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_sim_id_dictionary-members.html">List of all members</a> </div>
  74. <div class="headertitle"><div class="title">SimIdDictionary Class Reference</div></div>
  75. </div><!--header-->
  76. <div class="contents">
  77. <p><code>#include &lt;simDictionary.h&gt;</code></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:a722226136876be560416b2d0c66e2cfa" id="r_a722226136876be560416b2d0c66e2cfa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_id_dictionary.html#a722226136876be560416b2d0c66e2cfa">insert</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj)</td></tr>
  82. <tr class="separator:a722226136876be560416b2d0c66e2cfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a0d4568596d915594eb4b0180c35b2e04" id="r_a0d4568596d915594eb4b0180c35b2e04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_id_dictionary.html#a0d4568596d915594eb4b0180c35b2e04">remove</a> (<a class="el" href="class_sim_object.html">SimObject</a> *obj)</td></tr>
  84. <tr class="separator:a0d4568596d915594eb4b0180c35b2e04"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a11c1a29d724be8fd0c7f5a441b0281fc" id="r_a11c1a29d724be8fd0c7f5a441b0281fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_id_dictionary.html#a11c1a29d724be8fd0c7f5a441b0281fc">find</a> (S32 id)</td></tr>
  86. <tr class="separator:a11c1a29d724be8fd0c7f5a441b0281fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a6a1406b82ad1221e9973d01792143143" id="r_a6a1406b82ad1221e9973d01792143143"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_id_dictionary.html#a6a1406b82ad1221e9973d01792143143">SimIdDictionary</a> ()</td></tr>
  88. <tr class="separator:a6a1406b82ad1221e9973d01792143143"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a4e5b03f07b800f1391daabe2af83b4db" id="r_a4e5b03f07b800f1391daabe2af83b4db"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sim_id_dictionary.html#a4e5b03f07b800f1391daabe2af83b4db">~SimIdDictionary</a> ()</td></tr>
  90. <tr class="separator:a4e5b03f07b800f1391daabe2af83b4db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table>
  92. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  93. <div class="textblock"><p>Map of ID's to SimObjects.</p>
  94. <p>Provides fast lookup for ID-&gt;object and for fast removal of an object given object* </p>
  95. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  96. <a id="a6a1406b82ad1221e9973d01792143143" name="a6a1406b82ad1221e9973d01792143143"></a>
  97. <h2 class="memtitle"><span class="permalink"><a href="#a6a1406b82ad1221e9973d01792143143">&#9670;&#160;</a></span>SimIdDictionary()</h2>
  98. <div class="memitem">
  99. <div class="memproto">
  100. <table class="memname">
  101. <tr>
  102. <td class="memname"><a class="el" href="class_sim_id_dictionary.html">SimIdDictionary</a> </td>
  103. <td>(</td>
  104. <td class="paramname"></td><td>)</td>
  105. <td></td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. </div>
  110. </div>
  111. <a id="a4e5b03f07b800f1391daabe2af83b4db" name="a4e5b03f07b800f1391daabe2af83b4db"></a>
  112. <h2 class="memtitle"><span class="permalink"><a href="#a4e5b03f07b800f1391daabe2af83b4db">&#9670;&#160;</a></span>~SimIdDictionary()</h2>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">~<a class="el" href="class_sim_id_dictionary.html">SimIdDictionary</a> </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. </div>
  125. </div>
  126. <h2 class="groupheader">Member Function Documentation</h2>
  127. <a id="a11c1a29d724be8fd0c7f5a441b0281fc" name="a11c1a29d724be8fd0c7f5a441b0281fc"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#a11c1a29d724be8fd0c7f5a441b0281fc">&#9670;&#160;</a></span>find()</h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname"><a class="el" href="class_sim_object.html">SimObject</a> * find </td>
  134. <td>(</td>
  135. <td class="paramtype">S32&#160;</td>
  136. <td class="paramname"><em>id</em></td><td>)</td>
  137. <td></td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. </div>
  142. </div>
  143. <a id="a722226136876be560416b2d0c66e2cfa" name="a722226136876be560416b2d0c66e2cfa"></a>
  144. <h2 class="memtitle"><span class="permalink"><a href="#a722226136876be560416b2d0c66e2cfa">&#9670;&#160;</a></span>insert()</h2>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <table class="memname">
  148. <tr>
  149. <td class="memname">void insert </td>
  150. <td>(</td>
  151. <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
  152. <td class="paramname"><em>obj</em></td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. </div>
  158. </div>
  159. <a id="a0d4568596d915594eb4b0180c35b2e04" name="a0d4568596d915594eb4b0180c35b2e04"></a>
  160. <h2 class="memtitle"><span class="permalink"><a href="#a0d4568596d915594eb4b0180c35b2e04">&#9670;&#160;</a></span>remove()</h2>
  161. <div class="memitem">
  162. <div class="memproto">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">void remove </td>
  166. <td>(</td>
  167. <td class="paramtype"><a class="el" href="class_sim_object.html">SimObject</a> *&#160;</td>
  168. <td class="paramname"><em>obj</em></td><td>)</td>
  169. <td></td>
  170. </tr>
  171. </table>
  172. </div><div class="memdoc">
  173. </div>
  174. </div>
  175. <hr/>The documentation for this class was generated from the following files:<ul>
  176. <li>sim/<b>simDictionary.h</b></li>
  177. <li>sim/<b>simDictionary.cc</b></li>
  178. </ul>
  179. </div><!-- contents -->
  180. <!-- start footer part -->
  181. <hr class="footer"/><address class="footer"><small>
  182. 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
  183. </small></address>
  184. </body>
  185. </html>