namespace_utility.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  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: Utility Namespace 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="#func-members">Functions</a> </div>
  73. <div class="headertitle"><div class="title">Utility Namespace Reference</div></div>
  74. </div><!--header-->
  75. <div class="contents">
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  78. Functions</h2></td></tr>
  79. <tr class="memitem:a84f97688767e2dd4fc953b85782f676d" id="r_a84f97688767e2dd4fc953b85782f676d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_utility.html#a84f97688767e2dd4fc953b85782f676d">mGetFirstNonWhitespace</a> (const char *inString)</td></tr>
  80. <tr class="memdesc:a84f97688767e2dd4fc953b85782f676d"><td class="mdescLeft">&#160;</td><td class="mdescRight">String helpers. <br /></td></tr>
  81. <tr class="separator:a84f97688767e2dd4fc953b85782f676d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a91eab62fc1c5be36b1522a2b026f6639" id="r_a91eab62fc1c5be36b1522a2b026f6639"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_vector2.html">Vector2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_utility.html#a91eab62fc1c5be36b1522a2b026f6639">mGetStringElementVector</a> (const char *inString, const U32 index)</td></tr>
  83. <tr class="separator:a91eab62fc1c5be36b1522a2b026f6639"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ae7e35394a8a9547c27247659e6df5383" id="r_ae7e35394a8a9547c27247659e6df5383"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">VectorF</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_utility.html#ae7e35394a8a9547c27247659e6df5383">mGetStringElementVector3D</a> (const char *inString, const U32 index)</td></tr>
  85. <tr class="separator:ae7e35394a8a9547c27247659e6df5383"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a37a4288af80c4bb81cd9a585f531599d" id="r_a37a4288af80c4bb81cd9a585f531599d"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_utility.html#a37a4288af80c4bb81cd9a585f531599d">mGetStringElement</a> (const char *inString, const U32 index, const bool copyBuffer)</td></tr>
  87. <tr class="separator:a37a4288af80c4bb81cd9a585f531599d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:aff720b7af55fec54092d24b7dec1161c" id="r_aff720b7af55fec54092d24b7dec1161c"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_utility.html#aff720b7af55fec54092d24b7dec1161c">mGetStringElementCount</a> (const char *inString)</td></tr>
  89. <tr class="separator:aff720b7af55fec54092d24b7dec1161c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a8f386608a01e02b82bf6f2366f27ddce" id="r_a8f386608a01e02b82bf6f2366f27ddce"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_utility.html#a8f386608a01e02b82bf6f2366f27ddce">mConvertStringToMask</a> (const char *string)</td></tr>
  91. <tr class="separator:a8f386608a01e02b82bf6f2366f27ddce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ae7d431a8dd77f727e3eac157856afdf0" id="r_ae7d431a8dd77f727e3eac157856afdf0"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_utility.html#ae7d431a8dd77f727e3eac157856afdf0">mConvertMaskToString</a> (const U32 mask)</td></tr>
  93. <tr class="separator:ae7d431a8dd77f727e3eac157856afdf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table>
  95. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  96. <div class="textblock"><hr />
  97. </div><h2 class="groupheader">Function Documentation</h2>
  98. <a id="ae7d431a8dd77f727e3eac157856afdf0" name="ae7d431a8dd77f727e3eac157856afdf0"></a>
  99. <h2 class="memtitle"><span class="permalink"><a href="#ae7d431a8dd77f727e3eac157856afdf0">&#9670;&#160;</a></span>mConvertMaskToString()</h2>
  100. <div class="memitem">
  101. <div class="memproto">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">const char * mConvertMaskToString </td>
  105. <td>(</td>
  106. <td class="paramtype">const U32&#160;</td>
  107. <td class="paramname"><em>mask</em></td><td>)</td>
  108. <td></td>
  109. </tr>
  110. </table>
  111. </div><div class="memdoc">
  112. </div>
  113. </div>
  114. <a id="a8f386608a01e02b82bf6f2366f27ddce" name="a8f386608a01e02b82bf6f2366f27ddce"></a>
  115. <h2 class="memtitle"><span class="permalink"><a href="#a8f386608a01e02b82bf6f2366f27ddce">&#9670;&#160;</a></span>mConvertStringToMask()</h2>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">U32 mConvertStringToMask </td>
  121. <td>(</td>
  122. <td class="paramtype">const char *&#160;</td>
  123. <td class="paramname"><em>string</em></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </div><div class="memdoc">
  128. </div>
  129. </div>
  130. <a id="a84f97688767e2dd4fc953b85782f676d" name="a84f97688767e2dd4fc953b85782f676d"></a>
  131. <h2 class="memtitle"><span class="permalink"><a href="#a84f97688767e2dd4fc953b85782f676d">&#9670;&#160;</a></span>mGetFirstNonWhitespace()</h2>
  132. <div class="memitem">
  133. <div class="memproto">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">const char * mGetFirstNonWhitespace </td>
  137. <td>(</td>
  138. <td class="paramtype">const char *&#160;</td>
  139. <td class="paramname"><em>inString</em></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>String helpers. </p>
  145. </div>
  146. </div>
  147. <a id="a37a4288af80c4bb81cd9a585f531599d" name="a37a4288af80c4bb81cd9a585f531599d"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a37a4288af80c4bb81cd9a585f531599d">&#9670;&#160;</a></span>mGetStringElement()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="memname">
  152. <tr>
  153. <td class="memname">const char * mGetStringElement </td>
  154. <td>(</td>
  155. <td class="paramtype">const char *&#160;</td>
  156. <td class="paramname"><em>inString</em>, </td>
  157. </tr>
  158. <tr>
  159. <td class="paramkey"></td>
  160. <td></td>
  161. <td class="paramtype">const U32&#160;</td>
  162. <td class="paramname"><em>index</em>, </td>
  163. </tr>
  164. <tr>
  165. <td class="paramkey"></td>
  166. <td></td>
  167. <td class="paramtype">const bool&#160;</td>
  168. <td class="paramname"><em>copyBuffer</em>&#160;</td>
  169. </tr>
  170. <tr>
  171. <td></td>
  172. <td>)</td>
  173. <td></td><td></td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. </div>
  178. </div>
  179. <a id="aff720b7af55fec54092d24b7dec1161c" name="aff720b7af55fec54092d24b7dec1161c"></a>
  180. <h2 class="memtitle"><span class="permalink"><a href="#aff720b7af55fec54092d24b7dec1161c">&#9670;&#160;</a></span>mGetStringElementCount()</h2>
  181. <div class="memitem">
  182. <div class="memproto">
  183. <table class="memname">
  184. <tr>
  185. <td class="memname">U32 mGetStringElementCount </td>
  186. <td>(</td>
  187. <td class="paramtype">const char *&#160;</td>
  188. <td class="paramname"><em>inString</em></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. </div>
  194. </div>
  195. <a id="a91eab62fc1c5be36b1522a2b026f6639" name="a91eab62fc1c5be36b1522a2b026f6639"></a>
  196. <h2 class="memtitle"><span class="permalink"><a href="#a91eab62fc1c5be36b1522a2b026f6639">&#9670;&#160;</a></span>mGetStringElementVector()</h2>
  197. <div class="memitem">
  198. <div class="memproto">
  199. <table class="memname">
  200. <tr>
  201. <td class="memname"><a class="el" href="struct_vector2.html">Vector2</a> mGetStringElementVector </td>
  202. <td>(</td>
  203. <td class="paramtype">const char *&#160;</td>
  204. <td class="paramname"><em>inString</em>, </td>
  205. </tr>
  206. <tr>
  207. <td class="paramkey"></td>
  208. <td></td>
  209. <td class="paramtype">const U32&#160;</td>
  210. <td class="paramname"><em>index</em>&#160;</td>
  211. </tr>
  212. <tr>
  213. <td></td>
  214. <td>)</td>
  215. <td></td><td></td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. </div>
  220. </div>
  221. <a id="ae7e35394a8a9547c27247659e6df5383" name="ae7e35394a8a9547c27247659e6df5383"></a>
  222. <h2 class="memtitle"><span class="permalink"><a href="#ae7e35394a8a9547c27247659e6df5383">&#9670;&#160;</a></span>mGetStringElementVector3D()</h2>
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname"><a class="el" href="class_point3_f.html">VectorF</a> mGetStringElementVector3D </td>
  228. <td>(</td>
  229. <td class="paramtype">const char *&#160;</td>
  230. <td class="paramname"><em>inString</em>, </td>
  231. </tr>
  232. <tr>
  233. <td class="paramkey"></td>
  234. <td></td>
  235. <td class="paramtype">const U32&#160;</td>
  236. <td class="paramname"><em>index</em>&#160;</td>
  237. </tr>
  238. <tr>
  239. <td></td>
  240. <td>)</td>
  241. <td></td><td></td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. </div>
  246. </div>
  247. </div><!-- contents -->
  248. <!-- start footer part -->
  249. <hr class="footer"/><address class="footer"><small>
  250. 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
  251. </small></address>
  252. </body>
  253. </html>