class_plane_shape_settings.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  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: PlaneShapeSettings 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_plane_shape_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="#pub-static-attribs">Static Public Attributes</a> &#124;
  110. <a href="class_plane_shape_settings-members.html">List of all members</a> </div>
  111. <div class="headertitle"><div class="title">PlaneShapeSettings Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
  112. </div><!--header-->
  113. <div class="contents">
  114. <p>Class that constructs a <a class="el" href="class_plane_shape.html">PlaneShape</a>.
  115. <a href="#details">More...</a></p>
  116. <p><code>#include &lt;<a class="el" href="_plane_shape_8h_source.html">PlaneShape.h</a>&gt;</code></p>
  117. <div class="dynheader">
  118. Inheritance diagram for PlaneShapeSettings:</div>
  119. <div class="dyncontent">
  120. <div class="center">
  121. <img src="class_plane_shape_settings.png" usemap="#PlaneShapeSettings_map" alt=""/>
  122. <map id="PlaneShapeSettings_map" name="PlaneShapeSettings_map">
  123. <area href="class_shape_settings.html" alt="ShapeSettings" shape="rect" coords="90,56,261,80"/>
  124. <area href="class_serializable_object.html" alt="SerializableObject" shape="rect" coords="0,0,171,24"/>
  125. <area href="class_ref_target.html" alt="RefTarget&lt; ShapeSettings &gt;" shape="rect" coords="181,0,352,24"/>
  126. </map>
  127. </div></div>
  128. <table class="memberdecls">
  129. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  130. Public Member Functions</h2></td></tr>
  131. <tr class="memitem:a666082ced89b84d2f8dcf2a3df7de6de" id="r_a666082ced89b84d2f8dcf2a3df7de6de"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a666082ced89b84d2f8dcf2a3df7de6de">PlaneShapeSettings</a> ()=default</td></tr>
  132. <tr class="memdesc:a666082ced89b84d2f8dcf2a3df7de6de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor for deserialization. <br /></td></tr>
  133. <tr class="separator:a666082ced89b84d2f8dcf2a3df7de6de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a33dae2d759e796b2d454711b37da6730" id="r_a33dae2d759e796b2d454711b37da6730"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a33dae2d759e796b2d454711b37da6730">PlaneShapeSettings</a> (const <a class="el" href="class_plane.html">Plane</a> &amp;inPlane, const <a class="el" href="class_physics_material.html">PhysicsMaterial</a> *inMaterial=nullptr, float inHalfExtent=<a class="el" href="#a581671fd5f17403723d905d380114533">cDefaultHalfExtent</a>)</td></tr>
  135. <tr class="memdesc:a33dae2d759e796b2d454711b37da6730"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a plane shape. <br /></td></tr>
  136. <tr class="separator:a33dae2d759e796b2d454711b37da6730"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a988344346e7e5bf5253ea56c7b79ee59" id="r_a988344346e7e5bf5253ea56c7b79ee59"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_shape_settings.html#a8573ddc7722fadfc12bb16515d77254a">ShapeResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a988344346e7e5bf5253ea56c7b79ee59">Create</a> () const override</td></tr>
  138. <tr class="memdesc:a988344346e7e5bf5253ea56c7b79ee59"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a shape according to the settings specified by this object. <br /></td></tr>
  139. <tr class="separator:a988344346e7e5bf5253ea56c7b79ee59"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="inherit_header pub_methods_class_shape_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_shape_settings')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_shape_settings.html">ShapeSettings</a></td></tr>
  141. <tr class="memitem:aa965a759e6c4cbc43ebf0aa8bd1f2d30 inherit pub_methods_class_shape_settings" id="r_aa965a759e6c4cbc43ebf0aa8bd1f2d30"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shape_settings.html#aa965a759e6c4cbc43ebf0aa8bd1f2d30">ClearCachedResult</a> ()</td></tr>
  142. <tr class="separator:aa965a759e6c4cbc43ebf0aa8bd1f2d30 inherit pub_methods_class_shape_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="inherit_header pub_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_serializable_object')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
  144. <tr class="memitem:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object" id="r_afad98c73b77e9cef11cf5083a5866d49"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#afad98c73b77e9cef11cf5083a5866d49">~SerializableObject</a> ()=default</td></tr>
  145. <tr class="memdesc:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
  146. <tr class="separator:afad98c73b77e9cef11cf5083a5866d49 inherit pub_methods_class_serializable_object"><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; ShapeSettings &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:a0eb3d51eb7d3aaf41d1156f138f3cfb6" id="r_a0eb3d51eb7d3aaf41d1156f138f3cfb6"><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="#a0eb3d51eb7d3aaf41d1156f138f3cfb6">mPlane</a></td></tr>
  173. <tr class="memdesc:a0eb3d51eb7d3aaf41d1156f138f3cfb6"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_plane.html" title="An infinite plane described by the formula X . Normal + Constant = 0.">Plane</a> that describes the shape. The negative half space is considered solid. <br /></td></tr>
  174. <tr class="separator:a0eb3d51eb7d3aaf41d1156f138f3cfb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a40e64ab3f0d0a8079c57af69298873e8" id="r_a40e64ab3f0d0a8079c57af69298873e8"><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="#a40e64ab3f0d0a8079c57af69298873e8">mMaterial</a></td></tr>
  176. <tr class="memdesc:a40e64ab3f0d0a8079c57af69298873e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Surface material of the plane. <br /></td></tr>
  177. <tr class="separator:a40e64ab3f0d0a8079c57af69298873e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  178. <tr class="memitem:a3a23d6998fdb06983bfeb395a366c88c" id="r_a3a23d6998fdb06983bfeb395a366c88c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3a23d6998fdb06983bfeb395a366c88c">mHalfExtent</a> = <a class="el" href="#a581671fd5f17403723d905d380114533">cDefaultHalfExtent</a></td></tr>
  179. <tr class="memdesc:a3a23d6998fdb06983bfeb395a366c88c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The bounding box of this plane will run from [-half_extent, half_extent]. Keep this as low as possible for better broad phase performance. <br /></td></tr>
  180. <tr class="separator:a3a23d6998fdb06983bfeb395a366c88c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="inherit_header pub_attribs_class_shape_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_attribs_class_shape_settings')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_shape_settings.html">ShapeSettings</a></td></tr>
  182. <tr class="memitem:acd32835291c84d23e49c15194c1b0424 inherit pub_attribs_class_shape_settings" id="r_acd32835291c84d23e49c15194c1b0424"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shape_settings.html#acd32835291c84d23e49c15194c1b0424">mUserData</a> = 0</td></tr>
  183. <tr class="memdesc:acd32835291c84d23e49c15194c1b0424 inherit pub_attribs_class_shape_settings"><td class="mdescLeft">&#160;</td><td class="mdescRight">User data (to be used freely by the application) <br /></td></tr>
  184. <tr class="separator:acd32835291c84d23e49c15194c1b0424 inherit pub_attribs_class_shape_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. </table><table class="memberdecls">
  186. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
  187. Static Public Attributes</h2></td></tr>
  188. <tr class="memitem:a581671fd5f17403723d905d380114533" id="r_a581671fd5f17403723d905d380114533"><td class="memItemLeft" align="right" valign="top">static constexpr float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a581671fd5f17403723d905d380114533">cDefaultHalfExtent</a> = 1000.0f</td></tr>
  189. <tr class="memdesc:a581671fd5f17403723d905d380114533"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default half-extent of the plane (total size along 1 axis will be 2 * half-extent) <br /></td></tr>
  190. <tr class="separator:a581671fd5f17403723d905d380114533"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. </table><table class="memberdecls">
  192. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="inherited" name="inherited"></a>
  193. Additional Inherited Members</h2></td></tr>
  194. <tr class="inherit_header pub_types_class_shape_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_types_class_shape_settings')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="class_shape_settings.html">ShapeSettings</a></td></tr>
  195. <tr class="memitem:a8573ddc7722fadfc12bb16515d77254a inherit pub_types_class_shape_settings" id="r_a8573ddc7722fadfc12bb16515d77254a"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shape_settings.html#a8573ddc7722fadfc12bb16515d77254a">ShapeResult</a> = <a class="el" href="class_result.html">Result</a>&lt;<a class="el" href="class_ref.html">Ref</a>&lt;<a class="el" href="class_shape.html">Shape</a>&gt;&gt;</td></tr>
  196. <tr class="separator:a8573ddc7722fadfc12bb16515d77254a inherit pub_types_class_shape_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <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; ShapeSettings &gt;</a></td></tr>
  198. <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>
  199. <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>
  200. <tr class="separator:a58b5a94748691b18ecf651ce918ae743 inherit pub_static_methods_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="inherit_header pro_methods_class_serializable_object"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_methods_class_serializable_object')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="class_serializable_object.html">SerializableObject</a></td></tr>
  202. <tr class="memitem:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object" id="r_a17ef2cfabac970a7b97b3dc75fa06eee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a17ef2cfabac970a7b97b3dc75fa06eee">SerializableObject</a> ()=default</td></tr>
  203. <tr class="memdesc:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="mdescLeft">&#160;</td><td class="mdescRight">Don't allow (copy) constructing this base class, but allow derived classes to (copy) construct themselves. <br /></td></tr>
  204. <tr class="separator:a17ef2cfabac970a7b97b3dc75fa06eee inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object" id="r_aaf09b99b1dcfe726a392cfa2f9e2b3eb"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#aaf09b99b1dcfe726a392cfa2f9e2b3eb">SerializableObject</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &amp;)=default</td></tr>
  206. <tr class="separator:aaf09b99b1dcfe726a392cfa2f9e2b3eb inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object" id="r_a2e1b9e7dda273bacf82f2708c9f8537a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_serializable_object.html">SerializableObject</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_serializable_object.html#a2e1b9e7dda273bacf82f2708c9f8537a">operator=</a> (const <a class="el" href="class_serializable_object.html">SerializableObject</a> &amp;)=default</td></tr>
  208. <tr class="separator:a2e1b9e7dda273bacf82f2708c9f8537a inherit pro_methods_class_serializable_object"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="inherit_header pro_attribs_class_shape_settings"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pro_attribs_class_shape_settings')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="class_shape_settings.html">ShapeSettings</a></td></tr>
  210. <tr class="memitem:ac8e243f3e923ee07d58111a0dd88c547 inherit pro_attribs_class_shape_settings" id="r_ac8e243f3e923ee07d58111a0dd88c547"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_shape_settings.html#a8573ddc7722fadfc12bb16515d77254a">ShapeResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_shape_settings.html#ac8e243f3e923ee07d58111a0dd88c547">mCachedResult</a></td></tr>
  211. <tr class="separator:ac8e243f3e923ee07d58111a0dd88c547 inherit pro_attribs_class_shape_settings"><td class="memSeparator" colspan="2">&#160;</td></tr>
  212. <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; ShapeSettings &gt;</a></td></tr>
  213. <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>
  214. <tr class="memdesc:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current reference count. <br /></td></tr>
  215. <tr class="separator:a12afba0bdae7706a0afd4d96ac128231 inherit pro_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <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; ShapeSettings &gt;</a></td></tr>
  217. <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>
  218. <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>
  219. <tr class="separator:ad37db773efa3c8756f6d95df3862b875 inherit pro_static_attribs_class_ref_target"><td class="memSeparator" colspan="2">&#160;</td></tr>
  220. </table>
  221. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  222. <div class="textblock"><p>Class that constructs a <a class="el" href="class_plane_shape.html">PlaneShape</a>. </p>
  223. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  224. <a id="a666082ced89b84d2f8dcf2a3df7de6de" name="a666082ced89b84d2f8dcf2a3df7de6de"></a>
  225. <h2 class="memtitle"><span class="permalink"><a href="#a666082ced89b84d2f8dcf2a3df7de6de">&#9670;&#160;</a></span>PlaneShapeSettings() <span class="overload">[1/2]</span></h2>
  226. <div class="memitem">
  227. <div class="memproto">
  228. <table class="mlabels">
  229. <tr>
  230. <td class="mlabels-left">
  231. <table class="memname">
  232. <tr>
  233. <td class="memname">PlaneShapeSettings::PlaneShapeSettings </td>
  234. <td>(</td>
  235. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  236. <td></td>
  237. </tr>
  238. </table>
  239. </td>
  240. <td class="mlabels-right">
  241. <span class="mlabels"><span class="mlabel">default</span></span> </td>
  242. </tr>
  243. </table>
  244. </div><div class="memdoc">
  245. <p>Default constructor for deserialization. </p>
  246. </div>
  247. </div>
  248. <a id="a33dae2d759e796b2d454711b37da6730" name="a33dae2d759e796b2d454711b37da6730"></a>
  249. <h2 class="memtitle"><span class="permalink"><a href="#a33dae2d759e796b2d454711b37da6730">&#9670;&#160;</a></span>PlaneShapeSettings() <span class="overload">[2/2]</span></h2>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <table class="mlabels">
  253. <tr>
  254. <td class="mlabels-left">
  255. <table class="memname">
  256. <tr>
  257. <td class="memname">PlaneShapeSettings::PlaneShapeSettings </td>
  258. <td>(</td>
  259. <td class="paramtype">const <a class="el" href="class_plane.html">Plane</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inPlane</em></span>, </td>
  260. </tr>
  261. <tr>
  262. <td class="paramkey"></td>
  263. <td></td>
  264. <td class="paramtype">const <a class="el" href="class_physics_material.html">PhysicsMaterial</a> *</td> <td class="paramname"><span class="paramname"><em>inMaterial</em></span><span class="paramdefsep"> = </span><span class="paramdefval">nullptr</span>, </td>
  265. </tr>
  266. <tr>
  267. <td class="paramkey"></td>
  268. <td></td>
  269. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inHalfExtent</em></span><span class="paramdefsep"> = </span><span class="paramdefval"><a class="el" href="#a581671fd5f17403723d905d380114533">cDefaultHalfExtent</a></span>&#160;)</td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <p>Create a plane shape. </p>
  279. </div>
  280. </div>
  281. <h2 class="groupheader">Member Function Documentation</h2>
  282. <a id="a988344346e7e5bf5253ea56c7b79ee59" name="a988344346e7e5bf5253ea56c7b79ee59"></a>
  283. <h2 class="memtitle"><span class="permalink"><a href="#a988344346e7e5bf5253ea56c7b79ee59">&#9670;&#160;</a></span>Create()</h2>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <table class="mlabels">
  287. <tr>
  288. <td class="mlabels-left">
  289. <table class="memname">
  290. <tr>
  291. <td class="memname"><a class="el" href="class_shape_settings.html#a8573ddc7722fadfc12bb16515d77254a">ShapeSettings::ShapeResult</a> PlaneShapeSettings::Create </td>
  292. <td>(</td>
  293. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  294. <td> const</td>
  295. </tr>
  296. </table>
  297. </td>
  298. <td class="mlabels-right">
  299. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Create a shape according to the settings specified by this object. </p>
  304. <p>Implements <a class="el" href="class_shape_settings.html#a21e53b5758542a5527c7941d61d838fa">ShapeSettings</a>.</p>
  305. </div>
  306. </div>
  307. <h2 class="groupheader">Member Data Documentation</h2>
  308. <a id="a581671fd5f17403723d905d380114533" name="a581671fd5f17403723d905d380114533"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#a581671fd5f17403723d905d380114533">&#9670;&#160;</a></span>cDefaultHalfExtent</h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <table class="mlabels">
  313. <tr>
  314. <td class="mlabels-left">
  315. <table class="memname">
  316. <tr>
  317. <td class="memname">float PlaneShapeSettings::cDefaultHalfExtent = 1000.0f</td>
  318. </tr>
  319. </table>
  320. </td>
  321. <td class="mlabels-right">
  322. <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
  323. </tr>
  324. </table>
  325. </div><div class="memdoc">
  326. <p>Default half-extent of the plane (total size along 1 axis will be 2 * half-extent) </p>
  327. </div>
  328. </div>
  329. <a id="a3a23d6998fdb06983bfeb395a366c88c" name="a3a23d6998fdb06983bfeb395a366c88c"></a>
  330. <h2 class="memtitle"><span class="permalink"><a href="#a3a23d6998fdb06983bfeb395a366c88c">&#9670;&#160;</a></span>mHalfExtent</h2>
  331. <div class="memitem">
  332. <div class="memproto">
  333. <table class="memname">
  334. <tr>
  335. <td class="memname">float PlaneShapeSettings::mHalfExtent = <a class="el" href="#a581671fd5f17403723d905d380114533">cDefaultHalfExtent</a></td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. <p>The bounding box of this plane will run from [-half_extent, half_extent]. Keep this as low as possible for better broad phase performance. </p>
  340. </div>
  341. </div>
  342. <a id="a40e64ab3f0d0a8079c57af69298873e8" name="a40e64ab3f0d0a8079c57af69298873e8"></a>
  343. <h2 class="memtitle"><span class="permalink"><a href="#a40e64ab3f0d0a8079c57af69298873e8">&#9670;&#160;</a></span>mMaterial</h2>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <table class="memname">
  347. <tr>
  348. <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; PlaneShapeSettings::mMaterial</td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>Surface material of the plane. </p>
  353. </div>
  354. </div>
  355. <a id="a0eb3d51eb7d3aaf41d1156f138f3cfb6" name="a0eb3d51eb7d3aaf41d1156f138f3cfb6"></a>
  356. <h2 class="memtitle"><span class="permalink"><a href="#a0eb3d51eb7d3aaf41d1156f138f3cfb6">&#9670;&#160;</a></span>mPlane</h2>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname"><a class="el" href="class_plane.html">Plane</a> PlaneShapeSettings::mPlane</td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <p><a class="el" href="class_plane.html" title="An infinite plane described by the formula X . Normal + Constant = 0.">Plane</a> that describes the shape. The negative half space is considered solid. </p>
  366. </div>
  367. </div>
  368. <hr/>The documentation for this class was generated from the following files:<ul>
  369. <li>Jolt/Physics/Collision/Shape/<a class="el" href="_plane_shape_8h_source.html">PlaneShape.h</a></li>
  370. <li>Jolt/Physics/Collision/Shape/<a class="el" href="_plane_shape_8cpp.html">PlaneShape.cpp</a></li>
  371. </ul>
  372. </div><!-- contents -->
  373. </div><!-- doc-content -->
  374. <!-- start footer part -->
  375. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  376. <ul>
  377. <li class="navelem"><a class="el" href="class_plane_shape_settings.html">PlaneShapeSettings</a></li>
  378. <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>
  379. </ul>
  380. </div>
  381. </body>
  382. </html>