class_sphere_shape_1_1_sphere_with_convex.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  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: SphereShape::SphereWithConvex 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_sphere_shape_1_1_sphere_with_convex.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="class_sphere_shape_1_1_sphere_with_convex-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">SphereShape::SphereWithConvex Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="dynheader">
  113. Inheritance diagram for SphereShape::SphereWithConvex:</div>
  114. <div class="dyncontent">
  115. <div class="center">
  116. <img src="class_sphere_shape_1_1_sphere_with_convex.png" usemap="#SphereShape::SphereWithConvex_map" alt=""/>
  117. <map id="SphereShape::SphereWithConvex_map" name="SphereShape::SphereWithConvex_map">
  118. <area href="class_convex_shape_1_1_support.html" title="Function that provides an interface for GJK." alt="ConvexShape::Support" shape="rect" coords="0,0,203,24"/>
  119. </map>
  120. </div></div>
  121. <table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  123. Public Member Functions</h2></td></tr>
  124. <tr class="memitem:ac0c40365985e261513777a19d486b6d8" id="r_ac0c40365985e261513777a19d486b6d8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac0c40365985e261513777a19d486b6d8">SphereWithConvex</a> (float inRadius)</td></tr>
  125. <tr class="separator:ac0c40365985e261513777a19d486b6d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a503b8f57aa6e001cda690534f3c723a1" id="r_a503b8f57aa6e001cda690534f3c723a1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_vec3.html">Vec3</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a503b8f57aa6e001cda690534f3c723a1">GetSupport</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inDirection) const override</td></tr>
  127. <tr class="separator:a503b8f57aa6e001cda690534f3c723a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a63950fdd2ab3281634f5521a08fb6793" id="r_a63950fdd2ab3281634f5521a08fb6793"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a63950fdd2ab3281634f5521a08fb6793">GetConvexRadius</a> () const override</td></tr>
  129. <tr class="separator:a63950fdd2ab3281634f5521a08fb6793"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="inherit_header pub_methods_class_convex_shape_1_1_support"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_convex_shape_1_1_support')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_convex_shape_1_1_support.html">ConvexShape::Support</a></td></tr>
  131. <tr class="memitem:a24c8452338cbc755fb69f04aca229a4c inherit pub_methods_class_convex_shape_1_1_support" id="r_a24c8452338cbc755fb69f04aca229a4c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_convex_shape_1_1_support.html#a24c8452338cbc755fb69f04aca229a4c">~Support</a> ()=default</td></tr>
  132. <tr class="memdesc:a24c8452338cbc755fb69f04aca229a4c inherit pub_methods_class_convex_shape_1_1_support"><td class="mdescLeft">&#160;</td><td class="mdescRight">Warning: Virtual destructor will not be called on this object! <br /></td></tr>
  133. <tr class="separator:a24c8452338cbc755fb69f04aca229a4c inherit pub_methods_class_convex_shape_1_1_support"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. </table>
  135. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  136. <a id="ac0c40365985e261513777a19d486b6d8" name="ac0c40365985e261513777a19d486b6d8"></a>
  137. <h2 class="memtitle"><span class="permalink"><a href="#ac0c40365985e261513777a19d486b6d8">&#9670;&#160;</a></span>SphereWithConvex()</h2>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="mlabels">
  141. <tr>
  142. <td class="mlabels-left">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">SphereShape::SphereWithConvex::SphereWithConvex </td>
  146. <td>(</td>
  147. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inRadius</em></span></td><td>)</td>
  148. <td></td>
  149. </tr>
  150. </table>
  151. </td>
  152. <td class="mlabels-right">
  153. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. </div>
  158. </div>
  159. <h2 class="groupheader">Member Function Documentation</h2>
  160. <a id="a63950fdd2ab3281634f5521a08fb6793" name="a63950fdd2ab3281634f5521a08fb6793"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#a63950fdd2ab3281634f5521a08fb6793">&#9670;&#160;</a></span>GetConvexRadius()</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <table class="mlabels">
  165. <tr>
  166. <td class="mlabels-left">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">virtual float SphereShape::SphereWithConvex::GetConvexRadius </td>
  170. <td>(</td>
  171. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  172. <td> const</td>
  173. </tr>
  174. </table>
  175. </td>
  176. <td class="mlabels-right">
  177. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>Convex radius of shape. Collision detection on penetrating shapes is much more expensive, so you can add a radius around objects to increase the shape. This makes it far less likely that they will actually penetrate. </p>
  182. <p>Implements <a class="el" href="class_convex_shape_1_1_support.html#ab6255a297bd904ef2c09a9cce6c3c05b">ConvexShape::Support</a>.</p>
  183. </div>
  184. </div>
  185. <a id="a503b8f57aa6e001cda690534f3c723a1" name="a503b8f57aa6e001cda690534f3c723a1"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#a503b8f57aa6e001cda690534f3c723a1">&#9670;&#160;</a></span>GetSupport()</h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="mlabels">
  190. <tr>
  191. <td class="mlabels-left">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">virtual <a class="el" href="class_vec3.html">Vec3</a> SphereShape::SphereWithConvex::GetSupport </td>
  195. <td>(</td>
  196. <td class="paramtype"><a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a></td> <td class="paramname"><span class="paramname"><em>inDirection</em></span></td><td>)</td>
  197. <td> const</td>
  198. </tr>
  199. </table>
  200. </td>
  201. <td class="mlabels-right">
  202. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  203. </tr>
  204. </table>
  205. </div><div class="memdoc">
  206. <p>Calculate the support vector for this convex shape (includes / excludes the convex radius depending on how this was obtained). Support vector is relative to the center of mass of the shape. </p>
  207. <p>Implements <a class="el" href="class_convex_shape_1_1_support.html#ab2a715898d419c03321366a009539ae0">ConvexShape::Support</a>.</p>
  208. </div>
  209. </div>
  210. <hr/>The documentation for this class was generated from the following file:<ul>
  211. <li>Jolt/Physics/Collision/Shape/<a class="el" href="_sphere_shape_8cpp.html">SphereShape.cpp</a></li>
  212. </ul>
  213. </div><!-- contents -->
  214. </div><!-- doc-content -->
  215. <!-- start footer part -->
  216. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  217. <ul>
  218. <li class="navelem"><a class="el" href="class_sphere_shape.html">SphereShape</a></li><li class="navelem"><a class="el" href="class_sphere_shape_1_1_sphere_with_convex.html">SphereWithConvex</a></li>
  219. <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>
  220. </ul>
  221. </div>
  222. </body>
  223. </html>