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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307
							<!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: ContactSettings 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_contact_settings.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-attribs">Public Attributes</a> &#124;
<a href="class_contact_settings-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ContactSettings Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="_contact_listener_8h_source.html">ContactListener.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7a6722d38f6dd9f504412e3663400a2d" id="r_a7a6722d38f6dd9f504412e3663400a2d"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7a6722d38f6dd9f504412e3663400a2d">mCombinedFriction</a></td></tr>
<tr class="memdesc:a7a6722d38f6dd9f504412e3663400a2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combined friction for the body pair (see: <a class="el" href="class_physics_system.html#ae1cc3e726b7e186f642c7da5f6c6a2c2">PhysicsSystem::SetCombineFriction</a>)  <br /></td></tr>
<tr class="separator:a7a6722d38f6dd9f504412e3663400a2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade2482177e9dd9c8596a4a1cc6338979" id="r_ade2482177e9dd9c8596a4a1cc6338979"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ade2482177e9dd9c8596a4a1cc6338979">mCombinedRestitution</a></td></tr>
<tr class="memdesc:ade2482177e9dd9c8596a4a1cc6338979"><td class="mdescLeft">&#160;</td><td class="mdescRight">Combined restitution for the body pair (see: <a class="el" href="class_physics_system.html#a1bf5312ff70cb942e4899eb0766d5ebe">PhysicsSystem::SetCombineRestitution</a>)  <br /></td></tr>
<tr class="separator:ade2482177e9dd9c8596a4a1cc6338979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b2c4b599362d4e3837120571af2c3ce" id="r_a6b2c4b599362d4e3837120571af2c3ce"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6b2c4b599362d4e3837120571af2c3ce">mInvMassScale1</a> = 1.0f</td></tr>
<tr class="memdesc:a6b2c4b599362d4e3837120571af2c3ce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scale factor for the inverse mass of body 1 (0 = infinite mass, 1 = use original mass, 2 = body has half the mass). For the same contact pair, you should strive to keep the value the same over time.  <br /></td></tr>
<tr class="separator:a6b2c4b599362d4e3837120571af2c3ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf521121674ff2c72b762c87bfabed11" id="r_aaf521121674ff2c72b762c87bfabed11"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaf521121674ff2c72b762c87bfabed11">mInvInertiaScale1</a> = 1.0f</td></tr>
<tr class="memdesc:aaf521121674ff2c72b762c87bfabed11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scale factor for the inverse inertia of body 1 (usually same as mInvMassScale1)  <br /></td></tr>
<tr class="separator:aaf521121674ff2c72b762c87bfabed11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37639a208ebcf5ca37462c3689c73828" id="r_a37639a208ebcf5ca37462c3689c73828"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a37639a208ebcf5ca37462c3689c73828">mInvMassScale2</a> = 1.0f</td></tr>
<tr class="memdesc:a37639a208ebcf5ca37462c3689c73828"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scale factor for the inverse mass of body 2 (0 = infinite mass, 1 = use original mass, 2 = body has half the mass). For the same contact pair, you should strive to keep the value the same over time.  <br /></td></tr>
<tr class="separator:a37639a208ebcf5ca37462c3689c73828"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a699874a8c427e9861a83b993c55b1ee8" id="r_a699874a8c427e9861a83b993c55b1ee8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a699874a8c427e9861a83b993c55b1ee8">mInvInertiaScale2</a> = 1.0f</td></tr>
<tr class="memdesc:a699874a8c427e9861a83b993c55b1ee8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Scale factor for the inverse inertia of body 2 (usually same as mInvMassScale2)  <br /></td></tr>
<tr class="separator:a699874a8c427e9861a83b993c55b1ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c5f448521399a40a9384dcc1aa1474f" id="r_a1c5f448521399a40a9384dcc1aa1474f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1c5f448521399a40a9384dcc1aa1474f">mIsSensor</a></td></tr>
<tr class="memdesc:a1c5f448521399a40a9384dcc1aa1474f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the contact should be treated as a sensor vs body contact (no collision response)  <br /></td></tr>
<tr class="separator:a1c5f448521399a40a9384dcc1aa1474f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42f0680fb14771132aab269491c217ff" id="r_a42f0680fb14771132aab269491c217ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a42f0680fb14771132aab269491c217ff">mRelativeLinearSurfaceVelocity</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td></tr>
<tr class="memdesc:a42f0680fb14771132aab269491c217ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relative linear surface velocity between the bodies (world space surface velocity of body 2 - world space surface velocity of body 1), can be used to create a conveyor belt effect.  <br /></td></tr>
<tr class="separator:a42f0680fb14771132aab269491c217ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f18a7a0fa71d91b1bd75481ea549de9" id="r_a5f18a7a0fa71d91b1bd75481ea549de9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5f18a7a0fa71d91b1bd75481ea549de9">mRelativeAngularSurfaceVelocity</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td></tr>
<tr class="memdesc:a5f18a7a0fa71d91b1bd75481ea549de9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Relative angular surface velocity between the bodies (world space angular surface velocity of body 2 - world space angular surface velocity of body 1). Note that this angular velocity is relative to the center of mass of body 1, so if you want it relative to body 2's center of mass you need to add body 2 angular velocity x (body 1 world space center of mass - body 2 world space center of mass) to mRelativeLinearSurfaceVelocity.  <br /></td></tr>
<tr class="separator:a5f18a7a0fa71d91b1bd75481ea549de9"><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>When a contact point is added or persisted, the callback gets a chance to override certain properties of the contact constraint. The values are filled in with their defaults by the system so the callback doesn't need to modify anything, but it can if it wants to. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a7a6722d38f6dd9f504412e3663400a2d" name="a7a6722d38f6dd9f504412e3663400a2d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a6722d38f6dd9f504412e3663400a2d">&#9670;&#160;</a></span>mCombinedFriction</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ContactSettings::mCombinedFriction</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Combined friction for the body pair (see: <a class="el" href="class_physics_system.html#ae1cc3e726b7e186f642c7da5f6c6a2c2">PhysicsSystem::SetCombineFriction</a>) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ContactSettings::mCombinedRestitution</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Combined restitution for the body pair (see: <a class="el" href="class_physics_system.html#a1bf5312ff70cb942e4899eb0766d5ebe">PhysicsSystem::SetCombineRestitution</a>) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ContactSettings::mInvInertiaScale1 = 1.0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Scale factor for the inverse inertia of body 1 (usually same as mInvMassScale1) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ContactSettings::mInvInertiaScale2 = 1.0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Scale factor for the inverse inertia of body 2 (usually same as mInvMassScale2) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ContactSettings::mInvMassScale1 = 1.0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Scale factor for the inverse mass of body 1 (0 = infinite mass, 1 = use original mass, 2 = body has half the mass). For the same contact pair, you should strive to keep the value the same over time. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float ContactSettings::mInvMassScale2 = 1.0f</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Scale factor for the inverse mass of body 2 (0 = infinite mass, 1 = use original mass, 2 = body has half the mass). For the same contact pair, you should strive to keep the value the same over time. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ContactSettings::mIsSensor</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If the contact should be treated as a sensor vs body contact (no collision response) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> ContactSettings::mRelativeAngularSurfaceVelocity = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Relative angular surface velocity between the bodies (world space angular surface velocity of body 2 - world space angular surface velocity of body 1). Note that this angular velocity is relative to the center of mass of body 1, so if you want it relative to body 2's center of mass you need to add body 2 angular velocity x (body 1 world space center of mass - body 2 world space center of mass) to mRelativeLinearSurfaceVelocity. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> ContactSettings::mRelativeLinearSurfaceVelocity = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Relative linear surface velocity between the bodies (world space surface velocity of body 2 - world space surface velocity of body 1), can be used to create a conveyor belt effect. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>Jolt/Physics/Collision/<a class="el" href="_contact_listener_8h_source.html">ContactListener.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_contact_settings.html">ContactSettings</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>