struct_character_virtual_1_1_contact.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: CharacterVirtual::Contact Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('struct_character_virtual_1_1_contact.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#pub-methods">Public Member Functions</a> &#124;
  108. <a href="#pub-attribs">Public Attributes</a> &#124;
  109. <a href="struct_character_virtual_1_1_contact-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">CharacterVirtual::Contact Struct Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Encapsulates a collision contact.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_character_virtual_8h_source.html">CharacterVirtual.h</a>&gt;</code></p>
  116. <div class="dynheader">
  117. Inheritance diagram for CharacterVirtual::Contact:</div>
  118. <div class="dyncontent">
  119. <div class="center">
  120. <img src="struct_character_virtual_1_1_contact.png" usemap="#CharacterVirtual::Contact_map" alt=""/>
  121. <map id="CharacterVirtual::Contact_map" name="CharacterVirtual::Contact_map">
  122. <area href="class_character_virtual_1_1_contact_key.html" title="Uniquely identifies a contact between a character and another body or character." alt="CharacterVirtual::ContactKey" shape="rect" coords="0,0,177,24"/>
  123. </map>
  124. </div></div>
  125. <table class="memberdecls">
  126. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  127. Public Member Functions</h2></td></tr>
  128. <tr class="memitem:ae726dbb4b578dfa2f083a74e3eb5c544" id="r_ae726dbb4b578dfa2f083a74e3eb5c544"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae726dbb4b578dfa2f083a74e3eb5c544">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  129. <tr class="separator:ae726dbb4b578dfa2f083a74e3eb5c544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a952dfd4d7f5eaf9c790ae88d88cdb83a" id="r_a952dfd4d7f5eaf9c790ae88d88cdb83a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a952dfd4d7f5eaf9c790ae88d88cdb83a">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  131. <tr class="separator:a952dfd4d7f5eaf9c790ae88d88cdb83a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="inherit_header pub_methods_class_character_virtual_1_1_contact_key"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_character_virtual_1_1_contact_key')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_character_virtual_1_1_contact_key.html">CharacterVirtual::ContactKey</a></td></tr>
  133. <tr class="memitem:a232bdf5cb80a1b4ee8fe0c5d3f733649 inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a232bdf5cb80a1b4ee8fe0c5d3f733649"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a232bdf5cb80a1b4ee8fe0c5d3f733649">ContactKey</a> ()=default</td></tr>
  134. <tr class="memdesc:a232bdf5cb80a1b4ee8fe0c5d3f733649 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  135. <tr class="separator:a232bdf5cb80a1b4ee8fe0c5d3f733649 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:aa3d8a41431389b608f3856dbdc14a2b2 inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_aa3d8a41431389b608f3856dbdc14a2b2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#aa3d8a41431389b608f3856dbdc14a2b2">ContactKey</a> (const <a class="el" href="class_character_virtual_1_1_contact_key.html">ContactKey</a> &amp;inContact)=default</td></tr>
  137. <tr class="separator:aa3d8a41431389b608f3856dbdc14a2b2 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a34228ee00eabccf4048ae679ff233c8f inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a34228ee00eabccf4048ae679ff233c8f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a34228ee00eabccf4048ae679ff233c8f">ContactKey</a> (const <a class="el" href="class_body_i_d.html">BodyID</a> &amp;inBodyB, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeID)</td></tr>
  139. <tr class="separator:a34228ee00eabccf4048ae679ff233c8f inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a103e68f5bd9450a192261b1e11a0c0ef inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a103e68f5bd9450a192261b1e11a0c0ef"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a103e68f5bd9450a192261b1e11a0c0ef">ContactKey</a> (const <a class="el" href="class_character_i_d.html">CharacterID</a> &amp;inCharacterIDB, const <a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> &amp;inSubShapeID)</td></tr>
  141. <tr class="separator:a103e68f5bd9450a192261b1e11a0c0ef inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a2e75f7bb3584c84fc767f8b60c27186e inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a2e75f7bb3584c84fc767f8b60c27186e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_character_virtual_1_1_contact_key.html">ContactKey</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a2e75f7bb3584c84fc767f8b60c27186e">operator=</a> (const <a class="el" href="class_character_virtual_1_1_contact_key.html">ContactKey</a> &amp;inContact)=default</td></tr>
  143. <tr class="separator:a2e75f7bb3584c84fc767f8b60c27186e inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a3c2263c320dd418f740c6864b053d024 inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a3c2263c320dd418f740c6864b053d024"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a3c2263c320dd418f740c6864b053d024">IsSameBody</a> (const <a class="el" href="class_character_virtual_1_1_contact_key.html">ContactKey</a> &amp;inOther) const</td></tr>
  145. <tr class="memdesc:a3c2263c320dd418f740c6864b053d024 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if two contacts refer to the same body (or virtual character) <br /></td></tr>
  146. <tr class="separator:a3c2263c320dd418f740c6864b053d024 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a9bf72c6de59a8bb41b4c45091f254db2 inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a9bf72c6de59a8bb41b4c45091f254db2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a9bf72c6de59a8bb41b4c45091f254db2">operator==</a> (const <a class="el" href="class_character_virtual_1_1_contact_key.html">ContactKey</a> &amp;inRHS) const</td></tr>
  148. <tr class="memdesc:a9bf72c6de59a8bb41b4c45091f254db2 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="mdescLeft">&#160;</td><td class="mdescRight">Equality operator. <br /></td></tr>
  149. <tr class="separator:a9bf72c6de59a8bb41b4c45091f254db2 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:aa4d8cbf25664362ee237da1fd9d39c9a inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_aa4d8cbf25664362ee237da1fd9d39c9a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#aa4d8cbf25664362ee237da1fd9d39c9a">operator!=</a> (const <a class="el" href="class_character_virtual_1_1_contact_key.html">ContactKey</a> &amp;inRHS) const</td></tr>
  151. <tr class="separator:aa4d8cbf25664362ee237da1fd9d39c9a inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a71d6342427e6eb8dd0089b6a86f392f9 inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a71d6342427e6eb8dd0089b6a86f392f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a71d6342427e6eb8dd0089b6a86f392f9">GetHash</a> () const</td></tr>
  153. <tr class="memdesc:a71d6342427e6eb8dd0089b6a86f392f9 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="struct_hash.html" title="Fallback hash function that calls T::GetHash()">Hash</a> of this structure. <br /></td></tr>
  154. <tr class="separator:a71d6342427e6eb8dd0089b6a86f392f9 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a0f4314de63a5392c2445d05d3c2c6349 inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_a0f4314de63a5392c2445d05d3c2c6349"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a0f4314de63a5392c2445d05d3c2c6349">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  156. <tr class="separator:a0f4314de63a5392c2445d05d3c2c6349 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:adeb2d98d0fd3d729ddf260f07e513e35 inherit pub_methods_class_character_virtual_1_1_contact_key" id="r_adeb2d98d0fd3d729ddf260f07e513e35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#adeb2d98d0fd3d729ddf260f07e513e35">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  158. <tr class="separator:adeb2d98d0fd3d729ddf260f07e513e35 inherit pub_methods_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. </table><table class="memberdecls">
  160. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  161. Public Attributes</h2></td></tr>
  162. <tr class="memitem:ae0c5dd762716d33d3c0289846b4126ff" id="r_ae0c5dd762716d33d3c0289846b4126ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae0c5dd762716d33d3c0289846b4126ff">mPosition</a></td></tr>
  163. <tr class="memdesc:ae0c5dd762716d33d3c0289846b4126ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Position where the character makes contact. <br /></td></tr>
  164. <tr class="separator:ae0c5dd762716d33d3c0289846b4126ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:ab4c53990ab4c51b1b7f9abe59de0775c" id="r_ab4c53990ab4c51b1b7f9abe59de0775c"><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="#ab4c53990ab4c51b1b7f9abe59de0775c">mLinearVelocity</a></td></tr>
  166. <tr class="memdesc:ab4c53990ab4c51b1b7f9abe59de0775c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Velocity of the contact point. <br /></td></tr>
  167. <tr class="separator:ab4c53990ab4c51b1b7f9abe59de0775c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a3e0e1203d15a972c0b52b08940439664" id="r_a3e0e1203d15a972c0b52b08940439664"><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="#a3e0e1203d15a972c0b52b08940439664">mContactNormal</a></td></tr>
  169. <tr class="memdesc:a3e0e1203d15a972c0b52b08940439664"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="struct_character_virtual_1_1_contact.html" title="Encapsulates a collision contact.">Contact</a> normal, pointing towards the character. <br /></td></tr>
  170. <tr class="separator:a3e0e1203d15a972c0b52b08940439664"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:ac8573f10d6b69928672603e63490d450" id="r_ac8573f10d6b69928672603e63490d450"><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="#ac8573f10d6b69928672603e63490d450">mSurfaceNormal</a></td></tr>
  172. <tr class="memdesc:ac8573f10d6b69928672603e63490d450"><td class="mdescLeft">&#160;</td><td class="mdescRight">Surface normal of the contact. <br /></td></tr>
  173. <tr class="separator:ac8573f10d6b69928672603e63490d450"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:abbbf77d2cdfb572d1f637812bbca93e9" id="r_abbbf77d2cdfb572d1f637812bbca93e9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abbbf77d2cdfb572d1f637812bbca93e9">mDistance</a></td></tr>
  175. <tr class="memdesc:abbbf77d2cdfb572d1f637812bbca93e9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Distance to the contact &lt;= 0 means that it is an actual contact, &gt; 0 means predictive. <br /></td></tr>
  176. <tr class="separator:abbbf77d2cdfb572d1f637812bbca93e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a85abb6cf7ff39090dba7f596603c8f23" id="r_a85abb6cf7ff39090dba7f596603c8f23"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a85abb6cf7ff39090dba7f596603c8f23">mFraction</a></td></tr>
  178. <tr class="memdesc:a85abb6cf7ff39090dba7f596603c8f23"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fraction along the path where this contact takes place. <br /></td></tr>
  179. <tr class="separator:a85abb6cf7ff39090dba7f596603c8f23"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:a1f227d6b89bbddbc35de63b1c8f7d306" id="r_a1f227d6b89bbddbc35de63b1c8f7d306"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_motion_type_8h.html#a328245ddbb758681fad3c44c9d488fd8">EMotionType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f227d6b89bbddbc35de63b1c8f7d306">mMotionTypeB</a></td></tr>
  181. <tr class="memdesc:a1f227d6b89bbddbc35de63b1c8f7d306"><td class="mdescLeft">&#160;</td><td class="mdescRight">Motion type of B, used to determine the priority of the contact. <br /></td></tr>
  182. <tr class="separator:a1f227d6b89bbddbc35de63b1c8f7d306"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:ae19592c8bdfb0e4fc0b22b88e12f3ebd" id="r_ae19592c8bdfb0e4fc0b22b88e12f3ebd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae19592c8bdfb0e4fc0b22b88e12f3ebd">mIsSensorB</a></td></tr>
  184. <tr class="memdesc:ae19592c8bdfb0e4fc0b22b88e12f3ebd"><td class="mdescLeft">&#160;</td><td class="mdescRight">If B is a sensor. <br /></td></tr>
  185. <tr class="separator:ae19592c8bdfb0e4fc0b22b88e12f3ebd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a3c12c5f756cec99d1d749a46313fc1b3" id="r_a3c12c5f756cec99d1d749a46313fc1b3"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_character_virtual.html">CharacterVirtual</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3c12c5f756cec99d1d749a46313fc1b3">mCharacterB</a> = nullptr</td></tr>
  187. <tr class="memdesc:a3c12c5f756cec99d1d749a46313fc1b3"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_character.html">Character</a> we're colliding with (if not nullptr). Note that this may be a dangling pointer when accessed through <a class="el" href="class_character_virtual.html#a2fcecdf5b3e0f584f2bb7ec5a128dbe6">GetActiveContacts()</a>, use mCharacterIDB instead. <br /></td></tr>
  188. <tr class="separator:a3c12c5f756cec99d1d749a46313fc1b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a904ea0676f8406e735f23ff45fa2d57a" id="r_a904ea0676f8406e735f23ff45fa2d57a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a904ea0676f8406e735f23ff45fa2d57a">mUserData</a></td></tr>
  190. <tr class="memdesc:a904ea0676f8406e735f23ff45fa2d57a"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data of B. <br /></td></tr>
  191. <tr class="separator:a904ea0676f8406e735f23ff45fa2d57a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:a668d987b784e7b11dd030ad79f202cab" id="r_a668d987b784e7b11dd030ad79f202cab"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_physics_material.html">PhysicsMaterial</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a668d987b784e7b11dd030ad79f202cab">mMaterial</a></td></tr>
  193. <tr class="memdesc:a668d987b784e7b11dd030ad79f202cab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Material of B. <br /></td></tr>
  194. <tr class="separator:a668d987b784e7b11dd030ad79f202cab"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:a90d33cabd5e7e175186d781efa42031f" id="r_a90d33cabd5e7e175186d781efa42031f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a90d33cabd5e7e175186d781efa42031f">mHadCollision</a> = false</td></tr>
  196. <tr class="memdesc:a90d33cabd5e7e175186d781efa42031f"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the character actually collided with the contact (can be false if a predictive contact never becomes a real one) <br /></td></tr>
  197. <tr class="separator:a90d33cabd5e7e175186d781efa42031f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:a8137b339f63f6693ed3bb5449ea18ec0" id="r_a8137b339f63f6693ed3bb5449ea18ec0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8137b339f63f6693ed3bb5449ea18ec0">mWasDiscarded</a> = false</td></tr>
  199. <tr class="memdesc:a8137b339f63f6693ed3bb5449ea18ec0"><td class="mdescLeft">&#160;</td><td class="mdescRight">If the contact validate callback chose to discard this contact or when the body is a sensor. <br /></td></tr>
  200. <tr class="separator:a8137b339f63f6693ed3bb5449ea18ec0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:ab702ce98262a29981d4bd1c5f6e86ca5" id="r_ab702ce98262a29981d4bd1c5f6e86ca5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab702ce98262a29981d4bd1c5f6e86ca5">mCanPushCharacter</a> = true</td></tr>
  202. <tr class="memdesc:ab702ce98262a29981d4bd1c5f6e86ca5"><td class="mdescLeft">&#160;</td><td class="mdescRight">When true, the velocity of the contact point can push the character. <br /></td></tr>
  203. <tr class="separator:ab702ce98262a29981d4bd1c5f6e86ca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="inherit_header pub_attribs_class_character_virtual_1_1_contact_key"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_character_virtual_1_1_contact_key')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_character_virtual_1_1_contact_key.html">CharacterVirtual::ContactKey</a></td></tr>
  205. <tr class="memitem:a0d70de66ff7069cc35709b5d06600f5d inherit pub_attribs_class_character_virtual_1_1_contact_key" id="r_a0d70de66ff7069cc35709b5d06600f5d"><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_character_virtual_1_1_contact_key.html#a0d70de66ff7069cc35709b5d06600f5d">mBodyB</a></td></tr>
  206. <tr class="memdesc:a0d70de66ff7069cc35709b5d06600f5d inherit pub_attribs_class_character_virtual_1_1_contact_key"><td class="mdescLeft">&#160;</td><td class="mdescRight">ID of body we're colliding with (if not invalid) <br /></td></tr>
  207. <tr class="separator:a0d70de66ff7069cc35709b5d06600f5d inherit pub_attribs_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:a75c5f74c807559d97002c1b2aad077b9 inherit pub_attribs_class_character_virtual_1_1_contact_key" id="r_a75c5f74c807559d97002c1b2aad077b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_character_i_d.html">CharacterID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_virtual_1_1_contact_key.html#a75c5f74c807559d97002c1b2aad077b9">mCharacterIDB</a></td></tr>
  209. <tr class="memdesc:a75c5f74c807559d97002c1b2aad077b9 inherit pub_attribs_class_character_virtual_1_1_contact_key"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_character.html">Character</a> we're colliding with (if not invalid) <br /></td></tr>
  210. <tr class="separator:a75c5f74c807559d97002c1b2aad077b9 inherit pub_attribs_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:ac26c6719debb6a601e9a504569e36e74 inherit pub_attribs_class_character_virtual_1_1_contact_key" id="r_ac26c6719debb6a601e9a504569e36e74"><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_character_virtual_1_1_contact_key.html#ac26c6719debb6a601e9a504569e36e74">mSubShapeIDB</a></td></tr>
  212. <tr class="memdesc:ac26c6719debb6a601e9a504569e36e74 inherit pub_attribs_class_character_virtual_1_1_contact_key"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub shape ID of body or character we're colliding with. <br /></td></tr>
  213. <tr class="separator:ac26c6719debb6a601e9a504569e36e74 inherit pub_attribs_class_character_virtual_1_1_contact_key"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. </table>
  215. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  216. <div class="textblock"><p>Encapsulates a collision contact. </p>
  217. </div><h2 class="groupheader">Member Function Documentation</h2>
  218. <a id="a952dfd4d7f5eaf9c790ae88d88cdb83a" name="a952dfd4d7f5eaf9c790ae88d88cdb83a"></a>
  219. <h2 class="memtitle"><span class="permalink"><a href="#a952dfd4d7f5eaf9c790ae88d88cdb83a">&#9670;&#160;</a></span>RestoreState()</h2>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">void CharacterVirtual::Contact::RestoreState </td>
  225. <td>(</td>
  226. <td class="paramtype"><a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  227. <td></td>
  228. </tr>
  229. </table>
  230. </div><div class="memdoc">
  231. </div>
  232. </div>
  233. <a id="ae726dbb4b578dfa2f083a74e3eb5c544" name="ae726dbb4b578dfa2f083a74e3eb5c544"></a>
  234. <h2 class="memtitle"><span class="permalink"><a href="#ae726dbb4b578dfa2f083a74e3eb5c544">&#9670;&#160;</a></span>SaveState()</h2>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <table class="memname">
  238. <tr>
  239. <td class="memname">void CharacterVirtual::Contact::SaveState </td>
  240. <td>(</td>
  241. <td class="paramtype"><a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inStream</em></span></td><td>)</td>
  242. <td> const</td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. </div>
  247. </div>
  248. <h2 class="groupheader">Member Data Documentation</h2>
  249. <a id="ab702ce98262a29981d4bd1c5f6e86ca5" name="ab702ce98262a29981d4bd1c5f6e86ca5"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#ab702ce98262a29981d4bd1c5f6e86ca5">&#9670;&#160;</a></span>mCanPushCharacter</h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">bool CharacterVirtual::Contact::mCanPushCharacter = true</td>
  256. </tr>
  257. </table>
  258. </div><div class="memdoc">
  259. <p>When true, the velocity of the contact point can push the character. </p>
  260. </div>
  261. </div>
  262. <a id="a3c12c5f756cec99d1d749a46313fc1b3" name="a3c12c5f756cec99d1d749a46313fc1b3"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#a3c12c5f756cec99d1d749a46313fc1b3">&#9670;&#160;</a></span>mCharacterB</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">const <a class="el" href="class_character_virtual.html">CharacterVirtual</a>* CharacterVirtual::Contact::mCharacterB = nullptr</td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p><a class="el" href="class_character.html">Character</a> we're colliding with (if not nullptr). Note that this may be a dangling pointer when accessed through <a class="el" href="class_character_virtual.html#a2fcecdf5b3e0f584f2bb7ec5a128dbe6">GetActiveContacts()</a>, use mCharacterIDB instead. </p>
  273. </div>
  274. </div>
  275. <a id="a3e0e1203d15a972c0b52b08940439664" name="a3e0e1203d15a972c0b52b08940439664"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#a3e0e1203d15a972c0b52b08940439664">&#9670;&#160;</a></span>mContactNormal</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <table class="memname">
  280. <tr>
  281. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterVirtual::Contact::mContactNormal</td>
  282. </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. <p><a class="el" href="struct_character_virtual_1_1_contact.html" title="Encapsulates a collision contact.">Contact</a> normal, pointing towards the character. </p>
  286. </div>
  287. </div>
  288. <a id="abbbf77d2cdfb572d1f637812bbca93e9" name="abbbf77d2cdfb572d1f637812bbca93e9"></a>
  289. <h2 class="memtitle"><span class="permalink"><a href="#abbbf77d2cdfb572d1f637812bbca93e9">&#9670;&#160;</a></span>mDistance</h2>
  290. <div class="memitem">
  291. <div class="memproto">
  292. <table class="memname">
  293. <tr>
  294. <td class="memname">float CharacterVirtual::Contact::mDistance</td>
  295. </tr>
  296. </table>
  297. </div><div class="memdoc">
  298. <p>Distance to the contact &lt;= 0 means that it is an actual contact, &gt; 0 means predictive. </p>
  299. </div>
  300. </div>
  301. <a id="a85abb6cf7ff39090dba7f596603c8f23" name="a85abb6cf7ff39090dba7f596603c8f23"></a>
  302. <h2 class="memtitle"><span class="permalink"><a href="#a85abb6cf7ff39090dba7f596603c8f23">&#9670;&#160;</a></span>mFraction</h2>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">float CharacterVirtual::Contact::mFraction</td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Fraction along the path where this contact takes place. </p>
  312. </div>
  313. </div>
  314. <a id="a90d33cabd5e7e175186d781efa42031f" name="a90d33cabd5e7e175186d781efa42031f"></a>
  315. <h2 class="memtitle"><span class="permalink"><a href="#a90d33cabd5e7e175186d781efa42031f">&#9670;&#160;</a></span>mHadCollision</h2>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname">bool CharacterVirtual::Contact::mHadCollision = false</td>
  321. </tr>
  322. </table>
  323. </div><div class="memdoc">
  324. <p>If the character actually collided with the contact (can be false if a predictive contact never becomes a real one) </p>
  325. </div>
  326. </div>
  327. <a id="ae19592c8bdfb0e4fc0b22b88e12f3ebd" name="ae19592c8bdfb0e4fc0b22b88e12f3ebd"></a>
  328. <h2 class="memtitle"><span class="permalink"><a href="#ae19592c8bdfb0e4fc0b22b88e12f3ebd">&#9670;&#160;</a></span>mIsSensorB</h2>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="memname">
  332. <tr>
  333. <td class="memname">bool CharacterVirtual::Contact::mIsSensorB</td>
  334. </tr>
  335. </table>
  336. </div><div class="memdoc">
  337. <p>If B is a sensor. </p>
  338. </div>
  339. </div>
  340. <a id="ab4c53990ab4c51b1b7f9abe59de0775c" name="ab4c53990ab4c51b1b7f9abe59de0775c"></a>
  341. <h2 class="memtitle"><span class="permalink"><a href="#ab4c53990ab4c51b1b7f9abe59de0775c">&#9670;&#160;</a></span>mLinearVelocity</h2>
  342. <div class="memitem">
  343. <div class="memproto">
  344. <table class="memname">
  345. <tr>
  346. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterVirtual::Contact::mLinearVelocity</td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. <p>Velocity of the contact point. </p>
  351. </div>
  352. </div>
  353. <a id="a668d987b784e7b11dd030ad79f202cab" name="a668d987b784e7b11dd030ad79f202cab"></a>
  354. <h2 class="memtitle"><span class="permalink"><a href="#a668d987b784e7b11dd030ad79f202cab">&#9670;&#160;</a></span>mMaterial</h2>
  355. <div class="memitem">
  356. <div class="memproto">
  357. <table class="memname">
  358. <tr>
  359. <td class="memname">const <a class="el" href="class_physics_material.html">PhysicsMaterial</a>* CharacterVirtual::Contact::mMaterial</td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>Material of B. </p>
  364. </div>
  365. </div>
  366. <a id="a1f227d6b89bbddbc35de63b1c8f7d306" name="a1f227d6b89bbddbc35de63b1c8f7d306"></a>
  367. <h2 class="memtitle"><span class="permalink"><a href="#a1f227d6b89bbddbc35de63b1c8f7d306">&#9670;&#160;</a></span>mMotionTypeB</h2>
  368. <div class="memitem">
  369. <div class="memproto">
  370. <table class="memname">
  371. <tr>
  372. <td class="memname"><a class="el" href="_motion_type_8h.html#a328245ddbb758681fad3c44c9d488fd8">EMotionType</a> CharacterVirtual::Contact::mMotionTypeB</td>
  373. </tr>
  374. </table>
  375. </div><div class="memdoc">
  376. <p>Motion type of B, used to determine the priority of the contact. </p>
  377. </div>
  378. </div>
  379. <a id="ae0c5dd762716d33d3c0289846b4126ff" name="ae0c5dd762716d33d3c0289846b4126ff"></a>
  380. <h2 class="memtitle"><span class="permalink"><a href="#ae0c5dd762716d33d3c0289846b4126ff">&#9670;&#160;</a></span>mPosition</h2>
  381. <div class="memitem">
  382. <div class="memproto">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a> CharacterVirtual::Contact::mPosition</td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. <p>Position where the character makes contact. </p>
  390. </div>
  391. </div>
  392. <a id="ac8573f10d6b69928672603e63490d450" name="ac8573f10d6b69928672603e63490d450"></a>
  393. <h2 class="memtitle"><span class="permalink"><a href="#ac8573f10d6b69928672603e63490d450">&#9670;&#160;</a></span>mSurfaceNormal</h2>
  394. <div class="memitem">
  395. <div class="memproto">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterVirtual::Contact::mSurfaceNormal</td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Surface normal of the contact. </p>
  403. </div>
  404. </div>
  405. <a id="a904ea0676f8406e735f23ff45fa2d57a" name="a904ea0676f8406e735f23ff45fa2d57a"></a>
  406. <h2 class="memtitle"><span class="permalink"><a href="#a904ea0676f8406e735f23ff45fa2d57a">&#9670;&#160;</a></span>mUserData</h2>
  407. <div class="memitem">
  408. <div class="memproto">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> CharacterVirtual::Contact::mUserData</td>
  412. </tr>
  413. </table>
  414. </div><div class="memdoc">
  415. <p>User data of B. </p>
  416. </div>
  417. </div>
  418. <a id="a8137b339f63f6693ed3bb5449ea18ec0" name="a8137b339f63f6693ed3bb5449ea18ec0"></a>
  419. <h2 class="memtitle"><span class="permalink"><a href="#a8137b339f63f6693ed3bb5449ea18ec0">&#9670;&#160;</a></span>mWasDiscarded</h2>
  420. <div class="memitem">
  421. <div class="memproto">
  422. <table class="memname">
  423. <tr>
  424. <td class="memname">bool CharacterVirtual::Contact::mWasDiscarded = false</td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>If the contact validate callback chose to discard this contact or when the body is a sensor. </p>
  429. </div>
  430. </div>
  431. <hr/>The documentation for this struct was generated from the following files:<ul>
  432. <li>Jolt/Physics/Character/<a class="el" href="_character_virtual_8h_source.html">CharacterVirtual.h</a></li>
  433. <li>Jolt/Physics/Character/<a class="el" href="_character_virtual_8cpp.html">CharacterVirtual.cpp</a></li>
  434. </ul>
  435. </div><!-- contents -->
  436. </div><!-- doc-content -->
  437. <!-- start footer part -->
  438. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  439. <ul>
  440. <li class="navelem"><a class="el" href="class_character_virtual.html">CharacterVirtual</a></li><li class="navelem"><a class="el" href="struct_character_virtual_1_1_contact.html">Contact</a></li>
  441. <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>
  442. </ul>
  443. </div>
  444. </body>
  445. </html>