_stream_utils_8h.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  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: Jolt/Core/StreamUtils.h File 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('_stream_utils_8h.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="#namespaces">Namespaces</a> &#124;
  108. <a href="#typedef-members">Typedefs</a> &#124;
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle"><div class="title">StreamUtils.h File Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <div class="textblock"><code>#include &lt;<a class="el" href="_result_8h_source.html">Jolt/Core/Result.h</a>&gt;</code><br />
  114. <code>#include &lt;<a class="el" href="_stream_in_8h_source.html">Jolt/Core/StreamIn.h</a>&gt;</code><br />
  115. <code>#include &lt;<a class="el" href="_stream_out_8h_source.html">Jolt/Core/StreamOut.h</a>&gt;</code><br />
  116. <code>#include &lt;<a class="el" href="_unordered_map_8h_source.html">Jolt/Core/UnorderedMap.h</a>&gt;</code><br />
  117. <code>#include &lt;<a class="el" href="_factory_8h_source.html">Jolt/Core/Factory.h</a>&gt;</code><br />
  118. </div>
  119. <p><a href="_stream_utils_8h_source.html">Go to the source code of this file.</a></p>
  120. <table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
  122. Namespaces</h2></td></tr>
  123. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_stream_utils.html">StreamUtils</a></td></tr>
  124. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. </table><table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
  127. Typedefs</h2></td></tr>
  128. <tr class="memitem:a2c35a4aac73cd9d9d8c567e1cd528603" id="r_a2c35a4aac73cd9d9d8c567e1cd528603"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  129. <tr class="memitem:a2c35a4aac73cd9d9d8c567e1cd528603"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_stream_utils.html#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></tr>
  130. <tr class="separator:a2c35a4aac73cd9d9d8c567e1cd528603"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:a4e9b8d62b617c5d31288ae8313a6b6cb" id="r_a4e9b8d62b617c5d31288ae8313a6b6cb"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  132. <tr class="memitem:a4e9b8d62b617c5d31288ae8313a6b6cb"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_stream_utils.html#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></tr>
  133. <tr class="separator:a4e9b8d62b617c5d31288ae8313a6b6cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table><table class="memberdecls">
  135. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  136. Functions</h2></td></tr>
  137. <tr class="memitem:a8e2ba0b1630f3d270dfdd4284a468ab9" id="r_a8e2ba0b1630f3d270dfdd4284a468ab9"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  138. <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="namespace_stream_utils.html#a8e2ba0b1630f3d270dfdd4284a468ab9">StreamUtils::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>
  139. <tr class="separator:a8e2ba0b1630f3d270dfdd4284a468ab9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:af32cd6cffeb28a74dc98d6ba952f3523" id="r_af32cd6cffeb28a74dc98d6ba952f3523"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  141. <tr class="memitem:af32cd6cffeb28a74dc98d6ba952f3523"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_stream_utils.html#af32cd6cffeb28a74dc98d6ba952f3523">StreamUtils::SaveObjectReference</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream, const Type *inObject, <a class="el" href="namespace_stream_utils.html#a2c35a4aac73cd9d9d8c567e1cd528603">ObjectToIDMap</a>&lt; Type &gt; *ioObjectToIDMap)</td></tr>
  142. <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>
  143. <tr class="separator:af32cd6cffeb28a74dc98d6ba952f3523"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:aab7d93bea0dbbfa623af7112db1bd8be" id="r_aab7d93bea0dbbfa623af7112db1bd8be"><td class="memTemplParams" colspan="2">template&lt;class Type &gt; </td></tr>
  145. <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="namespace_stream_utils.html#aab7d93bea0dbbfa623af7112db1bd8be">StreamUtils::RestoreObjectReference</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream, <a class="el" href="namespace_stream_utils.html#a4e9b8d62b617c5d31288ae8313a6b6cb">IDToObjectMap</a>&lt; Type &gt; &amp;ioIDToObjectMap)</td></tr>
  146. <tr class="memdesc:aab7d93bea0dbbfa623af7112db1bd8be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restore an object reference from stream. <br /></td></tr>
  147. <tr class="separator:aab7d93bea0dbbfa623af7112db1bd8be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:ac77c5ff89ac5ab2af2b924af47ba9199" id="r_ac77c5ff89ac5ab2af2b924af47ba9199"><td class="memTemplParams" colspan="2">template&lt;class ArrayType , class ValueType &gt; </td></tr>
  149. <tr class="memitem:ac77c5ff89ac5ab2af2b924af47ba9199"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespace_stream_utils.html#ac77c5ff89ac5ab2af2b924af47ba9199">StreamUtils::SaveObjectArray</a> (<a class="el" href="class_stream_out.html">StreamOut</a> &amp;inStream, const ArrayType &amp;inArray, <a class="el" href="namespace_stream_utils.html#a2c35a4aac73cd9d9d8c567e1cd528603">ObjectToIDMap</a>&lt; ValueType &gt; *ioObjectToIDMap)</td></tr>
  150. <tr class="separator:ac77c5ff89ac5ab2af2b924af47ba9199"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a388cbbe0f223267d038a57b9fd6e1571" id="r_a388cbbe0f223267d038a57b9fd6e1571"><td class="memTemplParams" colspan="2">template&lt;class ArrayType , class ValueType &gt; </td></tr>
  152. <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="namespace_stream_utils.html#a388cbbe0f223267d038a57b9fd6e1571">StreamUtils::RestoreObjectArray</a> (<a class="el" href="class_stream_in.html">StreamIn</a> &amp;inStream, <a class="el" href="namespace_stream_utils.html#a4e9b8d62b617c5d31288ae8313a6b6cb">IDToObjectMap</a>&lt; ValueType &gt; &amp;ioIDToObjectMap)</td></tr>
  153. <tr class="separator:a388cbbe0f223267d038a57b9fd6e1571"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. </table>
  155. </div><!-- contents -->
  156. </div><!-- doc-content -->
  157. <!-- start footer part -->
  158. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  159. <ul>
  160. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_1b21a6f5692b6d84bf3b848a79181d46.html">Core</a></li><li class="navelem"><a class="el" href="_stream_utils_8h.html">StreamUtils.h</a></li>
  161. <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>
  162. </ul>
  163. </div>
  164. </body>
  165. </html>