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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186
							<!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: Jolt/Core/StreamWrapper.h Source File</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('_stream_wrapper_8h_source.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="headertitle"><div class="title">StreamWrapper.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_stream_wrapper_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">// SPDX-FileCopyrightText: 2021 Jorrit Rouwe</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="preprocessor">#include &lt;<a class="code" href="_stream_in_8h.html">Jolt/Core/StreamIn.h</a>&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="preprocessor">#include &lt;<a class="code" href="_stream_out_8h.html">Jolt/Core/StreamOut.h</a>&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><a class="code hl_define" href="_core_8h.html#a4ac413403e9ca00d24a3e2f244cf5456">JPH_SUPPRESS_WARNINGS_STD_BEGIN</a></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="preprocessor">#include &lt;ostream&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><a class="code hl_define" href="_core_8h.html#a5f6b64537a538d9204b253532b799467">JPH_SUPPRESS_WARNINGS_STD_END</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="class_stream_out_wrapper.html">   17</a></span><span class="keyword">class </span><a class="code hl_class" href="class_stream_out_wrapper.html">StreamOutWrapper</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_stream_out.html">StreamOut</a></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>{</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_stream_out_wrapper.html#a31c8f3fb2fae07e695d9d7ab7bad604d">   21</a></span>                        <a class="code hl_function" href="class_stream_out_wrapper.html#a31c8f3fb2fae07e695d9d7ab7bad604d">StreamOutWrapper</a>(ostream &amp;ioWrapped)                        : mWrapped(ioWrapped) { }</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="class_stream_out_wrapper.html#a9021148d55d478d1431b9196e96c8125">   24</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>        <a class="code hl_function" href="class_stream_out_wrapper.html#a9021148d55d478d1431b9196e96c8125">WriteBytes</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *inData, <span class="keywordtype">size_t</span> inNumBytes)<span class="keyword"> override  </span>{ mWrapped.write((<span class="keyword">const</span> <span class="keywordtype">char</span> *)inData, inNumBytes); }</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="class_stream_out_wrapper.html#a2da7c93d54165f7cbab4678fe83abb32">   27</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">bool</span>        <a class="code hl_function" href="class_stream_out_wrapper.html#a2da7c93d54165f7cbab4678fe83abb32">IsFailed</a>()<span class="keyword"> const override                                   </span>{ <span class="keywordflow">return</span> mWrapped.fail(); }</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>    ostream &amp;           mWrapped;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>};</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span> </div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="};">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="class_stream_in_wrapper.html">   34</a></span><span class="keyword">class </span><a class="code hl_class" href="class_stream_in_wrapper.html">StreamInWrapper</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_stream_in.html">StreamIn</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>{</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="class_stream_in_wrapper.html#a520dc1917ebc617092afe68cbaa4ed6b">   38</a></span>                        <a class="code hl_function" href="class_stream_in_wrapper.html#a520dc1917ebc617092afe68cbaa4ed6b">StreamInWrapper</a>(istream &amp;ioWrapped)                         : mWrapped(ioWrapped) { }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="class_stream_in_wrapper.html#aa4c627cf650ea91887ae92d43d46dada">   41</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>        <a class="code hl_function" href="class_stream_in_wrapper.html#aa4c627cf650ea91887ae92d43d46dada">ReadBytes</a>(<span class="keywordtype">void</span> *outData, <span class="keywordtype">size_t</span> inNumBytes)<span class="keyword"> override        </span>{ mWrapped.read((<span class="keywordtype">char</span> *)outData, inNumBytes); }</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="class_stream_in_wrapper.html#ae426f7046722abc95d5e1a9205d535da">   44</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">bool</span>        <a class="code hl_function" href="class_stream_in_wrapper.html#ae426f7046722abc95d5e1a9205d535da">IsEOF</a>()<span class="keyword"> const override                                      </span>{ <span class="keywordflow">return</span> mWrapped.eof(); }</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="class_stream_in_wrapper.html#a239494d64eb786bb0d4b0fb55cc621e0">   47</a></span>    <span class="keyword">virtual</span> <span class="keywordtype">bool</span>        <a class="code hl_function" href="class_stream_in_wrapper.html#a239494d64eb786bb0d4b0fb55cc621e0">IsFailed</a>()<span class="keyword"> const override                                   </span>{ <span class="keywordflow">return</span> mWrapped.fail(); }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>    istream &amp;           mWrapped;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span>};</div>
</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
<div class="ttc" id="a_core_8h_html_a4ac413403e9ca00d24a3e2f244cf5456"><div class="ttname"><a href="_core_8h.html#a4ac413403e9ca00d24a3e2f244cf5456">JPH_SUPPRESS_WARNINGS_STD_BEGIN</a></div><div class="ttdeci">#define JPH_SUPPRESS_WARNINGS_STD_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:430</div></div>
<div class="ttc" id="a_core_8h_html_a5f6b64537a538d9204b253532b799467"><div class="ttname"><a href="_core_8h.html#a5f6b64537a538d9204b253532b799467">JPH_SUPPRESS_WARNINGS_STD_END</a></div><div class="ttdeci">#define JPH_SUPPRESS_WARNINGS_STD_END</div><div class="ttdef"><b>Definition</b> Core.h:443</div></div>
<div class="ttc" id="a_core_8h_html_a73da8725998b00321a9db341202d650d"><div class="ttname"><a href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div><div class="ttdeci">#define JPH_NAMESPACE_END</div><div class="ttdef"><b>Definition</b> Core.h:425</div></div>
<div class="ttc" id="a_core_8h_html_ad14098b68b8c44ea6112601031268405"><div class="ttname"><a href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define JPH_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:419</div></div>
<div class="ttc" id="a_stream_in_8h_html"><div class="ttname"><a href="_stream_in_8h.html">StreamIn.h</a></div></div>
<div class="ttc" id="a_stream_out_8h_html"><div class="ttname"><a href="_stream_out_8h.html">StreamOut.h</a></div></div>
<div class="ttc" id="aclass_stream_in_html"><div class="ttname"><a href="class_stream_in.html">StreamIn</a></div><div class="ttdoc">Simple binary input stream.</div><div class="ttdef"><b>Definition</b> StreamIn.h:13</div></div>
<div class="ttc" id="aclass_stream_in_wrapper_html"><div class="ttname"><a href="class_stream_in_wrapper.html">StreamInWrapper</a></div><div class="ttdoc">Wrapper around std::istream.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:35</div></div>
<div class="ttc" id="aclass_stream_in_wrapper_html_a239494d64eb786bb0d4b0fb55cc621e0"><div class="ttname"><a href="class_stream_in_wrapper.html#a239494d64eb786bb0d4b0fb55cc621e0">StreamInWrapper::IsFailed</a></div><div class="ttdeci">virtual bool IsFailed() const override</div><div class="ttdoc">Returns true if there was an IO failure.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:47</div></div>
<div class="ttc" id="aclass_stream_in_wrapper_html_a520dc1917ebc617092afe68cbaa4ed6b"><div class="ttname"><a href="class_stream_in_wrapper.html#a520dc1917ebc617092afe68cbaa4ed6b">StreamInWrapper::StreamInWrapper</a></div><div class="ttdeci">StreamInWrapper(istream &amp;ioWrapped)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:38</div></div>
<div class="ttc" id="aclass_stream_in_wrapper_html_aa4c627cf650ea91887ae92d43d46dada"><div class="ttname"><a href="class_stream_in_wrapper.html#aa4c627cf650ea91887ae92d43d46dada">StreamInWrapper::ReadBytes</a></div><div class="ttdeci">virtual void ReadBytes(void *outData, size_t inNumBytes) override</div><div class="ttdoc">Write a string of bytes to the binary stream.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:41</div></div>
<div class="ttc" id="aclass_stream_in_wrapper_html_ae426f7046722abc95d5e1a9205d535da"><div class="ttname"><a href="class_stream_in_wrapper.html#ae426f7046722abc95d5e1a9205d535da">StreamInWrapper::IsEOF</a></div><div class="ttdeci">virtual bool IsEOF() const override</div><div class="ttdoc">Returns true when an attempt has been made to read past the end of the file.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:44</div></div>
<div class="ttc" id="aclass_stream_out_html"><div class="ttname"><a href="class_stream_out.html">StreamOut</a></div><div class="ttdoc">Simple binary output stream.</div><div class="ttdef"><b>Definition</b> StreamOut.h:13</div></div>
<div class="ttc" id="aclass_stream_out_wrapper_html"><div class="ttname"><a href="class_stream_out_wrapper.html">StreamOutWrapper</a></div><div class="ttdoc">Wrapper around std::ostream.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:18</div></div>
<div class="ttc" id="aclass_stream_out_wrapper_html_a2da7c93d54165f7cbab4678fe83abb32"><div class="ttname"><a href="class_stream_out_wrapper.html#a2da7c93d54165f7cbab4678fe83abb32">StreamOutWrapper::IsFailed</a></div><div class="ttdeci">virtual bool IsFailed() const override</div><div class="ttdoc">Returns true if there was an IO failure.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:27</div></div>
<div class="ttc" id="aclass_stream_out_wrapper_html_a31c8f3fb2fae07e695d9d7ab7bad604d"><div class="ttname"><a href="class_stream_out_wrapper.html#a31c8f3fb2fae07e695d9d7ab7bad604d">StreamOutWrapper::StreamOutWrapper</a></div><div class="ttdeci">StreamOutWrapper(ostream &amp;ioWrapped)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:21</div></div>
<div class="ttc" id="aclass_stream_out_wrapper_html_a9021148d55d478d1431b9196e96c8125"><div class="ttname"><a href="class_stream_out_wrapper.html#a9021148d55d478d1431b9196e96c8125">StreamOutWrapper::WriteBytes</a></div><div class="ttdeci">virtual void WriteBytes(const void *inData, size_t inNumBytes) override</div><div class="ttdoc">Write a string of bytes to the binary stream.</div><div class="ttdef"><b>Definition</b> StreamWrapper.h:24</div></div>
</div><!-- fragment --></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="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_wrapper_8h.html">StreamWrapper.h</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>