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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513
							<!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: StreamIn 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_stream_in.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-methods">Public Member Functions</a> &#124;
<a href="class_stream_in-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">StreamIn Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">

<p>Simple binary input stream.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_stream_in_8h_source.html">StreamIn.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for StreamIn:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_stream_in.png" usemap="#StreamIn_map" alt=""/>
  <map id="StreamIn_map" name="StreamIn_map">
<area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="62,0,177,24"/>
<area href="class_state_recorder.html" alt="StateRecorder" shape="rect" coords="0,112,115,136"/>
<area href="class_stream_in_wrapper.html" title="Wrapper around std::istream." alt="StreamInWrapper" shape="rect" coords="125,112,240,136"/>
<area href="class_state_recorder_impl.html" title="Implementation of the StateRecorder class that uses a stringstream as underlying store and that imple..." alt="StateRecorderImpl" shape="rect" coords="0,168,115,192"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a294d4a6d12c54b6bd31b67a627075c34" id="r_a294d4a6d12c54b6bd31b67a627075c34"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a294d4a6d12c54b6bd31b67a627075c34">~StreamIn</a> ()=default</td></tr>
<tr class="memdesc:a294d4a6d12c54b6bd31b67a627075c34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <br /></td></tr>
<tr class="separator:a294d4a6d12c54b6bd31b67a627075c34"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85303621b160dd9280ca9b7ff67d8217" id="r_a85303621b160dd9280ca9b7ff67d8217"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a85303621b160dd9280ca9b7ff67d8217">ReadBytes</a> (void *outData, size_t inNumBytes)=0</td></tr>
<tr class="memdesc:a85303621b160dd9280ca9b7ff67d8217"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a string of bytes from the binary stream.  <br /></td></tr>
<tr class="separator:a85303621b160dd9280ca9b7ff67d8217"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9a2a616b63703ec5c80423ad2692d06e" id="r_a9a2a616b63703ec5c80423ad2692d06e"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9a2a616b63703ec5c80423ad2692d06e">IsEOF</a> () const =0</td></tr>
<tr class="separator:a9a2a616b63703ec5c80423ad2692d06e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abda7a049c94885abd04a6e583e4c5b37" id="r_abda7a049c94885abd04a6e583e4c5b37"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abda7a049c94885abd04a6e583e4c5b37">IsFailed</a> () const =0</td></tr>
<tr class="memdesc:abda7a049c94885abd04a6e583e4c5b37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if there was an IO failure.  <br /></td></tr>
<tr class="separator:abda7a049c94885abd04a6e583e4c5b37"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5ae9304c310edfc5ef1c67a95e36b1f3" id="r_a5ae9304c310edfc5ef1c67a95e36b1f3"><td class="memTemplParams" colspan="2">template&lt;class T , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt;  = true&gt; </td></tr>
<tr class="memitem:a5ae9304c310edfc5ef1c67a95e36b1f3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a5ae9304c310edfc5ef1c67a95e36b1f3">Read</a> (T &amp;outT)</td></tr>
<tr class="memdesc:a5ae9304c310edfc5ef1c67a95e36b1f3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a primitive (e.g. float, int, etc.) from the binary stream.  <br /></td></tr>
<tr class="separator:a5ae9304c310edfc5ef1c67a95e36b1f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad746a4bb01b4d67767bf1bd200edcb01" id="r_ad746a4bb01b4d67767bf1bd200edcb01"><td class="memTemplParams" colspan="2">template&lt;class T , class A , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt;  = true&gt; </td></tr>
<tr class="memitem:ad746a4bb01b4d67767bf1bd200edcb01"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#ad746a4bb01b4d67767bf1bd200edcb01">Read</a> (<a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;outT)</td></tr>
<tr class="memdesc:ad746a4bb01b4d67767bf1bd200edcb01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a vector of primitives from the binary stream.  <br /></td></tr>
<tr class="separator:ad746a4bb01b4d67767bf1bd200edcb01"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f7322ce8d07d787701f3417aa46f265" id="r_a6f7322ce8d07d787701f3417aa46f265"><td class="memTemplParams" colspan="2">template&lt;class Type , class Traits , class Allocator &gt; </td></tr>
<tr class="memitem:a6f7322ce8d07d787701f3417aa46f265"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a6f7322ce8d07d787701f3417aa46f265">Read</a> (std::basic_string&lt; Type, Traits, Allocator &gt; &amp;outString)</td></tr>
<tr class="memdesc:a6f7322ce8d07d787701f3417aa46f265"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a string from the binary stream (reads the number of characters and then the characters)  <br /></td></tr>
<tr class="separator:a6f7322ce8d07d787701f3417aa46f265"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a685f7e59d2108a0c61dad52c042d7e45" id="r_a685f7e59d2108a0c61dad52c042d7e45"><td class="memTemplParams" colspan="2">template&lt;class T , class A , typename F &gt; </td></tr>
<tr class="memitem:a685f7e59d2108a0c61dad52c042d7e45"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a685f7e59d2108a0c61dad52c042d7e45">Read</a> (<a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;outT, const F &amp;inReadElement)</td></tr>
<tr class="memdesc:a685f7e59d2108a0c61dad52c042d7e45"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a vector of primitives from the binary stream using a custom function to read the elements.  <br /></td></tr>
<tr class="separator:a685f7e59d2108a0c61dad52c042d7e45"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a73a1ab9b7b8c0807e88b9b969acb24bf" id="r_a73a1ab9b7b8c0807e88b9b969acb24bf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a73a1ab9b7b8c0807e88b9b969acb24bf">Read</a> (<a class="el" href="class_vec3.html">Vec3</a> &amp;outVec)</td></tr>
<tr class="memdesc:a73a1ab9b7b8c0807e88b9b969acb24bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a <a class="el" href="class_vec3.html">Vec3</a> (don't read W)  <br /></td></tr>
<tr class="separator:a73a1ab9b7b8c0807e88b9b969acb24bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2a6c51ed1848c45cd9974cec509020e" id="r_ae2a6c51ed1848c45cd9974cec509020e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae2a6c51ed1848c45cd9974cec509020e">Read</a> (<a class="el" href="class_d_vec3.html">DVec3</a> &amp;outVec)</td></tr>
<tr class="memdesc:ae2a6c51ed1848c45cd9974cec509020e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a <a class="el" href="class_d_vec3.html">DVec3</a> (don't read W)  <br /></td></tr>
<tr class="separator:ae2a6c51ed1848c45cd9974cec509020e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4bea0c5775a7c29522359528d98c654" id="r_ad4bea0c5775a7c29522359528d98c654"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad4bea0c5775a7c29522359528d98c654">Read</a> (<a class="el" href="class_d_mat44.html">DMat44</a> &amp;outVec)</td></tr>
<tr class="memdesc:ad4bea0c5775a7c29522359528d98c654"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a <a class="el" href="class_d_mat44.html" title="Holds a 4x4 matrix of floats with the last column consisting of doubles.">DMat44</a> (don't read W component of translation)  <br /></td></tr>
<tr class="separator:ad4bea0c5775a7c29522359528d98c654"><td class="memSeparator" colspan="2">&#160;</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>Simple binary input stream. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a294d4a6d12c54b6bd31b67a627075c34" name="a294d4a6d12c54b6bd31b67a627075c34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a294d4a6d12c54b6bd31b67a627075c34">&#9670;&#160;</a></span>~StreamIn()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual StreamIn::~StreamIn </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">virtual</span><span class="mlabel">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Virtual destructor. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9a2a616b63703ec5c80423ad2692d06e" name="a9a2a616b63703ec5c80423ad2692d06e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a2a616b63703ec5c80423ad2692d06e">&#9670;&#160;</a></span>IsEOF()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool StreamIn::IsEOF </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Returns true when an attempt has been made to read past the end of the file. Note that this follows the convention of std::basic_ios::eof which only returns true when an attempt is made to read past the end, not when the read pointer is at the end. </p>

<p>Implemented in <a class="el" href="class_state_recorder_impl.html#a3b68bb167e95e3bfe5777fc1c6f5b398">StateRecorderImpl</a>, and <a class="el" href="class_stream_in_wrapper.html#ae426f7046722abc95d5e1a9205d535da">StreamInWrapper</a>.</p>

</div>
</div>
<a id="abda7a049c94885abd04a6e583e4c5b37" name="abda7a049c94885abd04a6e583e4c5b37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abda7a049c94885abd04a6e583e4c5b37">&#9670;&#160;</a></span>IsFailed()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool StreamIn::IsFailed </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns true if there was an IO failure. </p>

<p>Implemented in <a class="el" href="class_state_recorder_impl.html#a30053c8a2baa5e3cb4e5e26c37afda05">StateRecorderImpl</a>, and <a class="el" href="class_stream_in_wrapper.html#a239494d64eb786bb0d4b0fb55cc621e0">StreamInWrapper</a>.</p>

</div>
</div>
<a id="ad746a4bb01b4d67767bf1bd200edcb01" name="ad746a4bb01b4d67767bf1bd200edcb01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad746a4bb01b4d67767bf1bd200edcb01">&#9670;&#160;</a></span>Read() <span class="overload">[1/7]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class A , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt;  = true&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StreamIn::Read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em>outT</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a vector of primitives from the binary stream. </p>

</div>
</div>
<a id="a685f7e59d2108a0c61dad52c042d7e45" name="a685f7e59d2108a0c61dad52c042d7e45"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a685f7e59d2108a0c61dad52c042d7e45">&#9670;&#160;</a></span>Read() <span class="overload">[2/7]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class A , typename F &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StreamIn::Read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_array.html">Array</a>&lt; T, A &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em>outT</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const F &amp;</td>          <td class="paramname"><span class="paramname"><em>inReadElement</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a vector of primitives from the binary stream using a custom function to read the elements. </p>

</div>
</div>
<a id="ad4bea0c5775a7c29522359528d98c654" name="ad4bea0c5775a7c29522359528d98c654"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad4bea0c5775a7c29522359528d98c654">&#9670;&#160;</a></span>Read() <span class="overload">[3/7]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StreamIn::Read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_d_mat44.html">DMat44</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>outVec</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a <a class="el" href="class_d_mat44.html" title="Holds a 4x4 matrix of floats with the last column consisting of doubles.">DMat44</a> (don't read W component of translation) </p>

</div>
</div>
<a id="ae2a6c51ed1848c45cd9974cec509020e" name="ae2a6c51ed1848c45cd9974cec509020e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2a6c51ed1848c45cd9974cec509020e">&#9670;&#160;</a></span>Read() <span class="overload">[4/7]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StreamIn::Read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_d_vec3.html">DVec3</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>outVec</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a <a class="el" href="class_d_vec3.html">DVec3</a> (don't read W) </p>

</div>
</div>
<a id="a6f7322ce8d07d787701f3417aa46f265" name="a6f7322ce8d07d787701f3417aa46f265"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f7322ce8d07d787701f3417aa46f265">&#9670;&#160;</a></span>Read() <span class="overload">[5/7]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Type , class Traits , class Allocator &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StreamIn::Read </td>
          <td>(</td>
          <td class="paramtype">std::basic_string&lt; Type, Traits, Allocator &gt; &amp;</td>          <td class="paramname"><span class="paramname"><em>outString</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a string from the binary stream (reads the number of characters and then the characters) </p>

</div>
</div>
<a id="a5ae9304c310edfc5ef1c67a95e36b1f3" name="a5ae9304c310edfc5ef1c67a95e36b1f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ae9304c310edfc5ef1c67a95e36b1f3">&#9670;&#160;</a></span>Read() <span class="overload">[6/7]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , std::enable_if_t&lt; std::is_trivially_copyable_v&lt; T &gt;, bool &gt;  = true&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StreamIn::Read </td>
          <td>(</td>
          <td class="paramtype">T &amp;</td>          <td class="paramname"><span class="paramname"><em>outT</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a primitive (e.g. float, int, etc.) from the binary stream. </p>

</div>
</div>
<a id="a73a1ab9b7b8c0807e88b9b969acb24bf" name="a73a1ab9b7b8c0807e88b9b969acb24bf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a73a1ab9b7b8c0807e88b9b969acb24bf">&#9670;&#160;</a></span>Read() <span class="overload">[7/7]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void StreamIn::Read </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_vec3.html">Vec3</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>outVec</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a <a class="el" href="class_vec3.html">Vec3</a> (don't read W) </p>

</div>
</div>
<a id="a85303621b160dd9280ca9b7ff67d8217" name="a85303621b160dd9280ca9b7ff67d8217"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85303621b160dd9280ca9b7ff67d8217">&#9670;&#160;</a></span>ReadBytes()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void StreamIn::ReadBytes </td>
          <td>(</td>
          <td class="paramtype">void *</td>          <td class="paramname"><span class="paramname"><em>outData</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t</td>          <td class="paramname"><span class="paramname"><em>inNumBytes</em></span>&#160;)</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Read a string of bytes from the binary stream. </p>

<p>Implemented in <a class="el" href="class_state_recorder_impl.html#a0fe47b7eaf3a83449182ee8460fd99a1">StateRecorderImpl</a>, and <a class="el" href="class_stream_in_wrapper.html#aa4c627cf650ea91887ae92d43d46dada">StreamInWrapper</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Core/<a class="el" href="_stream_in_8h_source.html">StreamIn.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_stream_in.html">StreamIn</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>