_ray_sphere_8h_source.html 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  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: Jolt/Geometry/RaySphere.h Source File</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('_ray_sphere_8h_source.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="headertitle"><div class="title">RaySphere.h</div></div>
  107. </div><!--header-->
  108. <div class="contents">
  109. <a href="_ray_sphere_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)</span></div>
  110. <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// SPDX-FileCopyrightText: 2021 Jorrit Rouwe</span></div>
  111. <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// SPDX-License-Identifier: MIT</span></div>
  112. <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
  113. <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#pragma once</span></div>
  114. <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
  115. <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;<a class="code" href="_find_root_8h.html">Jolt/Math/FindRoot.h</a>&gt;</span></div>
  116. <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
  117. <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><a class="code hl_define" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div>
  118. <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
  119. <div class="foldopen" id="foldopen00017" data-start="{" data-end="}">
  120. <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="_ray_sphere_8h.html#ae0d53ac665a580da61a2fe0a08f5197c"> 17</a></span>JPH_INLINE <span class="keywordtype">float</span> <a class="code hl_function" href="_ray_sphere_8h.html#ae0d53ac665a580da61a2fe0a08f5197c">RaySphere</a>(<a class="code hl_class" href="class_vec3.html">Vec3Arg</a> inRayOrigin, <a class="code hl_class" href="class_vec3.html">Vec3Arg</a> inRayDirection, <a class="code hl_class" href="class_vec3.html">Vec3Arg</a> inSphereCenter, <span class="keywordtype">float</span> inSphereRadius)</div>
  121. <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>{</div>
  122. <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// Solve: |RayOrigin + fraction * RayDirection - SphereCenter|^2 = SphereRadius^2 for fraction</span></div>
  123. <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="class_vec3.html">Vec3</a> center_origin = inRayOrigin - inSphereCenter;</div>
  124. <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">float</span> a = inRayDirection.<a class="code hl_function" href="class_vec3.html#aba501a6a474028084799f871c9083dc1">LengthSq</a>();</div>
  125. <div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">float</span> b = 2.0f * inRayDirection.<a class="code hl_function" href="class_vec3.html#a0e078ff09f69e669db71a2b0e37939ff">Dot</a>(center_origin);</div>
  126. <div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">float</span> c = center_origin.<a class="code hl_function" href="class_vec3.html#aba501a6a474028084799f871c9083dc1">LengthSq</a>() - inSphereRadius * inSphereRadius;</div>
  127. <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="keywordtype">float</span> fraction1, fraction2;</div>
  128. <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keywordflow">if</span> (<a class="code hl_function" href="_find_root_8h.html#a3bec219d038a3c84a22b1c07b49b9eca">FindRoot</a>(a, b, c, fraction1, fraction2) == 0)</div>
  129. <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordflow">return</span> c &lt;= 0.0f? 0.0f : FLT_MAX; <span class="comment">// Return if origin is inside the sphere</span></div>
  130. <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
  131. <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// Sort so that the smallest is first</span></div>
  132. <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keywordflow">if</span> (fraction1 &gt; fraction2)</div>
  133. <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> std::swap(fraction1, fraction2);</div>
  134. <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
  135. <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// Test solution with lowest fraction, this will be the ray entering the sphere</span></div>
  136. <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordflow">if</span> (fraction1 &gt;= 0.0f)</div>
  137. <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">return</span> fraction1; <span class="comment">// Sphere is before the ray start</span></div>
  138. <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
  139. <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// Test solution with highest fraction, this will be the ray leaving the sphere</span></div>
  140. <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">if</span> (fraction2 &gt;= 0.0f)</div>
  141. <div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">return</span> 0.0f; <span class="comment">// We start inside the sphere</span></div>
  142. <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
  143. <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// No solution</span></div>
  144. <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">return</span> FLT_MAX;</div>
  145. <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>}</div>
  146. </div>
  147. <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
  148. <div class="foldopen" id="foldopen00054" data-start="{" data-end="}">
  149. <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="_ray_sphere_8h.html#a7d756cc06fb7721b3e657d9f31916b74"> 54</a></span>JPH_INLINE <span class="keywordtype">int</span> <a class="code hl_function" href="_ray_sphere_8h.html#ae0d53ac665a580da61a2fe0a08f5197c">RaySphere</a>(<a class="code hl_class" href="class_vec3.html">Vec3Arg</a> inRayOrigin, <a class="code hl_class" href="class_vec3.html">Vec3Arg</a> inRayDirection, <a class="code hl_class" href="class_vec3.html">Vec3Arg</a> inSphereCenter, <span class="keywordtype">float</span> inSphereRadius, <span class="keywordtype">float</span> &amp;outMinFraction, <span class="keywordtype">float</span> &amp;outMaxFraction)</div>
  150. <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>{</div>
  151. <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// Solve: |RayOrigin + fraction * RayDirection - SphereCenter|^2 = SphereRadius^2 for fraction</span></div>
  152. <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_class" href="class_vec3.html">Vec3</a> center_origin = inRayOrigin - inSphereCenter;</div>
  153. <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">float</span> a = inRayDirection.<a class="code hl_function" href="class_vec3.html#aba501a6a474028084799f871c9083dc1">LengthSq</a>();</div>
  154. <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordtype">float</span> b = 2.0f * inRayDirection.<a class="code hl_function" href="class_vec3.html#a0e078ff09f69e669db71a2b0e37939ff">Dot</a>(center_origin);</div>
  155. <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordtype">float</span> c = center_origin.<a class="code hl_function" href="class_vec3.html#aba501a6a474028084799f871c9083dc1">LengthSq</a>() - inSphereRadius * inSphereRadius;</div>
  156. <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordtype">float</span> fraction1, fraction2;</div>
  157. <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">switch</span> (<a class="code hl_function" href="_find_root_8h.html#a3bec219d038a3c84a22b1c07b49b9eca">FindRoot</a>(a, b, c, fraction1, fraction2))</div>
  158. <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> {</div>
  159. <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordflow">case</span> 0:</div>
  160. <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">if</span> (c &lt;= 0.0f)</div>
  161. <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> {</div>
  162. <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// Origin inside sphere</span></div>
  163. <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> outMinFraction = outMaxFraction = 0.0f;</div>
  164. <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> 1;</div>
  165. <div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
  166. <div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">else</span></div>
  167. <div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> {</div>
  168. <div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="comment">// Origin outside of the sphere</span></div>
  169. <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <span class="keywordflow">return</span> 0;</div>
  170. <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> }</div>
  171. <div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">break</span>;</div>
  172. <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
  173. <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keywordflow">case</span> 1:</div>
  174. <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="comment">// Ray is touching the sphere</span></div>
  175. <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> outMinFraction = outMaxFraction = fraction1;</div>
  176. <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">return</span> 1;</div>
  177. <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
  178. <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <span class="keywordflow">default</span>:</div>
  179. <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="comment">// Ray enters and exits the sphere</span></div>
  180. <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
  181. <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> <span class="comment">// Sort so that the smallest is first</span></div>
  182. <div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">if</span> (fraction1 &gt; fraction2)</div>
  183. <div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> std::swap(fraction1, fraction2);</div>
  184. <div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
  185. <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> outMinFraction = fraction1;</div>
  186. <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> outMaxFraction = fraction2;</div>
  187. <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keywordflow">return</span> 2;</div>
  188. <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> }</div>
  189. <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span>}</div>
  190. </div>
  191. <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
  192. <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><a class="code hl_define" href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div>
  193. <div class="ttc" id="a_core_8h_html_a73da8725998b00321a9db341202d650d"><div class="ttname"><a href="_core_8h.html#a73da8725998b00321a9db341202d650d">JPH_NAMESPACE_END</a></div><div class="ttdeci">#define JPH_NAMESPACE_END</div><div class="ttdef"><b>Definition</b> Core.h:425</div></div>
  194. <div class="ttc" id="a_core_8h_html_ad14098b68b8c44ea6112601031268405"><div class="ttname"><a href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define JPH_NAMESPACE_BEGIN</div><div class="ttdef"><b>Definition</b> Core.h:419</div></div>
  195. <div class="ttc" id="a_find_root_8h_html"><div class="ttname"><a href="_find_root_8h.html">FindRoot.h</a></div></div>
  196. <div class="ttc" id="a_find_root_8h_html_a3bec219d038a3c84a22b1c07b49b9eca"><div class="ttname"><a href="_find_root_8h.html#a3bec219d038a3c84a22b1c07b49b9eca">FindRoot</a></div><div class="ttdeci">JPH_NAMESPACE_BEGIN int FindRoot(const T inA, const T inB, const T inC, T &amp;outX1, T &amp;outX2)</div><div class="ttdef"><b>Definition</b> FindRoot.h:13</div></div>
  197. <div class="ttc" id="a_ray_sphere_8h_html_ae0d53ac665a580da61a2fe0a08f5197c"><div class="ttname"><a href="_ray_sphere_8h.html#ae0d53ac665a580da61a2fe0a08f5197c">RaySphere</a></div><div class="ttdeci">JPH_NAMESPACE_BEGIN JPH_INLINE float RaySphere(Vec3Arg inRayOrigin, Vec3Arg inRayDirection, Vec3Arg inSphereCenter, float inSphereRadius)</div><div class="ttdef"><b>Definition</b> RaySphere.h:17</div></div>
  198. <div class="ttc" id="aclass_vec3_html"><div class="ttname"><a href="class_vec3.html">Vec3</a></div><div class="ttdef"><b>Definition</b> Vec3.h:17</div></div>
  199. <div class="ttc" id="aclass_vec3_html_a0e078ff09f69e669db71a2b0e37939ff"><div class="ttname"><a href="class_vec3.html#a0e078ff09f69e669db71a2b0e37939ff">Vec3::Dot</a></div><div class="ttdeci">JPH_INLINE float Dot(Vec3Arg inV2) const</div><div class="ttdoc">Dot product.</div><div class="ttdef"><b>Definition</b> Vec3.inl:650</div></div>
  200. <div class="ttc" id="aclass_vec3_html_aba501a6a474028084799f871c9083dc1"><div class="ttname"><a href="class_vec3.html#aba501a6a474028084799f871c9083dc1">Vec3::LengthSq</a></div><div class="ttdeci">JPH_INLINE float LengthSq() const</div><div class="ttdoc">Squared length of vector.</div><div class="ttdef"><b>Definition</b> Vec3.inl:666</div></div>
  201. </div><!-- fragment --></div><!-- contents -->
  202. </div><!-- doc-content -->
  203. <!-- start footer part -->
  204. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  205. <ul>
  206. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_2d88bf03bf4a7a62918727c0f2ee34eb.html">Geometry</a></li><li class="navelem"><a class="el" href="_ray_sphere_8h.html">RaySphere.h</a></li>
  207. <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>
  208. </ul>
  209. </div>
  210. </body>
  211. </html>