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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
							<!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: CollideSettingsBase 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_collide_settings_base.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_collide_settings_base-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">CollideSettingsBase Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Settings to be passed with a collision query.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_collide_shape_8h_source.html">CollideShape.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CollideSettingsBase:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_collide_settings_base.png" usemap="#CollideSettingsBase_map" alt=""/>
  <map id="CollideSettingsBase_map" name="CollideSettingsBase_map">
<area href="class_collide_shape_settings.html" title="Settings to be passed with a collision query." alt="CollideShapeSettings" shape="rect" coords="0,56,131,80"/>
<area href="class_shape_cast_settings.html" title="Settings to be passed with a shape cast." alt="ShapeCastSettings" shape="rect" coords="141,56,272,80"/>
  </map>
</div></div>
<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:a15b85d50667172c651f917096a99a54e" id="r_a15b85d50667172c651f917096a99a54e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> <a class="el" href="_active_edge_mode_8h.html#a4405632c58efc7502bf1295038080183">EActiveEdgeMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a15b85d50667172c651f917096a99a54e">mActiveEdgeMode</a> = <a class="el" href="_active_edge_mode_8h.html#a4405632c58efc7502bf1295038080183a505c6aab0af57196fa3df673d7325917">EActiveEdgeMode::CollideOnlyWithActive</a></td></tr>
<tr class="memdesc:a15b85d50667172c651f917096a99a54e"><td class="mdescLeft">&#160;</td><td class="mdescRight">How active edges (edges that a moving object should bump into) are handled.  <br /></td></tr>
<tr class="separator:a15b85d50667172c651f917096a99a54e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0c9c32e2267f57dcc73952e3469512bd" id="r_a0c9c32e2267f57dcc73952e3469512bd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_collect_faces_mode_8h.html#a43f9b52c7b53fe169fd83842e75935b6">ECollectFacesMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c9c32e2267f57dcc73952e3469512bd">mCollectFacesMode</a> = <a class="el" href="_collect_faces_mode_8h.html#a43f9b52c7b53fe169fd83842e75935b6af92940cc2936d4efee54451acd04e6b8">ECollectFacesMode::NoFaces</a></td></tr>
<tr class="memdesc:a0c9c32e2267f57dcc73952e3469512bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">If colliding faces should be collected or only the collision point.  <br /></td></tr>
<tr class="separator:a0c9c32e2267f57dcc73952e3469512bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b92708903a65cb2bcc412a49b080736" id="r_a0b92708903a65cb2bcc412a49b080736"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0b92708903a65cb2bcc412a49b080736">mCollisionTolerance</a> = <a class="el" href="_physics_settings_8h.html#a4199156431c225865fda0e5e6bc593fd">cDefaultCollisionTolerance</a></td></tr>
<tr class="memdesc:a0b92708903a65cb2bcc412a49b080736"><td class="mdescLeft">&#160;</td><td class="mdescRight">If objects are closer than this distance, they are considered to be colliding (used for GJK) (unit: meter)  <br /></td></tr>
<tr class="separator:a0b92708903a65cb2bcc412a49b080736"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a153906919e1de4a797964973d0164f44" id="r_a153906919e1de4a797964973d0164f44"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a153906919e1de4a797964973d0164f44">mPenetrationTolerance</a> = <a class="el" href="_physics_settings_8h.html#adeaa0f0b4cc2e2de1021f3669d5d83d9">cDefaultPenetrationTolerance</a></td></tr>
<tr class="memdesc:a153906919e1de4a797964973d0164f44"><td class="mdescLeft">&#160;</td><td class="mdescRight">A factor that determines the accuracy of the penetration depth calculation. If the change of the squared distance is less than tolerance * current_penetration_depth^2 the algorithm will terminate. (unit: dimensionless)  <br /></td></tr>
<tr class="separator:a153906919e1de4a797964973d0164f44"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aede854538605c943e5076753ac2ff9e2" id="r_aede854538605c943e5076753ac2ff9e2"><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="#aede854538605c943e5076753ac2ff9e2">mActiveEdgeMovementDirection</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td></tr>
<tr class="memdesc:aede854538605c943e5076753ac2ff9e2"><td class="mdescLeft">&#160;</td><td class="mdescRight">When mActiveEdgeMode is CollideOnlyWithActive a movement direction can be provided. When hitting an inactive edge, the system will select the triangle normal as penetration depth only if it impedes the movement less than with the calculated penetration depth.  <br /></td></tr>
<tr class="separator:aede854538605c943e5076753ac2ff9e2"><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>Settings to be passed with a collision query. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a15b85d50667172c651f917096a99a54e" name="a15b85d50667172c651f917096a99a54e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15b85d50667172c651f917096a99a54e">&#9670;&#160;</a></span>mActiveEdgeMode</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> <a class="el" href="_active_edge_mode_8h.html#a4405632c58efc7502bf1295038080183">EActiveEdgeMode</a> CollideSettingsBase::mActiveEdgeMode = <a class="el" href="_active_edge_mode_8h.html#a4405632c58efc7502bf1295038080183a505c6aab0af57196fa3df673d7325917">EActiveEdgeMode::CollideOnlyWithActive</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>How active edges (edges that a moving object should bump into) are handled. </p>

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

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

<p>When mActiveEdgeMode is CollideOnlyWithActive a movement direction can be provided. When hitting an inactive edge, the system will select the triangle normal as penetration depth only if it impedes the movement less than with the calculated penetration depth. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_collect_faces_mode_8h.html#a43f9b52c7b53fe169fd83842e75935b6">ECollectFacesMode</a> CollideSettingsBase::mCollectFacesMode = <a class="el" href="_collect_faces_mode_8h.html#a43f9b52c7b53fe169fd83842e75935b6af92940cc2936d4efee54451acd04e6b8">ECollectFacesMode::NoFaces</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If colliding faces should be collected or only the collision point. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float CollideSettingsBase::mCollisionTolerance = <a class="el" href="_physics_settings_8h.html#a4199156431c225865fda0e5e6bc593fd">cDefaultCollisionTolerance</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If objects are closer than this distance, they are considered to be colliding (used for GJK) (unit: meter) </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float CollideSettingsBase::mPenetrationTolerance = <a class="el" href="_physics_settings_8h.html#adeaa0f0b4cc2e2de1021f3669d5d83d9">cDefaultPenetrationTolerance</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>A factor that determines the accuracy of the penetration depth calculation. If the change of the squared distance is less than tolerance * current_penetration_depth^2 the algorithm will terminate. (unit: dimensionless) </p>

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