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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176
							<!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/Physics/Collision/PhysicsMaterialSimple.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('_physics_material_simple_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">PhysicsMaterialSimple.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_physics_material_simple_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="_physics_material_8h.html">Jolt/Physics/Collision/PhysicsMaterial.h</a>&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span> </div>
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_physics_material_simple.html">   12</a></span><span class="keyword">class </span><a class="code hl_define" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a> <a class="code hl_class" href="class_physics_material_simple.html">PhysicsMaterialSimple</a> : <span class="keyword">public</span> <a class="code hl_class" href="class_physics_material.html">PhysicsMaterial</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="_serializable_object_8h.html#ad80cbee2b256f570ee204534dec05da4">JPH_DECLARE_SERIALIZABLE_VIRTUAL</a>(<a class="code hl_define" href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a>, <a class="code hl_class" href="class_physics_material_simple.html">PhysicsMaterialSimple</a>)</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="class_physics_material_simple.html#afd4cf9d7b19fb00dba26cbfb7a8ed80d">   18</a></span>                                            <a class="code hl_function" href="class_physics_material_simple.html#afd4cf9d7b19fb00dba26cbfb7a8ed80d">PhysicsMaterialSimple</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_physics_material_simple.html#a3760b4ee0fd7ab82f3767709de168b73">   19</a></span>                                            <a class="code hl_function" href="class_physics_material_simple.html#a3760b4ee0fd7ab82f3767709de168b73">PhysicsMaterialSimple</a>(<span class="keyword">const</span> string_view &amp;inName, <a class="code hl_class" href="class_color.html">ColorArg</a> inColor) : mDebugName(inName), mDebugColor(inColor) { }</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>    <span class="comment">// Properties</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="class_physics_material_simple.html#ae6e3111c1feb14e0494a168ed783c43e">   22</a></span>    <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *                    <a class="code hl_function" href="class_physics_material_simple.html#ae6e3111c1feb14e0494a168ed783c43e">GetDebugName</a>()<span class="keyword"> const override       </span>{ <span class="keywordflow">return</span> mDebugName.c_str(); }</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_physics_material_simple.html#a753a983d027c83d1758d8f89e79d3c7e">   23</a></span>    <span class="keyword">virtual</span> <a class="code hl_class" href="class_color.html">Color</a>                           <a class="code hl_function" href="class_physics_material_simple.html#a753a983d027c83d1758d8f89e79d3c7e">GetDebugColor</a>()<span class="keyword"> const override      </span>{ <span class="keywordflow">return</span> mDebugColor; }</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>    <span class="comment">// See: PhysicsMaterial::SaveBinaryState</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>                            <a class="code hl_function" href="class_physics_material.html#a7e57e5082b30e978c7ddd6a8e77c983e">SaveBinaryState</a>(<a class="code hl_class" href="class_stream_out.html">StreamOut</a> &amp;inStream) <span class="keyword">const override</span>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>    <span class="comment">// See: PhysicsMaterial::RestoreBinaryState</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span>                            <a class="code hl_function" href="class_physics_material.html#a51ea4ae0673771947b5052c9062cf267">RestoreBinaryState</a>(<a class="code hl_class" href="class_stream_in.html">StreamIn</a> &amp;inStream) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    <a class="code hl_typedef" href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a>                                  mDebugName;                         </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    <a class="code hl_class" href="class_color.html">Color</a>                                   mDebugColor = <a class="code hl_variable" href="class_color.html#adbb787dece4b7f18b70590bdff300a4b">Color::sGrey</a>;         </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>};</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
<div class="ttc" id="a_core_8h_html_a2712a9b0f778ab9d1aa5118b4e8e6bd8"><div class="ttname"><a href="_core_8h.html#a2712a9b0f778ab9d1aa5118b4e8e6bd8">JPH_EXPORT</a></div><div class="ttdeci">#define JPH_EXPORT</div><div class="ttdef"><b>Definition</b> Core.h:275</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_physics_material_8h_html"><div class="ttname"><a href="_physics_material_8h.html">PhysicsMaterial.h</a></div></div>
<div class="ttc" id="a_s_t_l_allocator_8h_html_acfd9326153e4ff90e162d6e7d3e37c86"><div class="ttname"><a href="_s_t_l_allocator_8h.html#acfd9326153e4ff90e162d6e7d3e37c86">String</a></div><div class="ttdeci">std::basic_string&lt; char, std::char_traits&lt; char &gt;, STLAllocator&lt; char &gt; &gt; String</div><div class="ttdef"><b>Definition</b> STLAllocator.h:107</div></div>
<div class="ttc" id="a_serializable_object_8h_html_ad80cbee2b256f570ee204534dec05da4"><div class="ttname"><a href="_serializable_object_8h.html#ad80cbee2b256f570ee204534dec05da4">JPH_DECLARE_SERIALIZABLE_VIRTUAL</a></div><div class="ttdeci">#define JPH_DECLARE_SERIALIZABLE_VIRTUAL(linkage, class_name)</div><div class="ttdef"><b>Definition</b> SerializableObject.h:109</div></div>
<div class="ttc" id="aclass_color_html"><div class="ttname"><a href="class_color.html">Color</a></div><div class="ttdoc">Class that holds an RGBA color with 8-bits per component.</div><div class="ttdef"><b>Definition</b> Color.h:16</div></div>
<div class="ttc" id="aclass_color_html_adbb787dece4b7f18b70590bdff300a4b"><div class="ttname"><a href="class_color.html#adbb787dece4b7f18b70590bdff300a4b">Color::sGrey</a></div><div class="ttdeci">static const Color sGrey</div><div class="ttdef"><b>Definition</b> Color.h:79</div></div>
<div class="ttc" id="aclass_physics_material_html"><div class="ttname"><a href="class_physics_material.html">PhysicsMaterial</a></div><div class="ttdef"><b>Definition</b> PhysicsMaterial.h:23</div></div>
<div class="ttc" id="aclass_physics_material_html_a51ea4ae0673771947b5052c9062cf267"><div class="ttname"><a href="class_physics_material.html#a51ea4ae0673771947b5052c9062cf267">PhysicsMaterial::RestoreBinaryState</a></div><div class="ttdeci">virtual void RestoreBinaryState(StreamIn &amp;inStream)</div><div class="ttdoc">This function should not be called directly, it is used by sRestoreFromBinaryState.</div><div class="ttdef"><b>Definition</b> PhysicsMaterial.cpp:25</div></div>
<div class="ttc" id="aclass_physics_material_html_a7e57e5082b30e978c7ddd6a8e77c983e"><div class="ttname"><a href="class_physics_material.html#a7e57e5082b30e978c7ddd6a8e77c983e">PhysicsMaterial::SaveBinaryState</a></div><div class="ttdeci">virtual void SaveBinaryState(StreamOut &amp;inStream) const</div><div class="ttdoc">Saves the contents of the material in binary form to inStream.</div><div class="ttdef"><b>Definition</b> PhysicsMaterial.cpp:20</div></div>
<div class="ttc" id="aclass_physics_material_simple_html"><div class="ttname"><a href="class_physics_material_simple.html">PhysicsMaterialSimple</a></div><div class="ttdoc">Sample implementation of PhysicsMaterial that just holds the needed properties directly.</div><div class="ttdef"><b>Definition</b> PhysicsMaterialSimple.h:13</div></div>
<div class="ttc" id="aclass_physics_material_simple_html_a3760b4ee0fd7ab82f3767709de168b73"><div class="ttname"><a href="class_physics_material_simple.html#a3760b4ee0fd7ab82f3767709de168b73">PhysicsMaterialSimple::PhysicsMaterialSimple</a></div><div class="ttdeci">PhysicsMaterialSimple(const string_view &amp;inName, ColorArg inColor)</div><div class="ttdef"><b>Definition</b> PhysicsMaterialSimple.h:19</div></div>
<div class="ttc" id="aclass_physics_material_simple_html_a753a983d027c83d1758d8f89e79d3c7e"><div class="ttname"><a href="class_physics_material_simple.html#a753a983d027c83d1758d8f89e79d3c7e">PhysicsMaterialSimple::GetDebugColor</a></div><div class="ttdeci">virtual Color GetDebugColor() const override</div><div class="ttdef"><b>Definition</b> PhysicsMaterialSimple.h:23</div></div>
<div class="ttc" id="aclass_physics_material_simple_html_ae6e3111c1feb14e0494a168ed783c43e"><div class="ttname"><a href="class_physics_material_simple.html#ae6e3111c1feb14e0494a168ed783c43e">PhysicsMaterialSimple::GetDebugName</a></div><div class="ttdeci">virtual const char * GetDebugName() const override</div><div class="ttdef"><b>Definition</b> PhysicsMaterialSimple.h:22</div></div>
<div class="ttc" id="aclass_physics_material_simple_html_afd4cf9d7b19fb00dba26cbfb7a8ed80d"><div class="ttname"><a href="class_physics_material_simple.html#afd4cf9d7b19fb00dba26cbfb7a8ed80d">PhysicsMaterialSimple::PhysicsMaterialSimple</a></div><div class="ttdeci">PhysicsMaterialSimple()=default</div><div class="ttdoc">Constructor.</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_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><!-- 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_a0f33af92addde396fc27b064c5eb8a9.html">Physics</a></li><li class="navelem"><a class="el" href="dir_1a1d05ab9ff27ca8d1ed94cd62670cdf.html">Collision</a></li><li class="navelem"><a class="el" href="_physics_material_simple_8h.html">PhysicsMaterialSimple.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>