class_character_base.html 68 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171
  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: CharacterBase Class 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('class_character_base.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-types">Public Types</a> &#124;
  108. <a href="#pub-methods">Public Member Functions</a> &#124;
  109. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  110. <a href="class_character_base-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">CharacterBase Class Reference</div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Base class for character class.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_character_base_8h_source.html">CharacterBase.h</a>&gt;</code></p>
  117. <div class="dynheader">
  118. Inheritance diagram for CharacterBase:</div>
  119. <div class="dyncontent">
  120. <div class="center">
  121. <img src="class_character_base.png" usemap="#CharacterBase_map" alt=""/>
  122. <map id="CharacterBase_map" name="CharacterBase_map">
  123. <area href="class_ref_target.html" alt="RefTarget&lt; CharacterBase &gt;" shape="rect" coords="0,0,176,24"/>
  124. <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="186,0,362,24"/>
  125. <area href="class_character.html" alt="Character" shape="rect" coords="0,112,176,136"/>
  126. <area href="class_character_virtual.html" alt="CharacterVirtual" shape="rect" coords="186,112,362,136"/>
  127. </map>
  128. </div></div>
  129. <table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  131. Public Types</h2></td></tr>
  132. <tr class="memitem:a82dfb80348cdbf3a08f97d54b225f77e" id="r_a82dfb80348cdbf3a08f97d54b225f77e"><td class="memItemLeft" align="right" valign="top">enum class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">EGroundState</a> { <a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77ea2b9beed57034f5727573d7ded76cf777">OnGround</a>
  133. , <a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77ea50f80f8d96a6d65de73ba8a6b9910761">OnSteepGround</a>
  134. , <a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77ea9ed2d871602556951e39f3cebd08d6cb">NotSupported</a>
  135. , <a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77eaee4e669a07b061d70b9b79dfed9cb5e7">InAir</a>
  136. }</td></tr>
  137. <tr class="separator:a82dfb80348cdbf3a08f97d54b225f77e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table><table class="memberdecls">
  139. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  140. Public Member Functions</h2></td></tr>
  141. <tr class="memitem:ae105fe52be09ccb14a7e7aa57b83e8ca" id="r_ae105fe52be09ccb14a7e7aa57b83e8ca"><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="#ae105fe52be09ccb14a7e7aa57b83e8ca">CharacterBase</a> (const <a class="el" href="class_character_base_settings.html">CharacterBaseSettings</a> *inSettings, <a class="el" href="class_physics_system.html">PhysicsSystem</a> *inSystem)</td></tr>
  142. <tr class="memdesc:ae105fe52be09ccb14a7e7aa57b83e8ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  143. <tr class="separator:ae105fe52be09ccb14a7e7aa57b83e8ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a5e0ba80e28b9e012acf7b8c1fa605ef5" id="r_a5e0ba80e28b9e012acf7b8c1fa605ef5"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5e0ba80e28b9e012acf7b8c1fa605ef5">~CharacterBase</a> ()=default</td></tr>
  145. <tr class="memdesc:a5e0ba80e28b9e012acf7b8c1fa605ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  146. <tr class="separator:a5e0ba80e28b9e012acf7b8c1fa605ef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a0c2099dfbf12c1bd6f839a3eda5c9726" id="r_a0c2099dfbf12c1bd6f839a3eda5c9726"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c2099dfbf12c1bd6f839a3eda5c9726">SetMaxSlopeAngle</a> (float inMaxSlopeAngle)</td></tr>
  148. <tr class="memdesc:a0c2099dfbf12c1bd6f839a3eda5c9726"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the maximum angle of slope that character can still walk on (radians) <br /></td></tr>
  149. <tr class="separator:a0c2099dfbf12c1bd6f839a3eda5c9726"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:aa7d43079f3b6c40c3fa1ccc30a8682bf" id="r_aa7d43079f3b6c40c3fa1ccc30a8682bf"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa7d43079f3b6c40c3fa1ccc30a8682bf">GetCosMaxSlopeAngle</a> () const</td></tr>
  151. <tr class="separator:aa7d43079f3b6c40c3fa1ccc30a8682bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:a46d5822b95a5e771adc1e33f1f9b891c" id="r_a46d5822b95a5e771adc1e33f1f9b891c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a46d5822b95a5e771adc1e33f1f9b891c">SetUp</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inUp)</td></tr>
  153. <tr class="memdesc:a46d5822b95a5e771adc1e33f1f9b891c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the up vector for the character. <br /></td></tr>
  154. <tr class="separator:a46d5822b95a5e771adc1e33f1f9b891c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a2a437049ade0a3ab8ab7aeafb64f5163" id="r_a2a437049ade0a3ab8ab7aeafb64f5163"><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="#a2a437049ade0a3ab8ab7aeafb64f5163">GetUp</a> () const</td></tr>
  156. <tr class="separator:a2a437049ade0a3ab8ab7aeafb64f5163"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a87e7e3bcc174d5e498844dcac7f7f173" id="r_a87e7e3bcc174d5e498844dcac7f7f173"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a87e7e3bcc174d5e498844dcac7f7f173">IsSlopeTooSteep</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inNormal) const</td></tr>
  158. <tr class="memdesc:a87e7e3bcc174d5e498844dcac7f7f173"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the normal of the ground surface is too steep to walk on. <br /></td></tr>
  159. <tr class="separator:a87e7e3bcc174d5e498844dcac7f7f173"><td class="memSeparator" colspan="2">&#160;</td></tr>
  160. <tr class="memitem:afe046cfb3333be1fcb186f42821ddb19" id="r_afe046cfb3333be1fcb186f42821ddb19"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_shape.html">Shape</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afe046cfb3333be1fcb186f42821ddb19">GetShape</a> () const</td></tr>
  161. <tr class="memdesc:afe046cfb3333be1fcb186f42821ddb19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current shape that the character is using. <br /></td></tr>
  162. <tr class="separator:afe046cfb3333be1fcb186f42821ddb19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="inherit_header pub_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; CharacterBase &gt;</a></td></tr>
  164. <tr class="memitem:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target" id="r_a4c8a23738e2e1dd6369520a30e250b17"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a4c8a23738e2e1dd6369520a30e250b17">RefTarget</a> ()=default</td></tr>
  165. <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  166. <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target" id="r_a50444e3b659c6f93c64aee224a93f6ab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a50444e3b659c6f93c64aee224a93f6ab">RefTarget</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
  168. <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target" id="r_ac3110b9f511287f881d7afaf26871e1b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ac3110b9f511287f881d7afaf26871e1b">~RefTarget</a> ()</td></tr>
  170. <tr class="memdesc:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">assert no one is referencing us <br /></td></tr>
  171. <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  172. <tr class="memitem:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target" id="r_a3befa746ea517453572f6f4f5fc3b099"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a3befa746ea517453572f6f4f5fc3b099">SetEmbedded</a> () const</td></tr>
  173. <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target" id="r_a1fc15bfe979bc43a7fa71c7c34f87ed0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_target.html">RefTarget</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a1fc15bfe979bc43a7fa71c7c34f87ed0">operator=</a> (const <a class="el" href="class_ref_target.html">RefTarget</a> &amp;)</td></tr>
  175. <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
  176. <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target" id="r_acaf07366183c51cd8460c7d3dcd07c2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acaf07366183c51cd8460c7d3dcd07c2d">GetRefCount</a> () const</td></tr>
  178. <tr class="memdesc:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current refcount of this object. <br /></td></tr>
  179. <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target" id="r_acf02c18a343bc9de9d6afb7c966f0363"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#acf02c18a343bc9de9d6afb7c966f0363">AddRef</a> () const</td></tr>
  181. <tr class="memdesc:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add or release a reference to this object. <br /></td></tr>
  182. <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target" id="r_a0451661dd5d85b01f969319e767993eb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a0451661dd5d85b01f969319e767993eb">Release</a> () const</td></tr>
  184. <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
  186. <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
  187. <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  188. <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  189. <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &amp;)=delete</td></tr>
  191. <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. </table><table class="memberdecls">
  193. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  194. Static Public Member Functions</h2></td></tr>
  195. <tr class="memitem:a269b97a0088e3651387c10f350d792cd" id="r_a269b97a0088e3651387c10f350d792cd"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a269b97a0088e3651387c10f350d792cd">sToString</a> (<a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">EGroundState</a> inState)</td></tr>
  196. <tr class="memdesc:a269b97a0088e3651387c10f350d792cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Debug function to convert enum values to string. <br /></td></tr>
  197. <tr class="separator:a269b97a0088e3651387c10f350d792cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="inherit_header pub_static_methods_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_static_methods_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; CharacterBase &gt;</a></td></tr>
  199. <tr class="memitem:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target" id="r_a58b5a94748691b18ecf651ce918ae743"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a58b5a94748691b18ecf651ce918ae743">sInternalGetRefCountOffset</a> ()</td></tr>
  200. <tr class="memdesc:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">INTERNAL HELPER FUNCTION USED BY SERIALIZATION. <br /></td></tr>
  201. <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. </table><table class="memberdecls">
  203. <tr class="heading"><td colspan="2"><h2 class="groupheader">Properties of the ground this character is standing on</h2></td></tr>
  204. <tr class="memitem:ac6c3f8f7a2492d0c0f2eac85a9cc5a01" id="r_ac6c3f8f7a2492d0c0f2eac85a9cc5a01"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_physics_system.html">PhysicsSystem</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac6c3f8f7a2492d0c0f2eac85a9cc5a01">mSystem</a></td></tr>
  205. <tr class="separator:ac6c3f8f7a2492d0c0f2eac85a9cc5a01"><td class="memSeparator" colspan="2">&#160;</td></tr>
  206. <tr class="memitem:a5c10220e06a8a5bb274a4b02c28cb0b6" id="r_a5c10220e06a8a5bb274a4b02c28cb0b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_const.html">RefConst</a>&lt; <a class="el" href="class_shape.html">Shape</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c10220e06a8a5bb274a4b02c28cb0b6">mShape</a></td></tr>
  207. <tr class="separator:a5c10220e06a8a5bb274a4b02c28cb0b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <tr class="memitem:a5f637f449a17fb6a1b10297764de48b4" id="r_a5f637f449a17fb6a1b10297764de48b4"><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="#a5f637f449a17fb6a1b10297764de48b4">mUp</a></td></tr>
  209. <tr class="separator:a5f637f449a17fb6a1b10297764de48b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:ae9fb45e5980787c5f7f718f6e7703797" id="r_ae9fb45e5980787c5f7f718f6e7703797"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_plane.html">Plane</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae9fb45e5980787c5f7f718f6e7703797">mSupportingVolume</a></td></tr>
  211. <tr class="separator:ae9fb45e5980787c5f7f718f6e7703797"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <tr class="memitem:a9da1e29d9257f3cce909487da437a0c9" id="r_a9da1e29d9257f3cce909487da437a0c9"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9da1e29d9257f3cce909487da437a0c9">mCosMaxSlopeAngle</a></td></tr>
  213. <tr class="separator:a9da1e29d9257f3cce909487da437a0c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  214. <tr class="memitem:a1cf96842849baa268527dfa548219510" id="r_a1cf96842849baa268527dfa548219510"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">EGroundState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1cf96842849baa268527dfa548219510">mGroundState</a> = <a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77eaee4e669a07b061d70b9b79dfed9cb5e7">EGroundState::InAir</a></td></tr>
  215. <tr class="separator:a1cf96842849baa268527dfa548219510"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <tr class="memitem:a893268ea23759f36ebe8e317a54afa7e" id="r_a893268ea23759f36ebe8e317a54afa7e"><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="#a893268ea23759f36ebe8e317a54afa7e">mGroundBodyID</a></td></tr>
  217. <tr class="separator:a893268ea23759f36ebe8e317a54afa7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  218. <tr class="memitem:afa16450cf4dc265231e0f616aa5eeec9" id="r_afa16450cf4dc265231e0f616aa5eeec9"><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="#afa16450cf4dc265231e0f616aa5eeec9">mGroundBodySubShapeID</a></td></tr>
  219. <tr class="separator:afa16450cf4dc265231e0f616aa5eeec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. <tr class="memitem:a2b9e9d8616bb0c7c8cb6ba59f5c7bf8a" id="r_a2b9e9d8616bb0c7c8cb6ba59f5c7bf8a"><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="#a2b9e9d8616bb0c7c8cb6ba59f5c7bf8a">mGroundPosition</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">RVec3::sZero</a>()</td></tr>
  221. <tr class="separator:a2b9e9d8616bb0c7c8cb6ba59f5c7bf8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. <tr class="memitem:a3537f13f2e427573266d9f591f1aadf3" id="r_a3537f13f2e427573266d9f591f1aadf3"><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="#a3537f13f2e427573266d9f591f1aadf3">mGroundNormal</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td></tr>
  223. <tr class="separator:a3537f13f2e427573266d9f591f1aadf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  224. <tr class="memitem:add543ae2333820dbf77e23009dfe4367" id="r_add543ae2333820dbf77e23009dfe4367"><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="#add543ae2333820dbf77e23009dfe4367">mGroundVelocity</a> = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td></tr>
  225. <tr class="separator:add543ae2333820dbf77e23009dfe4367"><td class="memSeparator" colspan="2">&#160;</td></tr>
  226. <tr class="memitem:a2586c1571ba8e5adc511d71f413de2c1" id="r_a2586c1571ba8e5adc511d71f413de2c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_ref_const.html">RefConst</a>&lt; <a class="el" href="class_physics_material.html">PhysicsMaterial</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2586c1571ba8e5adc511d71f413de2c1">mGroundMaterial</a> = <a class="el" href="class_physics_material.html#af51825c643c3cafc49e007d8ca1c14cd">PhysicsMaterial::sDefault</a></td></tr>
  227. <tr class="separator:a2586c1571ba8e5adc511d71f413de2c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  228. <tr class="memitem:acf9a8bdf6fa420d9615206d196794135" id="r_acf9a8bdf6fa420d9615206d196794135"><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="#acf9a8bdf6fa420d9615206d196794135">mGroundUserData</a> = 0</td></tr>
  229. <tr class="separator:acf9a8bdf6fa420d9615206d196794135"><td class="memSeparator" colspan="2">&#160;</td></tr>
  230. <tr class="memitem:a32bda1f36a6c2ba0eb1fec77dfcbb078" id="r_a32bda1f36a6c2ba0eb1fec77dfcbb078"><td class="memItemLeft" align="right" valign="top">static constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a32bda1f36a6c2ba0eb1fec77dfcbb078">cNoMaxSlopeAngle</a> = 0.9999f</td></tr>
  231. <tr class="separator:a32bda1f36a6c2ba0eb1fec77dfcbb078"><td class="memSeparator" colspan="2">&#160;</td></tr>
  232. <tr class="memitem:ab8ce7589bd0e97901030bceeda7a513b" id="r_ab8ce7589bd0e97901030bceeda7a513b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">EGroundState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab8ce7589bd0e97901030bceeda7a513b">GetGroundState</a> () const</td></tr>
  233. <tr class="memdesc:ab8ce7589bd0e97901030bceeda7a513b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current ground state. <br /></td></tr>
  234. <tr class="separator:ab8ce7589bd0e97901030bceeda7a513b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  235. <tr class="memitem:a700e706b9c1710409fc16c6f9a083e0b" id="r_a700e706b9c1710409fc16c6f9a083e0b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a700e706b9c1710409fc16c6f9a083e0b">IsSupported</a> () const</td></tr>
  236. <tr class="memdesc:a700e706b9c1710409fc16c6f9a083e0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the player is supported by normal or steep ground. <br /></td></tr>
  237. <tr class="separator:a700e706b9c1710409fc16c6f9a083e0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  238. <tr class="memitem:a0ecc9be497c5fc46bef4277a734a691a" id="r_a0ecc9be497c5fc46bef4277a734a691a"><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="#a0ecc9be497c5fc46bef4277a734a691a">GetGroundPosition</a> () const</td></tr>
  239. <tr class="memdesc:a0ecc9be497c5fc46bef4277a734a691a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the contact point with the ground. <br /></td></tr>
  240. <tr class="separator:a0ecc9be497c5fc46bef4277a734a691a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  241. <tr class="memitem:adde62ba706430b59595bb8d56731eaa8" id="r_adde62ba706430b59595bb8d56731eaa8"><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="#adde62ba706430b59595bb8d56731eaa8">GetGroundNormal</a> () const</td></tr>
  242. <tr class="memdesc:adde62ba706430b59595bb8d56731eaa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the contact normal with the ground. <br /></td></tr>
  243. <tr class="separator:adde62ba706430b59595bb8d56731eaa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  244. <tr class="memitem:a692578285569b48d19d53684360a5656" id="r_a692578285569b48d19d53684360a5656"><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="#a692578285569b48d19d53684360a5656">GetGroundVelocity</a> () const</td></tr>
  245. <tr class="memdesc:a692578285569b48d19d53684360a5656"><td class="mdescLeft">&#160;</td><td class="mdescRight">Velocity in world space of ground. <br /></td></tr>
  246. <tr class="separator:a692578285569b48d19d53684360a5656"><td class="memSeparator" colspan="2">&#160;</td></tr>
  247. <tr class="memitem:ac4771494235c54165b6b4c9ad64dcdc8" id="r_ac4771494235c54165b6b4c9ad64dcdc8"><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="#ac4771494235c54165b6b4c9ad64dcdc8">GetGroundMaterial</a> () const</td></tr>
  248. <tr class="memdesc:ac4771494235c54165b6b4c9ad64dcdc8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Material that the character is standing on. <br /></td></tr>
  249. <tr class="separator:ac4771494235c54165b6b4c9ad64dcdc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  250. <tr class="memitem:ab677215920d0b4cd10874b3a56a35026" id="r_ab677215920d0b4cd10874b3a56a35026"><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="#ab677215920d0b4cd10874b3a56a35026">GetGroundBodyID</a> () const</td></tr>
  251. <tr class="memdesc:ab677215920d0b4cd10874b3a56a35026"><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> of the object the character is standing on. Note may have been removed! <br /></td></tr>
  252. <tr class="separator:ab677215920d0b4cd10874b3a56a35026"><td class="memSeparator" colspan="2">&#160;</td></tr>
  253. <tr class="memitem:a2ab264ce1b5888134b38177f71a81f91" id="r_a2ab264ce1b5888134b38177f71a81f91"><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="#a2ab264ce1b5888134b38177f71a81f91">GetGroundSubShapeID</a> () const</td></tr>
  254. <tr class="memdesc:a2ab264ce1b5888134b38177f71a81f91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sub part of the body that we're standing on. <br /></td></tr>
  255. <tr class="separator:a2ab264ce1b5888134b38177f71a81f91"><td class="memSeparator" colspan="2">&#160;</td></tr>
  256. <tr class="memitem:ae8c2a236d46c2e362021c1ab3364c432" id="r_ae8c2a236d46c2e362021c1ab3364c432"><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="#ae8c2a236d46c2e362021c1ab3364c432">GetGroundUserData</a> () const</td></tr>
  257. <tr class="memdesc:ae8c2a236d46c2e362021c1ab3364c432"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data value of the body that we're standing on. <br /></td></tr>
  258. <tr class="separator:ae8c2a236d46c2e362021c1ab3364c432"><td class="memSeparator" colspan="2">&#160;</td></tr>
  259. <tr class="memitem:ab28f7afaa654cf8461f3638dd01334e0" id="r_ab28f7afaa654cf8461f3638dd01334e0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab28f7afaa654cf8461f3638dd01334e0">SaveState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream) const</td></tr>
  260. <tr class="separator:ab28f7afaa654cf8461f3638dd01334e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  261. <tr class="memitem:ad9d1540df7d44b3aaeee88a527df7d7d" id="r_ad9d1540df7d44b3aaeee88a527df7d7d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad9d1540df7d44b3aaeee88a527df7d7d">RestoreState</a> (<a class="el" href="class_state_recorder.html">StateRecorder</a> &amp;inStream)</td></tr>
  262. <tr class="separator:ad9d1540df7d44b3aaeee88a527df7d7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  263. </table><table class="memberdecls">
  264. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  265. Additional Inherited Members</h2></td></tr>
  266. <tr class="inherit_header pro_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; CharacterBase &gt;</a></td></tr>
  267. <tr class="memitem:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target" id="r_a12afba0bdae7706a0afd4d96ac128231"><td class="memItemLeft" align="right" valign="top">atomic&lt; <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#a12afba0bdae7706a0afd4d96ac128231">mRefCount</a></td></tr>
  268. <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count. <br /></td></tr>
  269. <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  270. <tr class="inherit_header pro_static_attribs_class_ref_target"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_static_attribs_class_ref_target')"><img src="closed.png" alt="-"/>&#160;Static Protected Attributes inherited from <a class="el" href="class_ref_target.html">RefTarget&lt; CharacterBase &gt;</a></td></tr>
  271. <tr class="memitem:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target" id="r_ad37db773efa3c8756f6d95df3862b875"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_ref_target.html#ad37db773efa3c8756f6d95df3862b875">cEmbedded</a></td></tr>
  272. <tr class="memdesc:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">A large value that gets added to the refcount to mark the object as embedded. <br /></td></tr>
  273. <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  274. </table>
  275. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  276. <div class="textblock"><p>Base class for character class. </p>
  277. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  278. <a id="a82dfb80348cdbf3a08f97d54b225f77e" name="a82dfb80348cdbf3a08f97d54b225f77e"></a>
  279. <h2 class="memtitle"><span class="permalink"><a href="#a82dfb80348cdbf3a08f97d54b225f77e">&#9670;&#160;</a></span>EGroundState</h2>
  280. <div class="memitem">
  281. <div class="memproto">
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname">enum class <a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">CharacterBase::EGroundState</a></td>
  288. </tr>
  289. </table>
  290. </td>
  291. <td class="mlabels-right">
  292. <span class="mlabels"><span class="mlabel">strong</span></span> </td>
  293. </tr>
  294. </table>
  295. </div><div class="memdoc">
  296. <table class="fieldtable">
  297. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a82dfb80348cdbf3a08f97d54b225f77ea2b9beed57034f5727573d7ded76cf777" name="a82dfb80348cdbf3a08f97d54b225f77ea2b9beed57034f5727573d7ded76cf777"></a>OnGround&#160;</td><td class="fielddoc"><p><a class="el" href="class_character.html">Character</a> is on the ground and can move freely. </p>
  298. </td></tr>
  299. <tr><td class="fieldname"><a id="a82dfb80348cdbf3a08f97d54b225f77ea50f80f8d96a6d65de73ba8a6b9910761" name="a82dfb80348cdbf3a08f97d54b225f77ea50f80f8d96a6d65de73ba8a6b9910761"></a>OnSteepGround&#160;</td><td class="fielddoc"><p><a class="el" href="class_character.html">Character</a> is on a slope that is too steep and can't climb up any further. The caller should start applying downward velocity if sliding from the slope is desired. </p>
  300. </td></tr>
  301. <tr><td class="fieldname"><a id="a82dfb80348cdbf3a08f97d54b225f77ea9ed2d871602556951e39f3cebd08d6cb" name="a82dfb80348cdbf3a08f97d54b225f77ea9ed2d871602556951e39f3cebd08d6cb"></a>NotSupported&#160;</td><td class="fielddoc"><p><a class="el" href="class_character.html">Character</a> is touching an object, but is not supported by it and should fall. The GetGroundXXX functions will return information about the touched object. </p>
  302. </td></tr>
  303. <tr><td class="fieldname"><a id="a82dfb80348cdbf3a08f97d54b225f77eaee4e669a07b061d70b9b79dfed9cb5e7" name="a82dfb80348cdbf3a08f97d54b225f77eaee4e669a07b061d70b9b79dfed9cb5e7"></a>InAir&#160;</td><td class="fielddoc"><p><a class="el" href="class_character.html">Character</a> is in the air and is not touching anything. </p>
  304. </td></tr>
  305. </table>
  306. </div>
  307. </div>
  308. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  309. <a id="ae105fe52be09ccb14a7e7aa57b83e8ca" name="ae105fe52be09ccb14a7e7aa57b83e8ca"></a>
  310. <h2 class="memtitle"><span class="permalink"><a href="#ae105fe52be09ccb14a7e7aa57b83e8ca">&#9670;&#160;</a></span>CharacterBase()</h2>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> CharacterBase::CharacterBase </td>
  316. <td>(</td>
  317. <td class="paramtype">const <a class="el" href="class_character_base_settings.html">CharacterBaseSettings</a> *</td> <td class="paramname"><span class="paramname"><em>inSettings</em></span>, </td>
  318. </tr>
  319. <tr>
  320. <td class="paramkey"></td>
  321. <td></td>
  322. <td class="paramtype"><a class="el" href="class_physics_system.html">PhysicsSystem</a> *</td> <td class="paramname"><span class="paramname"><em>inSystem</em></span>&#160;)</td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. <p>Constructor. </p>
  327. </div>
  328. </div>
  329. <a id="a5e0ba80e28b9e012acf7b8c1fa605ef5" name="a5e0ba80e28b9e012acf7b8c1fa605ef5"></a>
  330. <h2 class="memtitle"><span class="permalink"><a href="#a5e0ba80e28b9e012acf7b8c1fa605ef5">&#9670;&#160;</a></span>~CharacterBase()</h2>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="mlabels">
  334. <tr>
  335. <td class="mlabels-left">
  336. <table class="memname">
  337. <tr>
  338. <td class="memname">virtual CharacterBase::~CharacterBase </td>
  339. <td>(</td>
  340. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  341. <td></td>
  342. </tr>
  343. </table>
  344. </td>
  345. <td class="mlabels-right">
  346. <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. <p>Destructor. </p>
  351. </div>
  352. </div>
  353. <h2 class="groupheader">Member Function Documentation</h2>
  354. <a id="aa7d43079f3b6c40c3fa1ccc30a8682bf" name="aa7d43079f3b6c40c3fa1ccc30a8682bf"></a>
  355. <h2 class="memtitle"><span class="permalink"><a href="#aa7d43079f3b6c40c3fa1ccc30a8682bf">&#9670;&#160;</a></span>GetCosMaxSlopeAngle()</h2>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <table class="mlabels">
  359. <tr>
  360. <td class="mlabels-left">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">float CharacterBase::GetCosMaxSlopeAngle </td>
  364. <td>(</td>
  365. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  366. <td> const</td>
  367. </tr>
  368. </table>
  369. </td>
  370. <td class="mlabels-right">
  371. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  372. </tr>
  373. </table>
  374. </div><div class="memdoc">
  375. </div>
  376. </div>
  377. <a id="ab677215920d0b4cd10874b3a56a35026" name="ab677215920d0b4cd10874b3a56a35026"></a>
  378. <h2 class="memtitle"><span class="permalink"><a href="#ab677215920d0b4cd10874b3a56a35026">&#9670;&#160;</a></span>GetGroundBodyID()</h2>
  379. <div class="memitem">
  380. <div class="memproto">
  381. <table class="mlabels">
  382. <tr>
  383. <td class="mlabels-left">
  384. <table class="memname">
  385. <tr>
  386. <td class="memname"><a class="el" href="class_body_i_d.html">BodyID</a> CharacterBase::GetGroundBodyID </td>
  387. <td>(</td>
  388. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  389. <td> const</td>
  390. </tr>
  391. </table>
  392. </td>
  393. <td class="mlabels-right">
  394. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  395. </tr>
  396. </table>
  397. </div><div class="memdoc">
  398. <p><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> of the object the character is standing on. Note may have been removed! </p>
  399. </div>
  400. </div>
  401. <a id="ac4771494235c54165b6b4c9ad64dcdc8" name="ac4771494235c54165b6b4c9ad64dcdc8"></a>
  402. <h2 class="memtitle"><span class="permalink"><a href="#ac4771494235c54165b6b4c9ad64dcdc8">&#9670;&#160;</a></span>GetGroundMaterial()</h2>
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="mlabels">
  406. <tr>
  407. <td class="mlabels-left">
  408. <table class="memname">
  409. <tr>
  410. <td class="memname">const <a class="el" href="class_physics_material.html">PhysicsMaterial</a> * CharacterBase::GetGroundMaterial </td>
  411. <td>(</td>
  412. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  413. <td> const</td>
  414. </tr>
  415. </table>
  416. </td>
  417. <td class="mlabels-right">
  418. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  419. </tr>
  420. </table>
  421. </div><div class="memdoc">
  422. <p>Material that the character is standing on. </p>
  423. </div>
  424. </div>
  425. <a id="adde62ba706430b59595bb8d56731eaa8" name="adde62ba706430b59595bb8d56731eaa8"></a>
  426. <h2 class="memtitle"><span class="permalink"><a href="#adde62ba706430b59595bb8d56731eaa8">&#9670;&#160;</a></span>GetGroundNormal()</h2>
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="mlabels">
  430. <tr>
  431. <td class="mlabels-left">
  432. <table class="memname">
  433. <tr>
  434. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterBase::GetGroundNormal </td>
  435. <td>(</td>
  436. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  437. <td> const</td>
  438. </tr>
  439. </table>
  440. </td>
  441. <td class="mlabels-right">
  442. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  443. </tr>
  444. </table>
  445. </div><div class="memdoc">
  446. <p>Get the contact normal with the ground. </p>
  447. </div>
  448. </div>
  449. <a id="a0ecc9be497c5fc46bef4277a734a691a" name="a0ecc9be497c5fc46bef4277a734a691a"></a>
  450. <h2 class="memtitle"><span class="permalink"><a href="#a0ecc9be497c5fc46bef4277a734a691a">&#9670;&#160;</a></span>GetGroundPosition()</h2>
  451. <div class="memitem">
  452. <div class="memproto">
  453. <table class="mlabels">
  454. <tr>
  455. <td class="mlabels-left">
  456. <table class="memname">
  457. <tr>
  458. <td class="memname"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a> CharacterBase::GetGroundPosition </td>
  459. <td>(</td>
  460. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  461. <td> const</td>
  462. </tr>
  463. </table>
  464. </td>
  465. <td class="mlabels-right">
  466. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  467. </tr>
  468. </table>
  469. </div><div class="memdoc">
  470. <p>Get the contact point with the ground. </p>
  471. </div>
  472. </div>
  473. <a id="ab8ce7589bd0e97901030bceeda7a513b" name="ab8ce7589bd0e97901030bceeda7a513b"></a>
  474. <h2 class="memtitle"><span class="permalink"><a href="#ab8ce7589bd0e97901030bceeda7a513b">&#9670;&#160;</a></span>GetGroundState()</h2>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="mlabels">
  478. <tr>
  479. <td class="mlabels-left">
  480. <table class="memname">
  481. <tr>
  482. <td class="memname"><a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">EGroundState</a> CharacterBase::GetGroundState </td>
  483. <td>(</td>
  484. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  485. <td> const</td>
  486. </tr>
  487. </table>
  488. </td>
  489. <td class="mlabels-right">
  490. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  491. </tr>
  492. </table>
  493. </div><div class="memdoc">
  494. <p>Current ground state. </p>
  495. </div>
  496. </div>
  497. <a id="a2ab264ce1b5888134b38177f71a81f91" name="a2ab264ce1b5888134b38177f71a81f91"></a>
  498. <h2 class="memtitle"><span class="permalink"><a href="#a2ab264ce1b5888134b38177f71a81f91">&#9670;&#160;</a></span>GetGroundSubShapeID()</h2>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="mlabels">
  502. <tr>
  503. <td class="mlabels-left">
  504. <table class="memname">
  505. <tr>
  506. <td class="memname"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> CharacterBase::GetGroundSubShapeID </td>
  507. <td>(</td>
  508. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  509. <td> const</td>
  510. </tr>
  511. </table>
  512. </td>
  513. <td class="mlabels-right">
  514. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  515. </tr>
  516. </table>
  517. </div><div class="memdoc">
  518. <p>Sub part of the body that we're standing on. </p>
  519. </div>
  520. </div>
  521. <a id="ae8c2a236d46c2e362021c1ab3364c432" name="ae8c2a236d46c2e362021c1ab3364c432"></a>
  522. <h2 class="memtitle"><span class="permalink"><a href="#ae8c2a236d46c2e362021c1ab3364c432">&#9670;&#160;</a></span>GetGroundUserData()</h2>
  523. <div class="memitem">
  524. <div class="memproto">
  525. <table class="mlabels">
  526. <tr>
  527. <td class="mlabels-left">
  528. <table class="memname">
  529. <tr>
  530. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> CharacterBase::GetGroundUserData </td>
  531. <td>(</td>
  532. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  533. <td> const</td>
  534. </tr>
  535. </table>
  536. </td>
  537. <td class="mlabels-right">
  538. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  539. </tr>
  540. </table>
  541. </div><div class="memdoc">
  542. <p>User data value of the body that we're standing on. </p>
  543. </div>
  544. </div>
  545. <a id="a692578285569b48d19d53684360a5656" name="a692578285569b48d19d53684360a5656"></a>
  546. <h2 class="memtitle"><span class="permalink"><a href="#a692578285569b48d19d53684360a5656">&#9670;&#160;</a></span>GetGroundVelocity()</h2>
  547. <div class="memitem">
  548. <div class="memproto">
  549. <table class="mlabels">
  550. <tr>
  551. <td class="mlabels-left">
  552. <table class="memname">
  553. <tr>
  554. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterBase::GetGroundVelocity </td>
  555. <td>(</td>
  556. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  557. <td> const</td>
  558. </tr>
  559. </table>
  560. </td>
  561. <td class="mlabels-right">
  562. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  563. </tr>
  564. </table>
  565. </div><div class="memdoc">
  566. <p>Velocity in world space of ground. </p>
  567. </div>
  568. </div>
  569. <a id="afe046cfb3333be1fcb186f42821ddb19" name="afe046cfb3333be1fcb186f42821ddb19"></a>
  570. <h2 class="memtitle"><span class="permalink"><a href="#afe046cfb3333be1fcb186f42821ddb19">&#9670;&#160;</a></span>GetShape()</h2>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="mlabels">
  574. <tr>
  575. <td class="mlabels-left">
  576. <table class="memname">
  577. <tr>
  578. <td class="memname">const <a class="el" href="class_shape.html">Shape</a> * CharacterBase::GetShape </td>
  579. <td>(</td>
  580. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  581. <td> const</td>
  582. </tr>
  583. </table>
  584. </td>
  585. <td class="mlabels-right">
  586. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. <p>Get the current shape that the character is using. </p>
  591. </div>
  592. </div>
  593. <a id="a2a437049ade0a3ab8ab7aeafb64f5163" name="a2a437049ade0a3ab8ab7aeafb64f5163"></a>
  594. <h2 class="memtitle"><span class="permalink"><a href="#a2a437049ade0a3ab8ab7aeafb64f5163">&#9670;&#160;</a></span>GetUp()</h2>
  595. <div class="memitem">
  596. <div class="memproto">
  597. <table class="mlabels">
  598. <tr>
  599. <td class="mlabels-left">
  600. <table class="memname">
  601. <tr>
  602. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterBase::GetUp </td>
  603. <td>(</td>
  604. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  605. <td> const</td>
  606. </tr>
  607. </table>
  608. </td>
  609. <td class="mlabels-right">
  610. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  611. </tr>
  612. </table>
  613. </div><div class="memdoc">
  614. </div>
  615. </div>
  616. <a id="a87e7e3bcc174d5e498844dcac7f7f173" name="a87e7e3bcc174d5e498844dcac7f7f173"></a>
  617. <h2 class="memtitle"><span class="permalink"><a href="#a87e7e3bcc174d5e498844dcac7f7f173">&#9670;&#160;</a></span>IsSlopeTooSteep()</h2>
  618. <div class="memitem">
  619. <div class="memproto">
  620. <table class="mlabels">
  621. <tr>
  622. <td class="mlabels-left">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname">bool CharacterBase::IsSlopeTooSteep </td>
  626. <td>(</td>
  627. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inNormal</em></span></td><td>)</td>
  628. <td> const</td>
  629. </tr>
  630. </table>
  631. </td>
  632. <td class="mlabels-right">
  633. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  634. </tr>
  635. </table>
  636. </div><div class="memdoc">
  637. <p>Check if the normal of the ground surface is too steep to walk on. </p>
  638. </div>
  639. </div>
  640. <a id="a700e706b9c1710409fc16c6f9a083e0b" name="a700e706b9c1710409fc16c6f9a083e0b"></a>
  641. <h2 class="memtitle"><span class="permalink"><a href="#a700e706b9c1710409fc16c6f9a083e0b">&#9670;&#160;</a></span>IsSupported()</h2>
  642. <div class="memitem">
  643. <div class="memproto">
  644. <table class="mlabels">
  645. <tr>
  646. <td class="mlabels-left">
  647. <table class="memname">
  648. <tr>
  649. <td class="memname">bool CharacterBase::IsSupported </td>
  650. <td>(</td>
  651. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  652. <td> const</td>
  653. </tr>
  654. </table>
  655. </td>
  656. <td class="mlabels-right">
  657. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  658. </tr>
  659. </table>
  660. </div><div class="memdoc">
  661. <p>Returns true if the player is supported by normal or steep ground. </p>
  662. </div>
  663. </div>
  664. <a id="ad9d1540df7d44b3aaeee88a527df7d7d" name="ad9d1540df7d44b3aaeee88a527df7d7d"></a>
  665. <h2 class="memtitle"><span class="permalink"><a href="#ad9d1540df7d44b3aaeee88a527df7d7d">&#9670;&#160;</a></span>RestoreState()</h2>
  666. <div class="memitem">
  667. <div class="memproto">
  668. <table class="mlabels">
  669. <tr>
  670. <td class="mlabels-left">
  671. <table class="memname">
  672. <tr>
  673. <td class="memname">void CharacterBase::RestoreState </td>
  674. <td>(</td>
  675. <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>
  676. <td></td>
  677. </tr>
  678. </table>
  679. </td>
  680. <td class="mlabels-right">
  681. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  682. </tr>
  683. </table>
  684. </div><div class="memdoc">
  685. <p>Reimplemented in <a class="el" href="class_character_virtual.html#a34ce1577ff0641d5a326af721a3c9b71">CharacterVirtual</a>.</p>
  686. </div>
  687. </div>
  688. <a id="ab28f7afaa654cf8461f3638dd01334e0" name="ab28f7afaa654cf8461f3638dd01334e0"></a>
  689. <h2 class="memtitle"><span class="permalink"><a href="#ab28f7afaa654cf8461f3638dd01334e0">&#9670;&#160;</a></span>SaveState()</h2>
  690. <div class="memitem">
  691. <div class="memproto">
  692. <table class="mlabels">
  693. <tr>
  694. <td class="mlabels-left">
  695. <table class="memname">
  696. <tr>
  697. <td class="memname">void CharacterBase::SaveState </td>
  698. <td>(</td>
  699. <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>
  700. <td> const</td>
  701. </tr>
  702. </table>
  703. </td>
  704. <td class="mlabels-right">
  705. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  706. </tr>
  707. </table>
  708. </div><div class="memdoc">
  709. <p>Reimplemented in <a class="el" href="class_character_virtual.html#a4eec1547ca605d2556bf781237b40ee7">CharacterVirtual</a>.</p>
  710. </div>
  711. </div>
  712. <a id="a0c2099dfbf12c1bd6f839a3eda5c9726" name="a0c2099dfbf12c1bd6f839a3eda5c9726"></a>
  713. <h2 class="memtitle"><span class="permalink"><a href="#a0c2099dfbf12c1bd6f839a3eda5c9726">&#9670;&#160;</a></span>SetMaxSlopeAngle()</h2>
  714. <div class="memitem">
  715. <div class="memproto">
  716. <table class="mlabels">
  717. <tr>
  718. <td class="mlabels-left">
  719. <table class="memname">
  720. <tr>
  721. <td class="memname">void CharacterBase::SetMaxSlopeAngle </td>
  722. <td>(</td>
  723. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inMaxSlopeAngle</em></span></td><td>)</td>
  724. <td></td>
  725. </tr>
  726. </table>
  727. </td>
  728. <td class="mlabels-right">
  729. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  730. </tr>
  731. </table>
  732. </div><div class="memdoc">
  733. <p>Set the maximum angle of slope that character can still walk on (radians) </p>
  734. </div>
  735. </div>
  736. <a id="a46d5822b95a5e771adc1e33f1f9b891c" name="a46d5822b95a5e771adc1e33f1f9b891c"></a>
  737. <h2 class="memtitle"><span class="permalink"><a href="#a46d5822b95a5e771adc1e33f1f9b891c">&#9670;&#160;</a></span>SetUp()</h2>
  738. <div class="memitem">
  739. <div class="memproto">
  740. <table class="mlabels">
  741. <tr>
  742. <td class="mlabels-left">
  743. <table class="memname">
  744. <tr>
  745. <td class="memname">void CharacterBase::SetUp </td>
  746. <td>(</td>
  747. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inUp</em></span></td><td>)</td>
  748. <td></td>
  749. </tr>
  750. </table>
  751. </td>
  752. <td class="mlabels-right">
  753. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  754. </tr>
  755. </table>
  756. </div><div class="memdoc">
  757. <p>Set the up vector for the character. </p>
  758. </div>
  759. </div>
  760. <a id="a269b97a0088e3651387c10f350d792cd" name="a269b97a0088e3651387c10f350d792cd"></a>
  761. <h2 class="memtitle"><span class="permalink"><a href="#a269b97a0088e3651387c10f350d792cd">&#9670;&#160;</a></span>sToString()</h2>
  762. <div class="memitem">
  763. <div class="memproto">
  764. <table class="mlabels">
  765. <tr>
  766. <td class="mlabels-left">
  767. <table class="memname">
  768. <tr>
  769. <td class="memname">const char * CharacterBase::sToString </td>
  770. <td>(</td>
  771. <td class="paramtype"><a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">EGroundState</a></td> <td class="paramname"><span class="paramname"><em>inState</em></span></td><td>)</td>
  772. <td></td>
  773. </tr>
  774. </table>
  775. </td>
  776. <td class="mlabels-right">
  777. <span class="mlabels"><span class="mlabel">static</span></span> </td>
  778. </tr>
  779. </table>
  780. </div><div class="memdoc">
  781. <p>Debug function to convert enum values to string. </p>
  782. </div>
  783. </div>
  784. <h2 class="groupheader">Member Data Documentation</h2>
  785. <a id="a32bda1f36a6c2ba0eb1fec77dfcbb078" name="a32bda1f36a6c2ba0eb1fec77dfcbb078"></a>
  786. <h2 class="memtitle"><span class="permalink"><a href="#a32bda1f36a6c2ba0eb1fec77dfcbb078">&#9670;&#160;</a></span>cNoMaxSlopeAngle</h2>
  787. <div class="memitem">
  788. <div class="memproto">
  789. <table class="mlabels">
  790. <tr>
  791. <td class="mlabels-left">
  792. <table class="memname">
  793. <tr>
  794. <td class="memname">float CharacterBase::cNoMaxSlopeAngle = 0.9999f</td>
  795. </tr>
  796. </table>
  797. </td>
  798. <td class="mlabels-right">
  799. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span><span class="mlabel">protected</span></span> </td>
  800. </tr>
  801. </table>
  802. </div><div class="memdoc">
  803. </div>
  804. </div>
  805. <a id="a9da1e29d9257f3cce909487da437a0c9" name="a9da1e29d9257f3cce909487da437a0c9"></a>
  806. <h2 class="memtitle"><span class="permalink"><a href="#a9da1e29d9257f3cce909487da437a0c9">&#9670;&#160;</a></span>mCosMaxSlopeAngle</h2>
  807. <div class="memitem">
  808. <div class="memproto">
  809. <table class="mlabels">
  810. <tr>
  811. <td class="mlabels-left">
  812. <table class="memname">
  813. <tr>
  814. <td class="memname">float CharacterBase::mCosMaxSlopeAngle</td>
  815. </tr>
  816. </table>
  817. </td>
  818. <td class="mlabels-right">
  819. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  820. </tr>
  821. </table>
  822. </div><div class="memdoc">
  823. </div>
  824. </div>
  825. <a id="a893268ea23759f36ebe8e317a54afa7e" name="a893268ea23759f36ebe8e317a54afa7e"></a>
  826. <h2 class="memtitle"><span class="permalink"><a href="#a893268ea23759f36ebe8e317a54afa7e">&#9670;&#160;</a></span>mGroundBodyID</h2>
  827. <div class="memitem">
  828. <div class="memproto">
  829. <table class="mlabels">
  830. <tr>
  831. <td class="mlabels-left">
  832. <table class="memname">
  833. <tr>
  834. <td class="memname"><a class="el" href="class_body_i_d.html">BodyID</a> CharacterBase::mGroundBodyID</td>
  835. </tr>
  836. </table>
  837. </td>
  838. <td class="mlabels-right">
  839. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  840. </tr>
  841. </table>
  842. </div><div class="memdoc">
  843. </div>
  844. </div>
  845. <a id="afa16450cf4dc265231e0f616aa5eeec9" name="afa16450cf4dc265231e0f616aa5eeec9"></a>
  846. <h2 class="memtitle"><span class="permalink"><a href="#afa16450cf4dc265231e0f616aa5eeec9">&#9670;&#160;</a></span>mGroundBodySubShapeID</h2>
  847. <div class="memitem">
  848. <div class="memproto">
  849. <table class="mlabels">
  850. <tr>
  851. <td class="mlabels-left">
  852. <table class="memname">
  853. <tr>
  854. <td class="memname"><a class="el" href="class_sub_shape_i_d.html">SubShapeID</a> CharacterBase::mGroundBodySubShapeID</td>
  855. </tr>
  856. </table>
  857. </td>
  858. <td class="mlabels-right">
  859. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  860. </tr>
  861. </table>
  862. </div><div class="memdoc">
  863. </div>
  864. </div>
  865. <a id="a2586c1571ba8e5adc511d71f413de2c1" name="a2586c1571ba8e5adc511d71f413de2c1"></a>
  866. <h2 class="memtitle"><span class="permalink"><a href="#a2586c1571ba8e5adc511d71f413de2c1">&#9670;&#160;</a></span>mGroundMaterial</h2>
  867. <div class="memitem">
  868. <div class="memproto">
  869. <table class="mlabels">
  870. <tr>
  871. <td class="mlabels-left">
  872. <table class="memname">
  873. <tr>
  874. <td class="memname"><a class="el" href="class_ref_const.html">RefConst</a>&lt;<a class="el" href="class_physics_material.html">PhysicsMaterial</a>&gt; CharacterBase::mGroundMaterial = <a class="el" href="class_physics_material.html#af51825c643c3cafc49e007d8ca1c14cd">PhysicsMaterial::sDefault</a></td>
  875. </tr>
  876. </table>
  877. </td>
  878. <td class="mlabels-right">
  879. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  880. </tr>
  881. </table>
  882. </div><div class="memdoc">
  883. </div>
  884. </div>
  885. <a id="a3537f13f2e427573266d9f591f1aadf3" name="a3537f13f2e427573266d9f591f1aadf3"></a>
  886. <h2 class="memtitle"><span class="permalink"><a href="#a3537f13f2e427573266d9f591f1aadf3">&#9670;&#160;</a></span>mGroundNormal</h2>
  887. <div class="memitem">
  888. <div class="memproto">
  889. <table class="mlabels">
  890. <tr>
  891. <td class="mlabels-left">
  892. <table class="memname">
  893. <tr>
  894. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterBase::mGroundNormal = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td>
  895. </tr>
  896. </table>
  897. </td>
  898. <td class="mlabels-right">
  899. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  900. </tr>
  901. </table>
  902. </div><div class="memdoc">
  903. </div>
  904. </div>
  905. <a id="a2b9e9d8616bb0c7c8cb6ba59f5c7bf8a" name="a2b9e9d8616bb0c7c8cb6ba59f5c7bf8a"></a>
  906. <h2 class="memtitle"><span class="permalink"><a href="#a2b9e9d8616bb0c7c8cb6ba59f5c7bf8a">&#9670;&#160;</a></span>mGroundPosition</h2>
  907. <div class="memitem">
  908. <div class="memproto">
  909. <table class="mlabels">
  910. <tr>
  911. <td class="mlabels-left">
  912. <table class="memname">
  913. <tr>
  914. <td class="memname"><a class="el" href="_real_8h.html#ae088dda635fb0ba1c96ea179d384ca40">RVec3</a> CharacterBase::mGroundPosition = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">RVec3::sZero</a>()</td>
  915. </tr>
  916. </table>
  917. </td>
  918. <td class="mlabels-right">
  919. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  920. </tr>
  921. </table>
  922. </div><div class="memdoc">
  923. </div>
  924. </div>
  925. <a id="a1cf96842849baa268527dfa548219510" name="a1cf96842849baa268527dfa548219510"></a>
  926. <h2 class="memtitle"><span class="permalink"><a href="#a1cf96842849baa268527dfa548219510">&#9670;&#160;</a></span>mGroundState</h2>
  927. <div class="memitem">
  928. <div class="memproto">
  929. <table class="mlabels">
  930. <tr>
  931. <td class="mlabels-left">
  932. <table class="memname">
  933. <tr>
  934. <td class="memname"><a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77e">EGroundState</a> CharacterBase::mGroundState = <a class="el" href="#a82dfb80348cdbf3a08f97d54b225f77eaee4e669a07b061d70b9b79dfed9cb5e7">EGroundState::InAir</a></td>
  935. </tr>
  936. </table>
  937. </td>
  938. <td class="mlabels-right">
  939. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  940. </tr>
  941. </table>
  942. </div><div class="memdoc">
  943. </div>
  944. </div>
  945. <a id="acf9a8bdf6fa420d9615206d196794135" name="acf9a8bdf6fa420d9615206d196794135"></a>
  946. <h2 class="memtitle"><span class="permalink"><a href="#acf9a8bdf6fa420d9615206d196794135">&#9670;&#160;</a></span>mGroundUserData</h2>
  947. <div class="memitem">
  948. <div class="memproto">
  949. <table class="mlabels">
  950. <tr>
  951. <td class="mlabels-left">
  952. <table class="memname">
  953. <tr>
  954. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> CharacterBase::mGroundUserData = 0</td>
  955. </tr>
  956. </table>
  957. </td>
  958. <td class="mlabels-right">
  959. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  960. </tr>
  961. </table>
  962. </div><div class="memdoc">
  963. </div>
  964. </div>
  965. <a id="add543ae2333820dbf77e23009dfe4367" name="add543ae2333820dbf77e23009dfe4367"></a>
  966. <h2 class="memtitle"><span class="permalink"><a href="#add543ae2333820dbf77e23009dfe4367">&#9670;&#160;</a></span>mGroundVelocity</h2>
  967. <div class="memitem">
  968. <div class="memproto">
  969. <table class="mlabels">
  970. <tr>
  971. <td class="mlabels-left">
  972. <table class="memname">
  973. <tr>
  974. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterBase::mGroundVelocity = <a class="el" href="class_vec3.html#ad03c52ab27761bc1e64e33c47632ba51">Vec3::sZero</a>()</td>
  975. </tr>
  976. </table>
  977. </td>
  978. <td class="mlabels-right">
  979. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  980. </tr>
  981. </table>
  982. </div><div class="memdoc">
  983. </div>
  984. </div>
  985. <a id="a5c10220e06a8a5bb274a4b02c28cb0b6" name="a5c10220e06a8a5bb274a4b02c28cb0b6"></a>
  986. <h2 class="memtitle"><span class="permalink"><a href="#a5c10220e06a8a5bb274a4b02c28cb0b6">&#9670;&#160;</a></span>mShape</h2>
  987. <div class="memitem">
  988. <div class="memproto">
  989. <table class="mlabels">
  990. <tr>
  991. <td class="mlabels-left">
  992. <table class="memname">
  993. <tr>
  994. <td class="memname"><a class="el" href="class_ref_const.html">RefConst</a>&lt;<a class="el" href="class_shape.html">Shape</a>&gt; CharacterBase::mShape</td>
  995. </tr>
  996. </table>
  997. </td>
  998. <td class="mlabels-right">
  999. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  1000. </tr>
  1001. </table>
  1002. </div><div class="memdoc">
  1003. </div>
  1004. </div>
  1005. <a id="ae9fb45e5980787c5f7f718f6e7703797" name="ae9fb45e5980787c5f7f718f6e7703797"></a>
  1006. <h2 class="memtitle"><span class="permalink"><a href="#ae9fb45e5980787c5f7f718f6e7703797">&#9670;&#160;</a></span>mSupportingVolume</h2>
  1007. <div class="memitem">
  1008. <div class="memproto">
  1009. <table class="mlabels">
  1010. <tr>
  1011. <td class="mlabels-left">
  1012. <table class="memname">
  1013. <tr>
  1014. <td class="memname"><a class="el" href="class_plane.html">Plane</a> CharacterBase::mSupportingVolume</td>
  1015. </tr>
  1016. </table>
  1017. </td>
  1018. <td class="mlabels-right">
  1019. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  1020. </tr>
  1021. </table>
  1022. </div><div class="memdoc">
  1023. </div>
  1024. </div>
  1025. <a id="ac6c3f8f7a2492d0c0f2eac85a9cc5a01" name="ac6c3f8f7a2492d0c0f2eac85a9cc5a01"></a>
  1026. <h2 class="memtitle"><span class="permalink"><a href="#ac6c3f8f7a2492d0c0f2eac85a9cc5a01">&#9670;&#160;</a></span>mSystem</h2>
  1027. <div class="memitem">
  1028. <div class="memproto">
  1029. <table class="mlabels">
  1030. <tr>
  1031. <td class="mlabels-left">
  1032. <table class="memname">
  1033. <tr>
  1034. <td class="memname"><a class="el" href="class_physics_system.html">PhysicsSystem</a>* CharacterBase::mSystem</td>
  1035. </tr>
  1036. </table>
  1037. </td>
  1038. <td class="mlabels-right">
  1039. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  1040. </tr>
  1041. </table>
  1042. </div><div class="memdoc">
  1043. </div>
  1044. </div>
  1045. <a id="a5f637f449a17fb6a1b10297764de48b4" name="a5f637f449a17fb6a1b10297764de48b4"></a>
  1046. <h2 class="memtitle"><span class="permalink"><a href="#a5f637f449a17fb6a1b10297764de48b4">&#9670;&#160;</a></span>mUp</h2>
  1047. <div class="memitem">
  1048. <div class="memproto">
  1049. <table class="mlabels">
  1050. <tr>
  1051. <td class="mlabels-left">
  1052. <table class="memname">
  1053. <tr>
  1054. <td class="memname"><a class="el" href="class_vec3.html">Vec3</a> CharacterBase::mUp</td>
  1055. </tr>
  1056. </table>
  1057. </td>
  1058. <td class="mlabels-right">
  1059. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  1060. </tr>
  1061. </table>
  1062. </div><div class="memdoc">
  1063. </div>
  1064. </div>
  1065. <hr/>The documentation for this class was generated from the following files:<ul>
  1066. <li>Jolt/Physics/Character/<a class="el" href="_character_base_8h_source.html">CharacterBase.h</a></li>
  1067. <li>Jolt/Physics/Character/<a class="el" href="_character_base_8cpp.html">CharacterBase.cpp</a></li>
  1068. </ul>
  1069. </div><!-- contents -->
  1070. </div><!-- doc-content -->
  1071. <!-- start footer part -->
  1072. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  1073. <ul>
  1074. <li class="navelem"><a class="el" href="class_character_base.html">CharacterBase</a></li>
  1075. <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>
  1076. </ul>
  1077. </div>
  1078. </body>
  1079. </html>