class_ellipse.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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: Ellipse 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_ellipse.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_ellipse-members.html">List of all members</a> </div>
  109. <div class="headertitle"><div class="title">Ellipse Class Reference</div></div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <p><code>#include &lt;<a class="el" href="_ellipse_8h_source.html">Ellipse.h</a>&gt;</code></p>
  113. <table class="memberdecls">
  114. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  115. Public Member Functions</h2></td></tr>
  116. <tr class="memitem:a35e3c1cc223333a5e227ea0ff9b120de" id="r_a35e3c1cc223333a5e227ea0ff9b120de"><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="#a35e3c1cc223333a5e227ea0ff9b120de">Ellipse</a> (float inA, float inB)</td></tr>
  117. <tr class="memdesc:a35e3c1cc223333a5e227ea0ff9b120de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct ellipse with radius A along the X-axis and B along the Y-axis. <br /></td></tr>
  118. <tr class="separator:a35e3c1cc223333a5e227ea0ff9b120de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a5592d2e8e6bb560567b3c9236babd545" id="r_a5592d2e8e6bb560567b3c9236babd545"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5592d2e8e6bb560567b3c9236babd545">IsInside</a> (const <a class="el" href="class_float2.html">Float2</a> &amp;inPoint) const</td></tr>
  120. <tr class="memdesc:a5592d2e8e6bb560567b3c9236babd545"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if inPoint is inside the ellipse. <br /></td></tr>
  121. <tr class="separator:a5592d2e8e6bb560567b3c9236babd545"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a07b49662cd16799da0e0b1a1d67a8d84" id="r_a07b49662cd16799da0e0b1a1d67a8d84"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_float2.html">Float2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a07b49662cd16799da0e0b1a1d67a8d84">GetClosestPoint</a> (const <a class="el" href="class_float2.html">Float2</a> &amp;inPoint) const</td></tr>
  123. <tr class="separator:a07b49662cd16799da0e0b1a1d67a8d84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a827cce3196e44e983b0fb525eb9d52ac" id="r_a827cce3196e44e983b0fb525eb9d52ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_float2.html">Float2</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a827cce3196e44e983b0fb525eb9d52ac">GetNormal</a> (const <a class="el" href="class_float2.html">Float2</a> &amp;inPoint) const</td></tr>
  125. <tr class="memdesc:a827cce3196e44e983b0fb525eb9d52ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get normal at point inPoint (non-normalized vector) <br /></td></tr>
  126. <tr class="separator:a827cce3196e44e983b0fb525eb9d52ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table>
  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  129. <div class="textblock"><p><a class="el" href="class_ellipse.html">Ellipse</a> centered around the origin </p><dl class="section see"><dt>See also</dt><dd><a href="https://en.wikipedia.org/wiki/Ellipse">https://en.wikipedia.org/wiki/Ellipse</a> </dd></dl>
  130. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  131. <a id="a35e3c1cc223333a5e227ea0ff9b120de" name="a35e3c1cc223333a5e227ea0ff9b120de"></a>
  132. <h2 class="memtitle"><span class="permalink"><a href="#a35e3c1cc223333a5e227ea0ff9b120de">&#9670;&#160;</a></span>Ellipse()</h2>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="mlabels">
  136. <tr>
  137. <td class="mlabels-left">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> Ellipse::Ellipse </td>
  141. <td>(</td>
  142. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inA</em></span>, </td>
  143. </tr>
  144. <tr>
  145. <td class="paramkey"></td>
  146. <td></td>
  147. <td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>inB</em></span>&#160;)</td>
  148. </tr>
  149. </table>
  150. </td>
  151. <td class="mlabels-right">
  152. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <p>Construct ellipse with radius A along the X-axis and B along the Y-axis. </p>
  157. </div>
  158. </div>
  159. <h2 class="groupheader">Member Function Documentation</h2>
  160. <a id="a07b49662cd16799da0e0b1a1d67a8d84" name="a07b49662cd16799da0e0b1a1d67a8d84"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#a07b49662cd16799da0e0b1a1d67a8d84">&#9670;&#160;</a></span>GetClosestPoint()</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"><a class="el" href="class_float2.html">Float2</a> Ellipse::GetClosestPoint </td>
  170. <td>(</td>
  171. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inPoint</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> </td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>Get the closest point on the ellipse to inPoint Assumes inPoint is outside the ellipse </p><dl class="section see"><dt>See also</dt><dd>Rotation Joint Limits in Quaternion Space by Gino van den Bergen, section 10.1 in Game Engine Gems 3. </dd></dl>
  182. </div>
  183. </div>
  184. <a id="a827cce3196e44e983b0fb525eb9d52ac" name="a827cce3196e44e983b0fb525eb9d52ac"></a>
  185. <h2 class="memtitle"><span class="permalink"><a href="#a827cce3196e44e983b0fb525eb9d52ac">&#9670;&#160;</a></span>GetNormal()</h2>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="mlabels">
  189. <tr>
  190. <td class="mlabels-left">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname"><a class="el" href="class_float2.html">Float2</a> Ellipse::GetNormal </td>
  194. <td>(</td>
  195. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inPoint</em></span></td><td>)</td>
  196. <td> const</td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <p>Get normal at point inPoint (non-normalized vector) </p>
  206. </div>
  207. </div>
  208. <a id="a5592d2e8e6bb560567b3c9236babd545" name="a5592d2e8e6bb560567b3c9236babd545"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#a5592d2e8e6bb560567b3c9236babd545">&#9670;&#160;</a></span>IsInside()</h2>
  210. <div class="memitem">
  211. <div class="memproto">
  212. <table class="mlabels">
  213. <tr>
  214. <td class="mlabels-left">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">bool Ellipse::IsInside </td>
  218. <td>(</td>
  219. <td class="paramtype">const <a class="el" href="class_float2.html">Float2</a> &amp;</td> <td class="paramname"><span class="paramname"><em>inPoint</em></span></td><td>)</td>
  220. <td> const</td>
  221. </tr>
  222. </table>
  223. </td>
  224. <td class="mlabels-right">
  225. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>Check if inPoint is inside the ellipse. </p>
  230. </div>
  231. </div>
  232. <hr/>The documentation for this class was generated from the following file:<ul>
  233. <li>Jolt/Geometry/<a class="el" href="_ellipse_8h_source.html">Ellipse.h</a></li>
  234. </ul>
  235. </div><!-- contents -->
  236. </div><!-- doc-content -->
  237. <!-- start footer part -->
  238. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  239. <ul>
  240. <li class="navelem"><a class="el" href="class_ellipse.html">Ellipse</a></li>
  241. <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>
  242. </ul>
  243. </div>
  244. </body>
  245. </html>