class_character_settings.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  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: CharacterSettings 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_settings.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="class_character_settings-members.html">List of all members</a> </div>
  110. <div class="headertitle"><div class="title">CharacterSettings Class Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p>Contains the configuration of a character.
  114. <a href="#details">More...</a></p>
  115. <p><code>#include &lt;<a class="el" href="_character_8h_source.html">Character.h</a>&gt;</code></p>
  116. <div class="dynheader">
  117. Inheritance diagram for CharacterSettings:</div>
  118. <div class="dyncontent">
  119. <div class="center">
  120. <img src="class_character_settings.png" usemap="#CharacterSettings_map" alt=""/>
  121. <map id="CharacterSettings_map" name="CharacterSettings_map">
  122. <area href="class_character_base_settings.html" title="Base class for configuration of a character." alt="CharacterBaseSettings" shape="rect" coords="0,56,220,80"/>
  123. <area href="class_ref_target.html" alt="RefTarget&lt; CharacterBaseSettings &gt;" shape="rect" coords="0,0,220,24"/>
  124. </map>
  125. </div></div>
  126. <table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  128. Public Member Functions</h2></td></tr>
  129. <tr class="memitem:a3f3c37a73d298c3d162b518678c0751e" id="r_a3f3c37a73d298c3d162b518678c0751e"><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="#a3f3c37a73d298c3d162b518678c0751e">CharacterSettings</a> ()=default</td></tr>
  130. <tr class="memdesc:a3f3c37a73d298c3d162b518678c0751e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  131. <tr class="separator:a3f3c37a73d298c3d162b518678c0751e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a2788b897c42c9f1772c4764318890893" id="r_a2788b897c42c9f1772c4764318890893"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2788b897c42c9f1772c4764318890893">CharacterSettings</a> (const <a class="el" href="class_character_settings.html">CharacterSettings</a> &amp;)=default</td></tr>
  133. <tr class="separator:a2788b897c42c9f1772c4764318890893"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a17ee80eafd03041a3f6a133f8180be9e" id="r_a17ee80eafd03041a3f6a133f8180be9e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_character_settings.html">CharacterSettings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a17ee80eafd03041a3f6a133f8180be9e">operator=</a> (const <a class="el" href="class_character_settings.html">CharacterSettings</a> &amp;)=default</td></tr>
  135. <tr class="separator:a17ee80eafd03041a3f6a133f8180be9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="inherit_header pub_methods_class_character_base_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_character_base_settings')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_character_base_settings.html">CharacterBaseSettings</a></td></tr>
  137. <tr class="memitem:aef4e52d5c83775b714f3c6f545ab032b inherit pub_methods_class_character_base_settings" id="r_aef4e52d5c83775b714f3c6f545ab032b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_base_settings.html#aef4e52d5c83775b714f3c6f545ab032b">CharacterBaseSettings</a> ()=default</td></tr>
  138. <tr class="memdesc:aef4e52d5c83775b714f3c6f545ab032b inherit pub_methods_class_character_base_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  139. <tr class="separator:aef4e52d5c83775b714f3c6f545ab032b inherit pub_methods_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:ae8b3fef2980ae246fe9560c0a29dac8f inherit pub_methods_class_character_base_settings" id="r_ae8b3fef2980ae246fe9560c0a29dac8f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_base_settings.html#ae8b3fef2980ae246fe9560c0a29dac8f">CharacterBaseSettings</a> (const <a class="el" href="class_character_base_settings.html">CharacterBaseSettings</a> &amp;)=default</td></tr>
  141. <tr class="separator:ae8b3fef2980ae246fe9560c0a29dac8f inherit pub_methods_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a95875f7606ab4eaed1259b237cfb22d3 inherit pub_methods_class_character_base_settings" id="r_a95875f7606ab4eaed1259b237cfb22d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_character_base_settings.html">CharacterBaseSettings</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_base_settings.html#a95875f7606ab4eaed1259b237cfb22d3">operator=</a> (const <a class="el" href="class_character_base_settings.html">CharacterBaseSettings</a> &amp;)=default</td></tr>
  143. <tr class="separator:a95875f7606ab4eaed1259b237cfb22d3 inherit pub_methods_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:adf1f42bae7e622c2c3a0ae2273f6f5f5 inherit pub_methods_class_character_base_settings" id="r_adf1f42bae7e622c2c3a0ae2273f6f5f5"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_base_settings.html#adf1f42bae7e622c2c3a0ae2273f6f5f5">~CharacterBaseSettings</a> ()=default</td></tr>
  145. <tr class="memdesc:adf1f42bae7e622c2c3a0ae2273f6f5f5 inherit pub_methods_class_character_base_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br /></td></tr>
  146. <tr class="separator:adf1f42bae7e622c2c3a0ae2273f6f5f5 inherit pub_methods_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <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; CharacterBaseSettings &gt;</a></td></tr>
  148. <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>
  149. <tr class="memdesc:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br /></td></tr>
  150. <tr class="separator:a4c8a23738e2e1dd6369520a30e250b17 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <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>
  152. <tr class="separator:a50444e3b659c6f93c64aee224a93f6ab inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <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>
  154. <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>
  155. <tr class="separator:ac3110b9f511287f881d7afaf26871e1b inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <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>
  157. <tr class="separator:a3befa746ea517453572f6f4f5fc3b099 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <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>
  159. <tr class="memdesc:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <br /></td></tr>
  160. <tr class="separator:a1fc15bfe979bc43a7fa71c7c34f87ed0 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <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>
  162. <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>
  163. <tr class="separator:acaf07366183c51cd8460c7d3dcd07c2d inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <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>
  165. <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>
  166. <tr class="separator:acf02c18a343bc9de9d6afb7c966f0363 inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <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>
  168. <tr class="separator:a0451661dd5d85b01f969319e767993eb inherit pub_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. </table><table class="memberdecls">
  170. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  171. Public Attributes</h2></td></tr>
  172. <tr class="memitem:ad05a2cd688dd3c1acb0599c55ede2544" id="r_ad05a2cd688dd3c1acb0599c55ede2544"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_object_layer_8h.html#a960eb396e2803ddad87bf25e0dcb4470">ObjectLayer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad05a2cd688dd3c1acb0599c55ede2544">mLayer</a> = 0</td></tr>
  173. <tr class="memdesc:ad05a2cd688dd3c1acb0599c55ede2544"><td class="mdescLeft">&#160;</td><td class="mdescRight">Layer that this character will be added to. <br /></td></tr>
  174. <tr class="separator:ad05a2cd688dd3c1acb0599c55ede2544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a9d6fa4613227caf468f618e34011e657" id="r_a9d6fa4613227caf468f618e34011e657"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9d6fa4613227caf468f618e34011e657">mMass</a> = 80.0f</td></tr>
  176. <tr class="memdesc:a9d6fa4613227caf468f618e34011e657"><td class="mdescLeft">&#160;</td><td class="mdescRight">Mass of the character. <br /></td></tr>
  177. <tr class="separator:a9d6fa4613227caf468f618e34011e657"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:ae969662f5e8bf47dc1837922dc80aa85" id="r_ae969662f5e8bf47dc1837922dc80aa85"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae969662f5e8bf47dc1837922dc80aa85">mFriction</a> = 0.2f</td></tr>
  179. <tr class="memdesc:ae969662f5e8bf47dc1837922dc80aa85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Friction for the character. <br /></td></tr>
  180. <tr class="separator:ae969662f5e8bf47dc1837922dc80aa85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a3110e7b55981e0764c21c67351cb2115" id="r_a3110e7b55981e0764c21c67351cb2115"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3110e7b55981e0764c21c67351cb2115">mGravityFactor</a> = 1.0f</td></tr>
  182. <tr class="memdesc:a3110e7b55981e0764c21c67351cb2115"><td class="mdescLeft">&#160;</td><td class="mdescRight">Value to multiply gravity with for this character. <br /></td></tr>
  183. <tr class="separator:a3110e7b55981e0764c21c67351cb2115"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:adfe4165c853a06d8f1109cf36be5295b" id="r_adfe4165c853a06d8f1109cf36be5295b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913">EAllowedDOFs</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#adfe4165c853a06d8f1109cf36be5295b">mAllowedDOFs</a> = <a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913adf25457a4acbb8220b36cbd34903fc06">EAllowedDOFs::TranslationX</a> | <a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913a5958d0bb6455dfb87376b3c24eeb9a46">EAllowedDOFs::TranslationY</a> | <a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913a7eac98e7f2c74960a4aa9a2a92a8874d">EAllowedDOFs::TranslationZ</a></td></tr>
  185. <tr class="memdesc:adfe4165c853a06d8f1109cf36be5295b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allowed degrees of freedom for this character. <br /></td></tr>
  186. <tr class="separator:adfe4165c853a06d8f1109cf36be5295b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="inherit_header pub_attribs_class_character_base_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_character_base_settings')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_character_base_settings.html">CharacterBaseSettings</a></td></tr>
  188. <tr class="memitem:a97272d417a1fa07e4c9c6213e7d5c291 inherit pub_attribs_class_character_base_settings" id="r_a97272d417a1fa07e4c9c6213e7d5c291"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_base_settings.html#a97272d417a1fa07e4c9c6213e7d5c291">mUp</a> = <a class="el" href="class_vec3.html#a2819718744feddb0bc150c6ccc26fad1">Vec3::sAxisY</a>()</td></tr>
  189. <tr class="memdesc:a97272d417a1fa07e4c9c6213e7d5c291 inherit pub_attribs_class_character_base_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_vector.html" title="Templatized vector class.">Vector</a> indicating the up direction of the character. <br /></td></tr>
  190. <tr class="separator:a97272d417a1fa07e4c9c6213e7d5c291 inherit pub_attribs_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:a31c6c2f0de04f45c657b0932319b6bfb inherit pub_attribs_class_character_base_settings" id="r_a31c6c2f0de04f45c657b0932319b6bfb"><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="class_character_base_settings.html#a31c6c2f0de04f45c657b0932319b6bfb">mSupportingVolume</a> { <a class="el" href="class_vec3.html#a2819718744feddb0bc150c6ccc26fad1">Vec3::sAxisY</a>(), -1.0e10f }</td></tr>
  192. <tr class="separator:a31c6c2f0de04f45c657b0932319b6bfb inherit pub_attribs_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a6daeb1476d88ee8f13118e85a9c07b67 inherit pub_attribs_class_character_base_settings" id="r_a6daeb1476d88ee8f13118e85a9c07b67"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_base_settings.html#a6daeb1476d88ee8f13118e85a9c07b67">mMaxSlopeAngle</a> = <a class="el" href="_math_8h.html#a636689581f2a6ce1d3030dc4dd83b2f5">DegreesToRadians</a>(50.0f)</td></tr>
  194. <tr class="memdesc:a6daeb1476d88ee8f13118e85a9c07b67 inherit pub_attribs_class_character_base_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum angle of slope that character can still walk on (radians). <br /></td></tr>
  195. <tr class="separator:a6daeb1476d88ee8f13118e85a9c07b67 inherit pub_attribs_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:a203e7cb826ccd98d6f3551f2aa198ee3 inherit pub_attribs_class_character_base_settings" id="r_a203e7cb826ccd98d6f3551f2aa198ee3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_character_base_settings.html#a203e7cb826ccd98d6f3551f2aa198ee3">mEnhancedInternalEdgeRemoval</a> = false</td></tr>
  197. <tr class="memdesc:a203e7cb826ccd98d6f3551f2aa198ee3 inherit pub_attribs_class_character_base_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set to indicate that extra effort should be made to try to remove ghost contacts (collisions with internal edges of a mesh). This is more expensive but makes bodies move smoother over a mesh with convex edges. <br /></td></tr>
  198. <tr class="separator:a203e7cb826ccd98d6f3551f2aa198ee3 inherit pub_attribs_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:aee9be06866efe751ab7e2df57edee6b1 inherit pub_attribs_class_character_base_settings" id="r_aee9be06866efe751ab7e2df57edee6b1"><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="class_character_base_settings.html#aee9be06866efe751ab7e2df57edee6b1">mShape</a></td></tr>
  200. <tr class="separator:aee9be06866efe751ab7e2df57edee6b1 inherit pub_attribs_class_character_base_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. </table><table class="memberdecls">
  202. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  203. Additional Inherited Members</h2></td></tr>
  204. <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; CharacterBaseSettings &gt;</a></td></tr>
  205. <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>
  206. <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>
  207. <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. <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; CharacterBaseSettings &gt;</a></td></tr>
  209. <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>
  210. <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count. <br /></td></tr>
  211. <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <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; CharacterBaseSettings &gt;</a></td></tr>
  213. <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>
  214. <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>
  215. <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. </table>
  217. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  218. <div class="textblock"><p>Contains the configuration of a character. </p>
  219. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  220. <a id="a3f3c37a73d298c3d162b518678c0751e" name="a3f3c37a73d298c3d162b518678c0751e"></a>
  221. <h2 class="memtitle"><span class="permalink"><a href="#a3f3c37a73d298c3d162b518678c0751e">&#9670;&#160;</a></span>CharacterSettings() <span class="overload">[1/2]</span></h2>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <table class="mlabels">
  225. <tr>
  226. <td class="mlabels-left">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> CharacterSettings::CharacterSettings </td>
  230. <td>(</td>
  231. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  232. <td></td>
  233. </tr>
  234. </table>
  235. </td>
  236. <td class="mlabels-right">
  237. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  238. </tr>
  239. </table>
  240. </div><div class="memdoc">
  241. <p>Constructor. </p>
  242. </div>
  243. </div>
  244. <a id="a2788b897c42c9f1772c4764318890893" name="a2788b897c42c9f1772c4764318890893"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#a2788b897c42c9f1772c4764318890893">&#9670;&#160;</a></span>CharacterSettings() <span class="overload">[2/2]</span></h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">CharacterSettings::CharacterSettings </td>
  254. <td>(</td>
  255. <td class="paramtype">const <a class="el" href="class_character_settings.html">CharacterSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  256. <td></td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. </div>
  266. </div>
  267. <h2 class="groupheader">Member Function Documentation</h2>
  268. <a id="a17ee80eafd03041a3f6a133f8180be9e" name="a17ee80eafd03041a3f6a133f8180be9e"></a>
  269. <h2 class="memtitle"><span class="permalink"><a href="#a17ee80eafd03041a3f6a133f8180be9e">&#9670;&#160;</a></span>operator=()</h2>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <table class="mlabels">
  273. <tr>
  274. <td class="mlabels-left">
  275. <table class="memname">
  276. <tr>
  277. <td class="memname"><a class="el" href="class_character_settings.html">CharacterSettings</a> &amp; CharacterSettings::operator= </td>
  278. <td>(</td>
  279. <td class="paramtype">const <a class="el" href="class_character_settings.html">CharacterSettings</a> &amp;</td> <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  280. <td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. </div>
  290. </div>
  291. <h2 class="groupheader">Member Data Documentation</h2>
  292. <a id="adfe4165c853a06d8f1109cf36be5295b" name="adfe4165c853a06d8f1109cf36be5295b"></a>
  293. <h2 class="memtitle"><span class="permalink"><a href="#adfe4165c853a06d8f1109cf36be5295b">&#9670;&#160;</a></span>mAllowedDOFs</h2>
  294. <div class="memitem">
  295. <div class="memproto">
  296. <table class="memname">
  297. <tr>
  298. <td class="memname"><a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913">EAllowedDOFs</a> CharacterSettings::mAllowedDOFs = <a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913adf25457a4acbb8220b36cbd34903fc06">EAllowedDOFs::TranslationX</a> | <a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913a5958d0bb6455dfb87376b3c24eeb9a46">EAllowedDOFs::TranslationY</a> | <a class="el" href="_allowed_d_o_fs_8h.html#a47bc570d6b4f457c417078ebab07d913a7eac98e7f2c74960a4aa9a2a92a8874d">EAllowedDOFs::TranslationZ</a></td>
  299. </tr>
  300. </table>
  301. </div><div class="memdoc">
  302. <p>Allowed degrees of freedom for this character. </p>
  303. </div>
  304. </div>
  305. <a id="ae969662f5e8bf47dc1837922dc80aa85" name="ae969662f5e8bf47dc1837922dc80aa85"></a>
  306. <h2 class="memtitle"><span class="permalink"><a href="#ae969662f5e8bf47dc1837922dc80aa85">&#9670;&#160;</a></span>mFriction</h2>
  307. <div class="memitem">
  308. <div class="memproto">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">float CharacterSettings::mFriction = 0.2f</td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Friction for the character. </p>
  316. </div>
  317. </div>
  318. <a id="a3110e7b55981e0764c21c67351cb2115" name="a3110e7b55981e0764c21c67351cb2115"></a>
  319. <h2 class="memtitle"><span class="permalink"><a href="#a3110e7b55981e0764c21c67351cb2115">&#9670;&#160;</a></span>mGravityFactor</h2>
  320. <div class="memitem">
  321. <div class="memproto">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">float CharacterSettings::mGravityFactor = 1.0f</td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <p>Value to multiply gravity with for this character. </p>
  329. </div>
  330. </div>
  331. <a id="ad05a2cd688dd3c1acb0599c55ede2544" name="ad05a2cd688dd3c1acb0599c55ede2544"></a>
  332. <h2 class="memtitle"><span class="permalink"><a href="#ad05a2cd688dd3c1acb0599c55ede2544">&#9670;&#160;</a></span>mLayer</h2>
  333. <div class="memitem">
  334. <div class="memproto">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname"><a class="el" href="_object_layer_8h.html#a960eb396e2803ddad87bf25e0dcb4470">ObjectLayer</a> CharacterSettings::mLayer = 0</td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. <p>Layer that this character will be added to. </p>
  342. </div>
  343. </div>
  344. <a id="a9d6fa4613227caf468f618e34011e657" name="a9d6fa4613227caf468f618e34011e657"></a>
  345. <h2 class="memtitle"><span class="permalink"><a href="#a9d6fa4613227caf468f618e34011e657">&#9670;&#160;</a></span>mMass</h2>
  346. <div class="memitem">
  347. <div class="memproto">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">float CharacterSettings::mMass = 80.0f</td>
  351. </tr>
  352. </table>
  353. </div><div class="memdoc">
  354. <p>Mass of the character. </p>
  355. </div>
  356. </div>
  357. <hr/>The documentation for this class was generated from the following file:<ul>
  358. <li>Jolt/Physics/Character/<a class="el" href="_character_8h_source.html">Character.h</a></li>
  359. </ul>
  360. </div><!-- contents -->
  361. </div><!-- doc-content -->
  362. <!-- start footer part -->
  363. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  364. <ul>
  365. <li class="navelem"><a class="el" href="class_character_settings.html">CharacterSettings</a></li>
  366. <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>
  367. </ul>
  368. </div>
  369. </body>
  370. </html>