class_convex_shape_1_1_support.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  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: ConvexShape::Support 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_convex_shape_1_1_support.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_convex_shape_1_1_support-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">ConvexShape::Support Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p>Function that provides an interface for GJK.
  113. <a href="#details">More...</a></p>
  114. <p><code>#include &lt;<a class="el" href="_convex_shape_8h_source.html">ConvexShape.h</a>&gt;</code></p>
  115. <div class="dynheader">
  116. Inheritance diagram for ConvexShape::Support:</div>
  117. <div class="dyncontent">
  118. <div class="center">
  119. <img src="class_convex_shape_1_1_support.png" usemap="#ConvexShape::Support_map" alt=""/>
  120. <map id="ConvexShape::Support_map" name="ConvexShape::Support_map">
  121. <area href="class_box_shape_1_1_box.html" alt="BoxShape::Box" shape="rect" coords="257,56,504,80"/>
  122. <area href="class_capsule_shape_1_1_capsule_no_convex.html" alt="CapsuleShape::CapsuleNoConvex" shape="rect" coords="257,112,504,136"/>
  123. <area href="class_capsule_shape_1_1_capsule_with_convex.html" alt="CapsuleShape::CapsuleWithConvex" shape="rect" coords="257,168,504,192"/>
  124. <area href="class_convex_hull_shape_1_1_hull_no_convex.html" alt="ConvexHullShape::HullNoConvex" shape="rect" coords="257,224,504,248"/>
  125. <area href="class_convex_hull_shape_1_1_hull_with_convex.html" alt="ConvexHullShape::HullWithConvex" shape="rect" coords="257,280,504,304"/>
  126. <area href="class_convex_hull_shape_1_1_hull_with_convex_scaled.html" alt="ConvexHullShape::HullWithConvexScaled" shape="rect" coords="257,336,504,360"/>
  127. <area href="class_cylinder_shape_1_1_cylinder.html" alt="CylinderShape::Cylinder" shape="rect" coords="257,392,504,416"/>
  128. <area href="class_sphere_shape_1_1_sphere_no_convex.html" alt="SphereShape::SphereNoConvex" shape="rect" coords="257,448,504,472"/>
  129. <area href="class_sphere_shape_1_1_sphere_with_convex.html" alt="SphereShape::SphereWithConvex" shape="rect" coords="257,504,504,528"/>
  130. <area href="class_tapered_capsule_shape_1_1_tapered_capsule.html" alt="TaperedCapsuleShape::TaperedCapsule" shape="rect" coords="257,560,504,584"/>
  131. <area href="class_tapered_cylinder_shape_1_1_tapered_cylinder.html" alt="TaperedCylinderShape::TaperedCylinder" shape="rect" coords="257,616,504,640"/>
  132. <area href="class_triangle_shape_1_1_triangle_no_convex.html" alt="TriangleShape::TriangleNoConvex" shape="rect" coords="257,672,504,696"/>
  133. <area href="class_triangle_shape_1_1_triangle_with_convex.html" alt="TriangleShape::TriangleWithConvex" shape="rect" coords="257,728,504,752"/>
  134. </map>
  135. </div></div>
  136. <table class="memberdecls">
  137. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  138. Public Member Functions</h2></td></tr>
  139. <tr class="memitem:a24c8452338cbc755fb69f04aca229a4c" id="r_a24c8452338cbc755fb69f04aca229a4c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a24c8452338cbc755fb69f04aca229a4c">~Support</a> ()=default</td></tr>
  140. <tr class="memdesc:a24c8452338cbc755fb69f04aca229a4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Warning: Virtual destructor will not be called on this object! <br /></td></tr>
  141. <tr class="separator:a24c8452338cbc755fb69f04aca229a4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:ab2a715898d419c03321366a009539ae0" id="r_ab2a715898d419c03321366a009539ae0"><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="#ab2a715898d419c03321366a009539ae0">GetSupport</a> (<a class="el" href="_math_types_8h.html#a6bc57c31f15cea47640b580d03737c68">Vec3Arg</a> inDirection) const =0</td></tr>
  143. <tr class="separator:ab2a715898d419c03321366a009539ae0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ab6255a297bd904ef2c09a9cce6c3c05b" id="r_ab6255a297bd904ef2c09a9cce6c3c05b"><td class="memItemLeft" align="right" valign="top">virtual float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab6255a297bd904ef2c09a9cce6c3c05b">GetConvexRadius</a> () const =0</td></tr>
  145. <tr class="separator:ab6255a297bd904ef2c09a9cce6c3c05b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table>
  147. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  148. <div class="textblock"><p>Function that provides an interface for GJK. </p>
  149. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  150. <a id="a24c8452338cbc755fb69f04aca229a4c" name="a24c8452338cbc755fb69f04aca229a4c"></a>
  151. <h2 class="memtitle"><span class="permalink"><a href="#a24c8452338cbc755fb69f04aca229a4c">&#9670;&#160;</a></span>~Support()</h2>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="mlabels">
  155. <tr>
  156. <td class="mlabels-left">
  157. <table class="memname">
  158. <tr>
  159. <td class="memname">virtual ConvexShape::Support::~Support </td>
  160. <td>(</td>
  161. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  162. <td></td>
  163. </tr>
  164. </table>
  165. </td>
  166. <td class="mlabels-right">
  167. <span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Warning: Virtual destructor will not be called on this object! </p>
  172. </div>
  173. </div>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a id="ab6255a297bd904ef2c09a9cce6c3c05b" name="ab6255a297bd904ef2c09a9cce6c3c05b"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#ab6255a297bd904ef2c09a9cce6c3c05b">&#9670;&#160;</a></span>GetConvexRadius()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="mlabels">
  180. <tr>
  181. <td class="mlabels-left">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname">virtual float ConvexShape::Support::GetConvexRadius </td>
  185. <td>(</td>
  186. <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
  187. <td> const</td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <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>
  197. <p>Implemented in <a class="el" href="class_box_shape_1_1_box.html#aae4ca0e522c6bf8bfd05b2ac5a8f3657">BoxShape::Box</a>, <a class="el" href="class_capsule_shape_1_1_capsule_no_convex.html#ac5c3f5013f55a44ca8a27f4f26bcdd7e">CapsuleShape::CapsuleNoConvex</a>, <a class="el" href="class_capsule_shape_1_1_capsule_with_convex.html#a8848a4436820ea01656a3dc6f0700c12">CapsuleShape::CapsuleWithConvex</a>, <a class="el" href="class_convex_hull_shape_1_1_hull_no_convex.html#a9eb3d10a97e5ff7728db7f2ab218eff5">ConvexHullShape::HullNoConvex</a>, <a class="el" href="class_convex_hull_shape_1_1_hull_with_convex.html#a069ec0a55025c42b3496246b949cd596">ConvexHullShape::HullWithConvex</a>, <a class="el" href="class_convex_hull_shape_1_1_hull_with_convex_scaled.html#a35a3f457cbdae6352227be61c356bba1">ConvexHullShape::HullWithConvexScaled</a>, <a class="el" href="class_cylinder_shape_1_1_cylinder.html#a0427aea83069b39420bcc5d84e02e11a">CylinderShape::Cylinder</a>, <a class="el" href="class_sphere_shape_1_1_sphere_no_convex.html#afd8c26363093475f569d9b01710e66d9">SphereShape::SphereNoConvex</a>, <a class="el" href="class_sphere_shape_1_1_sphere_with_convex.html#a63950fdd2ab3281634f5521a08fb6793">SphereShape::SphereWithConvex</a>, <a class="el" href="class_tapered_capsule_shape_1_1_tapered_capsule.html#a44fd5dde5c0b781753c7d58005272a5b">TaperedCapsuleShape::TaperedCapsule</a>, <a class="el" href="class_tapered_cylinder_shape_1_1_tapered_cylinder.html#a1a34aff6da2ce5e2a274d484a8460cb4">TaperedCylinderShape::TaperedCylinder</a>, <a class="el" href="class_triangle_shape_1_1_triangle_no_convex.html#a9a3136e6697ef368555225a6e12f0149">TriangleShape::TriangleNoConvex</a>, and <a class="el" href="class_triangle_shape_1_1_triangle_with_convex.html#ac62eb3e67195f25c99f68e752afb7082">TriangleShape::TriangleWithConvex</a>.</p>
  198. </div>
  199. </div>
  200. <a id="ab2a715898d419c03321366a009539ae0" name="ab2a715898d419c03321366a009539ae0"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#ab2a715898d419c03321366a009539ae0">&#9670;&#160;</a></span>GetSupport()</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">virtual <a class="el" href="class_vec3.html">Vec3</a> ConvexShape::Support::GetSupport </td>
  210. <td>(</td>
  211. <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>
  212. <td> const</td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Calculate the support vector for this convex shape (includes / excludes the convex radius depending on how this was obtained). <a class="el" href="class_convex_shape_1_1_support.html" title="Function that provides an interface for GJK.">Support</a> vector is relative to the center of mass of the shape. </p>
  222. <p>Implemented in <a class="el" href="class_box_shape_1_1_box.html#addae08ce81d2c3eaca0acd914c2fe662">BoxShape::Box</a>, <a class="el" href="class_capsule_shape_1_1_capsule_no_convex.html#a0be6a5849883349f4d1e7bfa2107b4c6">CapsuleShape::CapsuleNoConvex</a>, <a class="el" href="class_capsule_shape_1_1_capsule_with_convex.html#a15a15b4961f231684a30f4fbcdbee693">CapsuleShape::CapsuleWithConvex</a>, <a class="el" href="class_convex_hull_shape_1_1_hull_no_convex.html#ac12140f541d4dcf2b1c6a58108c0b026">ConvexHullShape::HullNoConvex</a>, <a class="el" href="class_convex_hull_shape_1_1_hull_with_convex.html#a0abf6518afb0203d73ed2308d3bb83b1">ConvexHullShape::HullWithConvex</a>, <a class="el" href="class_convex_hull_shape_1_1_hull_with_convex_scaled.html#aad0e71dae0215de9d65abee32e3d5bb7">ConvexHullShape::HullWithConvexScaled</a>, <a class="el" href="class_cylinder_shape_1_1_cylinder.html#ac2fbf97f298eabff324fe1200d1e6974">CylinderShape::Cylinder</a>, <a class="el" href="class_sphere_shape_1_1_sphere_no_convex.html#a38a13c00c2b11db056767b4f67241845">SphereShape::SphereNoConvex</a>, <a class="el" href="class_sphere_shape_1_1_sphere_with_convex.html#a503b8f57aa6e001cda690534f3c723a1">SphereShape::SphereWithConvex</a>, <a class="el" href="class_tapered_capsule_shape_1_1_tapered_capsule.html#a91c8bdbd45deec0013bf3f383adcb149">TaperedCapsuleShape::TaperedCapsule</a>, <a class="el" href="class_tapered_cylinder_shape_1_1_tapered_cylinder.html#a450d358fbfb9f7313c000bfad68142b5">TaperedCylinderShape::TaperedCylinder</a>, <a class="el" href="class_triangle_shape_1_1_triangle_no_convex.html#a03cf50acfaaafb83ae5f2c1efc445c7c">TriangleShape::TriangleNoConvex</a>, and <a class="el" href="class_triangle_shape_1_1_triangle_with_convex.html#addb17c65c6b1c99b7a4b2862ac796446">TriangleShape::TriangleWithConvex</a>.</p>
  223. </div>
  224. </div>
  225. <hr/>The documentation for this class was generated from the following file:<ul>
  226. <li>Jolt/Physics/Collision/Shape/<a class="el" href="_convex_shape_8h_source.html">ConvexShape.h</a></li>
  227. </ul>
  228. </div><!-- contents -->
  229. </div><!-- doc-content -->
  230. <!-- start footer part -->
  231. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  232. <ul>
  233. <li class="navelem"><a class="el" href="class_convex_shape.html">ConvexShape</a></li><li class="navelem"><a class="el" href="class_convex_shape_1_1_support.html">Support</a></li>
  234. <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>
  235. </ul>
  236. </div>
  237. </body>
  238. </html>