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


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

<p><a class="el" href="class_result.html" title="Helper class that either contains a valid result or an error.">Result</a> of a shape cast test.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_shape_cast_8h_source.html">ShapeCast.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ShapeCastResult:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_shape_cast_result.png" usemap="#ShapeCastResult_map" alt=""/>
  <map id="ShapeCastResult_map" name="ShapeCastResult_map">
<area href="class_collide_shape_result.html" title="Class that contains all information of two colliding shapes." alt="CollideShapeResult" shape="rect" coords="0,0,121,24"/>
  </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:a79089f4b310168c5bfa51cc0bcf134dd" id="r_a79089f4b310168c5bfa51cc0bcf134dd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a79089f4b310168c5bfa51cc0bcf134dd">ShapeCastResult</a> ()=default</td></tr>
<tr class="memdesc:a79089f4b310168c5bfa51cc0bcf134dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <br /></td></tr>
<tr class="separator:a79089f4b310168c5bfa51cc0bcf134dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb01699f4368bbbeec678f0c3c21108d" id="r_afb01699f4368bbbeec678f0c3c21108d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afb01699f4368bbbeec678f0c3c21108d">ShapeCastResult</a> (float inFraction, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inContactPoint1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inContactPoint2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inContactNormalOrPenetrationDepth, bool inBackFaceHit, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeID1, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeID2, const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID2)</td></tr>
<tr class="separator:afb01699f4368bbbeec678f0c3c21108d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b91d796ee4e127cac91c9d82f292e57" id="r_a0b91d796ee4e127cac91c9d82f292e57"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0b91d796ee4e127cac91c9d82f292e57">GetEarlyOutFraction</a> () const</td></tr>
<tr class="memdesc:a0b91d796ee4e127cac91c9d82f292e57"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function required by the <a class="el" href="class_collision_collector.html" title="Virtual interface that allows collecting multiple collision results.">CollisionCollector</a>. A smaller fraction is considered to be a 'better hit'. For rays/cast shapes we can just use the collision fraction. The fraction and penetration depth are combined in such a way that deeper hits at fraction 0 go first.  <br /></td></tr>
<tr class="separator:a0b91d796ee4e127cac91c9d82f292e57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab16c921cd28c80c7acbf8005b778965f" id="r_ab16c921cd28c80c7acbf8005b778965f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_shape_cast_result.html">ShapeCastResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab16c921cd28c80c7acbf8005b778965f">Reversed</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inWorldSpaceCastDirection) const</td></tr>
<tr class="separator:ab16c921cd28c80c7acbf8005b778965f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_collide_shape_result"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_collide_shape_result')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_collide_shape_result.html">CollideShapeResult</a></td></tr>
<tr class="memitem:a7fe57d79718e199535fa4d9601e646ff inherit pub_methods_class_collide_shape_result" id="r_a7fe57d79718e199535fa4d9601e646ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#a7fe57d79718e199535fa4d9601e646ff">CollideShapeResult</a> ()=default</td></tr>
<tr class="memdesc:a7fe57d79718e199535fa4d9601e646ff inherit pub_methods_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor.  <br /></td></tr>
<tr class="separator:a7fe57d79718e199535fa4d9601e646ff inherit pub_methods_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89e76885c988cdc177f121c6bb18801d inherit pub_methods_class_collide_shape_result" id="r_a89e76885c988cdc177f121c6bb18801d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#a89e76885c988cdc177f121c6bb18801d">CollideShapeResult</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inContactPointOn1, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inContactPointOn2, <a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inPenetrationAxis, float inPenetrationDepth, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeID1, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeID2, const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyID2)</td></tr>
<tr class="memdesc:a89e76885c988cdc177f121c6bb18801d inherit pub_methods_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <br /></td></tr>
<tr class="separator:a89e76885c988cdc177f121c6bb18801d inherit pub_methods_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe452fa6ddc8670a0c020d5420a92f3b inherit pub_methods_class_collide_shape_result" id="r_abe452fa6ddc8670a0c020d5420a92f3b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#abe452fa6ddc8670a0c020d5420a92f3b">GetEarlyOutFraction</a> () const</td></tr>
<tr class="memdesc:abe452fa6ddc8670a0c020d5420a92f3b inherit pub_methods_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function required by the <a class="el" href="class_collision_collector.html" title="Virtual interface that allows collecting multiple collision results.">CollisionCollector</a>. A smaller fraction is considered to be a 'better hit'. We use -penetration depth to get the hit with the biggest penetration depth.  <br /></td></tr>
<tr class="separator:abe452fa6ddc8670a0c020d5420a92f3b inherit pub_methods_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84eb31fb18eea1a96cadad32a3f6fe4e inherit pub_methods_class_collide_shape_result" id="r_a84eb31fb18eea1a96cadad32a3f6fe4e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_collide_shape_result.html">CollideShapeResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#a84eb31fb18eea1a96cadad32a3f6fe4e">Reversed</a> () const</td></tr>
<tr class="memdesc:a84eb31fb18eea1a96cadad32a3f6fe4e inherit pub_methods_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverses the hit result, swapping contact point 1 with contact point 2 etc.  <br /></td></tr>
<tr class="separator:a84eb31fb18eea1a96cadad32a3f6fe4e inherit pub_methods_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a8c1f5167202e5071cca22085350b0471" id="r_a8c1f5167202e5071cca22085350b0471"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8c1f5167202e5071cca22085350b0471">mFraction</a></td></tr>
<tr class="memdesc:a8c1f5167202e5071cca22085350b0471"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the fraction where the shape hit the other shape: CenterOfMassOnHit = Start + value * (End - Start)  <br /></td></tr>
<tr class="separator:a8c1f5167202e5071cca22085350b0471"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b87f661ac91360c311fd96684f1d293" id="r_a1b87f661ac91360c311fd96684f1d293"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1b87f661ac91360c311fd96684f1d293">mIsBackFaceHit</a></td></tr>
<tr class="memdesc:a1b87f661ac91360c311fd96684f1d293"><td class="mdescLeft">&#160;</td><td class="mdescRight">True if the shape was hit from the back side.  <br /></td></tr>
<tr class="separator:a1b87f661ac91360c311fd96684f1d293"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_class_collide_shape_result"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_collide_shape_result')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_collide_shape_result.html">CollideShapeResult</a></td></tr>
<tr class="memitem:a76dd6be632967ea1f0348eca8155be44 inherit pub_attribs_class_collide_shape_result" id="r_a76dd6be632967ea1f0348eca8155be44"><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="class_collide_shape_result.html#a76dd6be632967ea1f0348eca8155be44">mContactPointOn1</a></td></tr>
<tr class="memdesc:a76dd6be632967ea1f0348eca8155be44 inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact point on the surface of shape 1 (in world space or relative to base offset)  <br /></td></tr>
<tr class="separator:a76dd6be632967ea1f0348eca8155be44 inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2f09d3bbc9e1563c974836c2327f73a7 inherit pub_attribs_class_collide_shape_result" id="r_a2f09d3bbc9e1563c974836c2327f73a7"><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="class_collide_shape_result.html#a2f09d3bbc9e1563c974836c2327f73a7">mContactPointOn2</a></td></tr>
<tr class="memdesc:a2f09d3bbc9e1563c974836c2327f73a7 inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contact point on the surface of shape 2 (in world space or relative to base offset). If the penetration depth is 0, this will be the same as mContactPointOn1.  <br /></td></tr>
<tr class="separator:a2f09d3bbc9e1563c974836c2327f73a7 inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3704397b8c4c6e39f2bb94bb477a7bc7 inherit pub_attribs_class_collide_shape_result" id="r_a3704397b8c4c6e39f2bb94bb477a7bc7"><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="class_collide_shape_result.html#a3704397b8c4c6e39f2bb94bb477a7bc7">mPenetrationAxis</a></td></tr>
<tr class="memdesc:a3704397b8c4c6e39f2bb94bb477a7bc7 inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Direction to move shape 2 out of collision along the shortest path (magnitude is meaningless, in world space). You can use -mPenetrationAxis.Normalized() as contact normal.  <br /></td></tr>
<tr class="separator:a3704397b8c4c6e39f2bb94bb477a7bc7 inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a940adcfe5fa917a065f5ae65773de013 inherit pub_attribs_class_collide_shape_result" id="r_a940adcfe5fa917a065f5ae65773de013"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#a940adcfe5fa917a065f5ae65773de013">mPenetrationDepth</a></td></tr>
<tr class="memdesc:a940adcfe5fa917a065f5ae65773de013 inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Penetration depth (move shape 2 by this distance to resolve the collision). If <a class="el" href="class_collide_shape_settings.html#a511c99470c2fe3b2e82d06ffe26c52c1">CollideShapeSettings::mMaxSeparationDistance</a> &gt; 0 this number can be negative to indicate that the objects are separated by -mPenetrationDepth. The contact points are the closest points in that case.  <br /></td></tr>
<tr class="separator:a940adcfe5fa917a065f5ae65773de013 inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a62402355f85f878a6444bbcbba31c4 inherit pub_attribs_class_collide_shape_result" id="r_a0a62402355f85f878a6444bbcbba31c4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#a0a62402355f85f878a6444bbcbba31c4">mSubShapeID1</a></td></tr>
<tr class="memdesc:a0a62402355f85f878a6444bbcbba31c4 inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub shape ID that identifies the face on shape 1.  <br /></td></tr>
<tr class="separator:a0a62402355f85f878a6444bbcbba31c4 inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab12cb1e36b125a536229698328e30d9a inherit pub_attribs_class_collide_shape_result" id="r_ab12cb1e36b125a536229698328e30d9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#ab12cb1e36b125a536229698328e30d9a">mSubShapeID2</a></td></tr>
<tr class="memdesc:ab12cb1e36b125a536229698328e30d9a inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub shape ID that identifies the face on shape 2.  <br /></td></tr>
<tr class="separator:ab12cb1e36b125a536229698328e30d9a inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22e33232d0af6889b6715dfaa460ebbb inherit pub_attribs_class_collide_shape_result" id="r_a22e33232d0af6889b6715dfaa460ebbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_body_i_d.html">BodyID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#a22e33232d0af6889b6715dfaa460ebbb">mBodyID2</a></td></tr>
<tr class="memdesc:a22e33232d0af6889b6715dfaa460ebbb inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_body_i_d.html" title="ID of a body. This is a way of reasoning about bodies in a multithreaded simulation while avoiding ra...">BodyID</a> to which shape 2 belongs to.  <br /></td></tr>
<tr class="separator:a22e33232d0af6889b6715dfaa460ebbb inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa79b80c5eca1d8e7bf57771421bc3acc inherit pub_attribs_class_collide_shape_result" id="r_aa79b80c5eca1d8e7bf57771421bc3acc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_collide_shape_result.html#a5cdb68a0447b40ffa2cfd725c1896356">Face</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#aa79b80c5eca1d8e7bf57771421bc3acc">mShape1Face</a></td></tr>
<tr class="memdesc:aa79b80c5eca1d8e7bf57771421bc3acc inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Colliding face on shape 1 (optional result, in world space or relative to base offset)  <br /></td></tr>
<tr class="separator:aa79b80c5eca1d8e7bf57771421bc3acc inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae69726442e6d35051405f8d437003316 inherit pub_attribs_class_collide_shape_result" id="r_ae69726442e6d35051405f8d437003316"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_collide_shape_result.html#a5cdb68a0447b40ffa2cfd725c1896356">Face</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#ae69726442e6d35051405f8d437003316">mShape2Face</a></td></tr>
<tr class="memdesc:ae69726442e6d35051405f8d437003316 inherit pub_attribs_class_collide_shape_result"><td class="mdescLeft">&#160;</td><td class="mdescRight">Colliding face on shape 2 (optional result, in world space or relative to base offset)  <br /></td></tr>
<tr class="separator:ae69726442e6d35051405f8d437003316 inherit pub_attribs_class_collide_shape_result"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_types_class_collide_shape_result"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_collide_shape_result')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_collide_shape_result.html">CollideShapeResult</a></td></tr>
<tr class="memitem:a5cdb68a0447b40ffa2cfd725c1896356 inherit pub_types_class_collide_shape_result" id="r_a5cdb68a0447b40ffa2cfd725c1896356"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_collide_shape_result.html#a5cdb68a0447b40ffa2cfd725c1896356">Face</a> = <a class="el" href="class_static_array.html">StaticArray</a>&lt;<a class="el" href="class_vec3.html">Vec3</a>, 32&gt;</td></tr>
<tr class="separator:a5cdb68a0447b40ffa2cfd725c1896356 inherit pub_types_class_collide_shape_result"><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><a class="el" href="class_result.html" title="Helper class that either contains a valid result or an error.">Result</a> of a shape cast test. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a79089f4b310168c5bfa51cc0bcf134dd" name="a79089f4b310168c5bfa51cc0bcf134dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79089f4b310168c5bfa51cc0bcf134dd">&#9670;&#160;</a></span>ShapeCastResult() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> ShapeCastResult::ShapeCastResult </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">default</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Default constructor. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">ShapeCastResult::ShapeCastResult </td>
          <td>(</td>
          <td class="paramtype">float</td>          <td class="paramname"><span class="paramname"><em>inFraction</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inContactPoint1</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inContactPoint2</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inContactNormalOrPenetrationDepth</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool</td>          <td class="paramname"><span class="paramname"><em>inBackFaceHit</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inSubShapeID1</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inSubShapeID2</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;</td>          <td class="paramname"><span class="paramname"><em>inBodyID2</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>Constructor </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inFraction</td><td>Fraction at which the cast hit </td></tr>
    <tr><td class="paramname">inContactPoint1</td><td>Contact point on shape 1 </td></tr>
    <tr><td class="paramname">inContactPoint2</td><td>Contact point on shape 2 </td></tr>
    <tr><td class="paramname">inContactNormalOrPenetrationDepth</td><td>Contact normal pointing from shape 1 to 2 or penetration depth vector when the objects are penetrating (also from 1 to 2) </td></tr>
    <tr><td class="paramname">inBackFaceHit</td><td>If this hit was a back face hit </td></tr>
    <tr><td class="paramname">inSubShapeID1</td><td>Sub shape id for shape 1 </td></tr>
    <tr><td class="paramname">inSubShapeID2</td><td>Sub shape id for shape 2 </td></tr>
    <tr><td class="paramname">inBodyID2</td><td><a class="el" href="class_body_i_d.html" title="ID of a body. This is a way of reasoning about bodies in a multithreaded simulation while avoiding ra...">BodyID</a> that was hit </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">float ShapeCastResult::GetEarlyOutFraction </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">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Function required by the <a class="el" href="class_collision_collector.html" title="Virtual interface that allows collecting multiple collision results.">CollisionCollector</a>. A smaller fraction is considered to be a 'better hit'. For rays/cast shapes we can just use the collision fraction. The fraction and penetration depth are combined in such a way that deeper hits at fraction 0 go first. </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_shape_cast_result.html">ShapeCastResult</a> ShapeCastResult::Reversed </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td>          <td class="paramname"><span class="paramname"><em>inWorldSpaceCastDirection</em></span></td><td>)</td>
          <td> const</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>Reverses the hit result, swapping contact point 1 with contact point 2 etc. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inWorldSpaceCastDirection</td><td>Direction of the shape cast in world space </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8c1f5167202e5071cca22085350b0471" name="a8c1f5167202e5071cca22085350b0471"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c1f5167202e5071cca22085350b0471">&#9670;&#160;</a></span>mFraction</h2>

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

<p>This is the fraction where the shape hit the other shape: CenterOfMassOnHit = Start + value * (End - Start) </p>

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

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

<p>True if the shape was hit from the back side. </p>

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