namespace_stream_utils.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  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.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: StreamUtils 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. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('namespace_stream_utils.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#typedef-members">Typedefs</a> &#124;
  108. <a href="#func-members">Functions</a> </div>
  109. <div class="headertitle"><div class="title">StreamUtils Namespace Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
  114. Typedefs</h2></td></tr>
  115. <tr class="memitem:a2c35a4aac73cd9d9d8c567e1cd528603" id="r_a2c35a4aac73cd9d9d8c567e1cd528603"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  116. <tr class="memitem:a2c35a4aac73cd9d9d8c567e1cd528603"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a2c35a4aac73cd9d9d8c567e1cd528603">ObjectToIDMap</a> = <a class="el" href="class_unordered_map.html">UnorderedMap</a>&lt;const Type *, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&gt;</td></tr>
  117. <tr class="separator:a2c35a4aac73cd9d9d8c567e1cd528603"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a4e9b8d62b617c5d31288ae8313a6b6cb" id="r_a4e9b8d62b617c5d31288ae8313a6b6cb"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  119. <tr class="memitem:a4e9b8d62b617c5d31288ae8313a6b6cb"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a4e9b8d62b617c5d31288ae8313a6b6cb">IDToObjectMap</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_ref.html">Ref</a>&lt;Type&gt;&gt;</td></tr>
  120. <tr class="separator:a4e9b8d62b617c5d31288ae8313a6b6cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  123. Functions</h2></td></tr>
  124. <tr class="memitem:a8e2ba0b1630f3d270dfdd4284a468ab9" id="r_a8e2ba0b1630f3d270dfdd4284a468ab9"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  125. <tr class="memitem:a8e2ba0b1630f3d270dfdd4284a468ab9"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_result.html">Result</a>&lt; <a class="el" href="class_ref.html">Ref</a>&lt; Type &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a8e2ba0b1630f3d270dfdd4284a468ab9">RestoreObject</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream, void(Type::*inRestoreBinaryStateFunction)(<a class="el" href="class_stream_in.html">StreamIn</a> &amp;))</td></tr>
  126. <tr class="separator:a8e2ba0b1630f3d270dfdd4284a468ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:af32cd6cffeb28a74dc98d6ba952f3523" id="r_af32cd6cffeb28a74dc98d6ba952f3523"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  128. <tr class="memitem:af32cd6cffeb28a74dc98d6ba952f3523"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#af32cd6cffeb28a74dc98d6ba952f3523">SaveObjectReference</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream, const Type *inObject, <a class="el" href="#a2c35a4aac73cd9d9d8c567e1cd528603">ObjectToIDMap</a>&lt; Type &gt; *ioObjectToIDMap)</td></tr>
  129. <tr class="memdesc:af32cd6cffeb28a74dc98d6ba952f3523"><td class="mdescLeft">&#160;</td><td class="mdescRight">Save an object reference to a stream. Uses a map to map objects to IDs which is also used to prevent writing duplicates. <br /></td></tr>
  130. <tr class="separator:af32cd6cffeb28a74dc98d6ba952f3523"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:aab7d93bea0dbbfa623af7112db1bd8be" id="r_aab7d93bea0dbbfa623af7112db1bd8be"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  132. <tr class="memitem:aab7d93bea0dbbfa623af7112db1bd8be"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_result.html">Result</a>&lt; <a class="el" href="class_ref.html">Ref</a>&lt; Type &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aab7d93bea0dbbfa623af7112db1bd8be">RestoreObjectReference</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream, <a class="el" href="#a4e9b8d62b617c5d31288ae8313a6b6cb">IDToObjectMap</a>&lt; Type &gt; &amp;ioIDToObjectMap)</td></tr>
  133. <tr class="memdesc:aab7d93bea0dbbfa623af7112db1bd8be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore an object reference from stream. <br /></td></tr>
  134. <tr class="separator:aab7d93bea0dbbfa623af7112db1bd8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:ac77c5ff89ac5ab2af2b924af47ba9199" id="r_ac77c5ff89ac5ab2af2b924af47ba9199"><td class="memTemplParams" colspan="2">template&lt;class ArrayType , class ValueType &gt; </td></tr>
  136. <tr class="memitem:ac77c5ff89ac5ab2af2b924af47ba9199"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ac77c5ff89ac5ab2af2b924af47ba9199">SaveObjectArray</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream, const ArrayType &amp;inArray, <a class="el" href="#a2c35a4aac73cd9d9d8c567e1cd528603">ObjectToIDMap</a>&lt; ValueType &gt; *ioObjectToIDMap)</td></tr>
  137. <tr class="separator:ac77c5ff89ac5ab2af2b924af47ba9199"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a388cbbe0f223267d038a57b9fd6e1571" id="r_a388cbbe0f223267d038a57b9fd6e1571"><td class="memTemplParams" colspan="2">template&lt;class ArrayType , class ValueType &gt; </td></tr>
  139. <tr class="memitem:a388cbbe0f223267d038a57b9fd6e1571"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="class_result.html">Result</a>&lt; ArrayType &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a388cbbe0f223267d038a57b9fd6e1571">RestoreObjectArray</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream, <a class="el" href="#a4e9b8d62b617c5d31288ae8313a6b6cb">IDToObjectMap</a>&lt; ValueType &gt; &amp;ioIDToObjectMap)</td></tr>
  140. <tr class="separator:a388cbbe0f223267d038a57b9fd6e1571"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. </table>
  142. <h2 class="groupheader">Typedef Documentation</h2>
  143. <a id="a4e9b8d62b617c5d31288ae8313a6b6cb" name="a4e9b8d62b617c5d31288ae8313a6b6cb"></a>
  144. <h2 class="memtitle"><span class="permalink"><a href="#a4e9b8d62b617c5d31288ae8313a6b6cb">&#9670;&#160;</a></span>IDToObjectMap</h2>
  145. <div class="memitem">
  146. <div class="memproto">
  147. <div class="memtemplate">
  148. template&lt;class Type &gt; </div>
  149. <table class="memname">
  150. <tr>
  151. <td class="memname">using <a class="el" href="#a4e9b8d62b617c5d31288ae8313a6b6cb">StreamUtils::IDToObjectMap</a> = <a class="el" href="class_array.html">Array</a>&lt;<a class="el" href="class_ref.html">Ref</a>&lt;Type&gt;&gt;</td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. </div>
  156. </div>
  157. <a id="a2c35a4aac73cd9d9d8c567e1cd528603" name="a2c35a4aac73cd9d9d8c567e1cd528603"></a>
  158. <h2 class="memtitle"><span class="permalink"><a href="#a2c35a4aac73cd9d9d8c567e1cd528603">&#9670;&#160;</a></span>ObjectToIDMap</h2>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <div class="memtemplate">
  162. template&lt;class Type &gt; </div>
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">using <a class="el" href="#a2c35a4aac73cd9d9d8c567e1cd528603">StreamUtils::ObjectToIDMap</a> = <a class="el" href="class_unordered_map.html">UnorderedMap</a>&lt;const Type *, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&gt;</td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. </div>
  170. </div>
  171. <h2 class="groupheader">Function Documentation</h2>
  172. <a id="a8e2ba0b1630f3d270dfdd4284a468ab9" name="a8e2ba0b1630f3d270dfdd4284a468ab9"></a>
  173. <h2 class="memtitle"><span class="permalink"><a href="#a8e2ba0b1630f3d270dfdd4284a468ab9">&#9670;&#160;</a></span>RestoreObject()</h2>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <div class="memtemplate">
  177. template&lt;class Type &gt; </div>
  178. <table class="memname">
  179. <tr>
  180. <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; <a class="el" href="class_ref.html">Ref</a>&lt; Type &gt; &gt; StreamUtils::RestoreObject </td>
  181. <td>(</td>
  182. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span>, </td>
  183. </tr>
  184. <tr>
  185. <td class="paramkey"></td>
  186. <td></td>
  187. <td class="paramtype">void(Type::*</td> <td class="paramname"><span class="paramname"><em>inRestoreBinaryStateFunction&#160;</em></span>)(<a class="el" href="class_stream_in.html">StreamIn</a> &amp;)&#160;)</td>
  188. </tr>
  189. </table>
  190. </div><div class="memdoc">
  191. </div>
  192. </div>
  193. <a id="a388cbbe0f223267d038a57b9fd6e1571" name="a388cbbe0f223267d038a57b9fd6e1571"></a>
  194. <h2 class="memtitle"><span class="permalink"><a href="#a388cbbe0f223267d038a57b9fd6e1571">&#9670;&#160;</a></span>RestoreObjectArray()</h2>
  195. <div class="memitem">
  196. <div class="memproto">
  197. <div class="memtemplate">
  198. template&lt;class ArrayType , class ValueType &gt; </div>
  199. <table class="memname">
  200. <tr>
  201. <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; ArrayType &gt; StreamUtils::RestoreObjectArray </td>
  202. <td>(</td>
  203. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype"><a class="el" href="#a4e9b8d62b617c5d31288ae8313a6b6cb">IDToObjectMap</a>&lt; ValueType &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>ioIDToObjectMap</em></span>&#160;)</td>
  209. </tr>
  210. </table>
  211. </div><div class="memdoc">
  212. </div>
  213. </div>
  214. <a id="aab7d93bea0dbbfa623af7112db1bd8be" name="aab7d93bea0dbbfa623af7112db1bd8be"></a>
  215. <h2 class="memtitle"><span class="permalink"><a href="#aab7d93bea0dbbfa623af7112db1bd8be">&#9670;&#160;</a></span>RestoreObjectReference()</h2>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <div class="memtemplate">
  219. template&lt;class Type &gt; </div>
  220. <table class="memname">
  221. <tr>
  222. <td class="memname"><a class="el" href="class_result.html">Result</a>&lt; <a class="el" href="class_ref.html">Ref</a>&lt; Type &gt; &gt; StreamUtils::RestoreObjectReference </td>
  223. <td>(</td>
  224. <td class="paramtype"><a class="el" href="class_stream_in.html">StreamIn</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span>, </td>
  225. </tr>
  226. <tr>
  227. <td class="paramkey"></td>
  228. <td></td>
  229. <td class="paramtype"><a class="el" href="#a4e9b8d62b617c5d31288ae8313a6b6cb">IDToObjectMap</a>&lt; Type &gt; &amp;</td> <td class="paramname"><span class="paramname"><em>ioIDToObjectMap</em></span>&#160;)</td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Restore an object reference from stream. </p>
  234. </div>
  235. </div>
  236. <a id="ac77c5ff89ac5ab2af2b924af47ba9199" name="ac77c5ff89ac5ab2af2b924af47ba9199"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#ac77c5ff89ac5ab2af2b924af47ba9199">&#9670;&#160;</a></span>SaveObjectArray()</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <div class="memtemplate">
  241. template&lt;class ArrayType , class ValueType &gt; </div>
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">void StreamUtils::SaveObjectArray </td>
  245. <td>(</td>
  246. <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span>, </td>
  247. </tr>
  248. <tr>
  249. <td class="paramkey"></td>
  250. <td></td>
  251. <td class="paramtype">const ArrayType &amp;</td> <td class="paramname"><span class="paramname"><em>inArray</em></span>, </td>
  252. </tr>
  253. <tr>
  254. <td class="paramkey"></td>
  255. <td></td>
  256. <td class="paramtype"><a class="el" href="#a2c35a4aac73cd9d9d8c567e1cd528603">ObjectToIDMap</a>&lt; ValueType &gt; *</td> <td class="paramname"><span class="paramname"><em>ioObjectToIDMap</em></span>&#160;)</td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. </div>
  261. </div>
  262. <a id="af32cd6cffeb28a74dc98d6ba952f3523" name="af32cd6cffeb28a74dc98d6ba952f3523"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#af32cd6cffeb28a74dc98d6ba952f3523">&#9670;&#160;</a></span>SaveObjectReference()</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <div class="memtemplate">
  267. template&lt;class Type &gt; </div>
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">void StreamUtils::SaveObjectReference </td>
  271. <td>(</td>
  272. <td class="paramtype"><a class="el" href="class_stream_out.html">StreamOut</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span>, </td>
  273. </tr>
  274. <tr>
  275. <td class="paramkey"></td>
  276. <td></td>
  277. <td class="paramtype">const Type *</td> <td class="paramname"><span class="paramname"><em>inObject</em></span>, </td>
  278. </tr>
  279. <tr>
  280. <td class="paramkey"></td>
  281. <td></td>
  282. <td class="paramtype"><a class="el" href="#a2c35a4aac73cd9d9d8c567e1cd528603">ObjectToIDMap</a>&lt; Type &gt; *</td> <td class="paramname"><span class="paramname"><em>ioObjectToIDMap</em></span>&#160;)</td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. <p>Save an object reference to a stream. Uses a map to map objects to IDs which is also used to prevent writing duplicates. </p>
  287. </div>
  288. </div>
  289. </div><!-- contents -->
  290. </div><!-- doc-content -->
  291. <!-- start footer part -->
  292. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  293. <ul>
  294. <li class="navelem"><a class="el" href="namespace_stream_utils.html">StreamUtils</a></li>
  295. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  296. </ul>
  297. </div>
  298. </body>
  299. </html>