cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: ObjectStream Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_object_stream.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="class_object_stream-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ObjectStream Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Base class for object stream input and output streams.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_object_stream_8h_source.html">ObjectStream.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ObjectStream:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_object_stream.png" usemap="#ObjectStream_map" alt=""/>
  <map id="ObjectStream_map" name="ObjectStream_map">
<area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="232,0,377,24"/>
<area href="class_i_object_stream_in.html" title="Interface class for reading from an object stream." alt="IObjectStreamIn" shape="rect" coords="77,112,222,136"/>
<area href="class_i_object_stream_out.html" title="Interface class for writing to an object stream." alt="IObjectStreamOut" shape="rect" coords="387,112,532,136"/>
<area href="class_object_stream_in.html" alt="ObjectStreamIn" shape="rect" coords="77,168,222,192"/>
<area href="class_object_stream_out.html" alt="ObjectStreamOut" shape="rect" coords="387,168,532,192"/>
<area href="class_object_stream_binary_in.html" title="Implementation of ObjectStream binary input stream." alt="ObjectStreamBinaryIn" shape="rect" coords="0,224,145,248"/>
<area href="class_object_stream_text_in.html" title="Implementation of ObjectStream text input stream." alt="ObjectStreamTextIn" shape="rect" coords="155,224,300,248"/>
<area href="class_object_stream_binary_out.html" title="Implementation of ObjectStream binary output stream." alt="ObjectStreamBinaryOut" shape="rect" coords="310,224,455,248"/>
<area href="class_object_stream_text_out.html" title="Implementation of ObjectStream text output stream." alt="ObjectStreamTextOut" shape="rect" coords="465,224,610,248"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a5feef3b87da292623ebf2a04c7c3482e" id="r_a5feef3b87da292623ebf2a04c7c3482e"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5feef3b87da292623ebf2a04c7c3482e">EStreamType</a> { <a class="el" href="#a5feef3b87da292623ebf2a04c7c3482ea9dffbf69ffba8bc38bc4e01abf4b1675">Text</a>
, <a class="el" href="#a5feef3b87da292623ebf2a04c7c3482ea6ce976e8f061b2b5cfe4d0c50c3405dd">Binary</a>
 }</td></tr>
<tr class="memdesc:a5feef3b87da292623ebf2a04c7c3482e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stream type.  <a href="#a5feef3b87da292623ebf2a04c7c3482e">More...</a><br /></td></tr>
<tr class="separator:a5feef3b87da292623ebf2a04c7c3482e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-types" name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:a03085cd2aa375ca2c773579947434455" id="r_a03085cd2aa375ca2c773579947434455"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a03085cd2aa375ca2c773579947434455">Identifier</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td></tr>
<tr class="memdesc:a03085cd2aa375ca2c773579947434455"><td class="mdescLeft">&#160;</td><td class="mdescRight">Identifier for objects.  <br /></td></tr>
<tr class="separator:a03085cd2aa375ca2c773579947434455"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a0a01e88706acdcadf4b7cc7af99a008e" id="r_a0a01e88706acdcadf4b7cc7af99a008e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0a01e88706acdcadf4b7cc7af99a008e">~ObjectStream</a> ()=default</td></tr>
<tr class="memdesc:a0a01e88706acdcadf4b7cc7af99a008e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <br /></td></tr>
<tr class="separator:a0a01e88706acdcadf4b7cc7af99a008e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-static-attribs" name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:af44c611aa03b15ebaf81e50dc244151c" id="r_af44c611aa03b15ebaf81e50dc244151c"><td class="memItemLeft" align="right" valign="top">static constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af44c611aa03b15ebaf81e50dc244151c">sVersion</a> = 1</td></tr>
<tr class="separator:af44c611aa03b15ebaf81e50dc244151c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b50736a6c66df50ba7274ca6a3c0686" id="r_a9b50736a6c66df50ba7274ca6a3c0686"><td class="memItemLeft" align="right" valign="top">static constexpr int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b50736a6c66df50ba7274ca6a3c0686">sRevision</a> = 0</td></tr>
<tr class="separator:a9b50736a6c66df50ba7274ca6a3c0686"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb1b32a3aff83d99a4ac14c5cb828778" id="r_afb1b32a3aff83d99a4ac14c5cb828778"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="#a03085cd2aa375ca2c773579947434455">Identifier</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb1b32a3aff83d99a4ac14c5cb828778">sNullIdentifier</a> = 0</td></tr>
<tr class="separator:afb1b32a3aff83d99a4ac14c5cb828778"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
<tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
<tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
<tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Base class for object stream input and output streams. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a03085cd2aa375ca2c773579947434455" name="a03085cd2aa375ca2c773579947434455"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03085cd2aa375ca2c773579947434455">&#9670;&#160;</a></span>Identifier</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="#a03085cd2aa375ca2c773579947434455">ObjectStream::Identifier</a> = <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Identifier for objects. </p>

</div>
</div>
<h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a5feef3b87da292623ebf2a04c7c3482e" name="a5feef3b87da292623ebf2a04c7c3482e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5feef3b87da292623ebf2a04c7c3482e">&#9670;&#160;</a></span>EStreamType</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum class <a class="el" href="#a5feef3b87da292623ebf2a04c7c3482e">ObjectStream::EStreamType</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">strong</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Stream type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a5feef3b87da292623ebf2a04c7c3482ea9dffbf69ffba8bc38bc4e01abf4b1675" name="a5feef3b87da292623ebf2a04c7c3482ea9dffbf69ffba8bc38bc4e01abf4b1675"></a>Text&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a5feef3b87da292623ebf2a04c7c3482ea6ce976e8f061b2b5cfe4d0c50c3405dd" name="a5feef3b87da292623ebf2a04c7c3482ea6ce976e8f061b2b5cfe4d0c50c3405dd"></a>Binary&#160;</td><td class="fielddoc"></td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0a01e88706acdcadf4b7cc7af99a008e" name="a0a01e88706acdcadf4b7cc7af99a008e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a01e88706acdcadf4b7cc7af99a008e">&#9670;&#160;</a></span>~ObjectStream()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ObjectStream::~ObjectStream </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="afb1b32a3aff83d99a4ac14c5cb828778" name="afb1b32a3aff83d99a4ac14c5cb828778"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb1b32a3aff83d99a4ac14c5cb828778">&#9670;&#160;</a></span>sNullIdentifier</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="#a03085cd2aa375ca2c773579947434455">Identifier</a> ObjectStream::sNullIdentifier = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a9b50736a6c66df50ba7274ca6a3c0686" name="a9b50736a6c66df50ba7274ca6a3c0686"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b50736a6c66df50ba7274ca6a3c0686">&#9670;&#160;</a></span>sRevision</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int ObjectStream::sRevision = 0</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="af44c611aa03b15ebaf81e50dc244151c" name="af44c611aa03b15ebaf81e50dc244151c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af44c611aa03b15ebaf81e50dc244151c">&#9670;&#160;</a></span>sVersion</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int ObjectStream::sVersion = 1</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/ObjectStream/<a class="el" href="_object_stream_8h_source.html">ObjectStream.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_object_stream.html">ObjectStream</a></li>
    <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>
  </ul>
</div>
</body>
</html>