class_box3_f.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733
  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.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: Box3F 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. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-methods">Public Member Functions</a> &#124;
  73. <a href="#pub-attribs">Public Attributes</a> &#124;
  74. <a href="class_box3_f-members.html">List of all members</a> </div>
  75. <div class="headertitle"><div class="title">Box3F Class Reference</div></div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p><code>#include &lt;mBox.h&gt;</code></p>
  79. <table class="memberdecls">
  80. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  81. Public Member Functions</h2></td></tr>
  82. <tr class="memitem:a943019e7b2f966d033e7b8fdcbd0394c" id="r_a943019e7b2f966d033e7b8fdcbd0394c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a943019e7b2f966d033e7b8fdcbd0394c">Box3F</a> ()</td></tr>
  83. <tr class="separator:a943019e7b2f966d033e7b8fdcbd0394c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a031e89908dd33bab9d20d43934671901" id="r_a031e89908dd33bab9d20d43934671901"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a031e89908dd33bab9d20d43934671901">Box3F</a> (const <a class="el" href="class_point3_f.html">Point3F</a> &amp;in_rMin, const <a class="el" href="class_point3_f.html">Point3F</a> &amp;in_rMax, const bool in_overrideCheck=false)</td></tr>
  85. <tr class="separator:a031e89908dd33bab9d20d43934671901"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a55165a0ef7d5a630d0dc5b6325db2c69" id="r_a55165a0ef7d5a630d0dc5b6325db2c69"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a55165a0ef7d5a630d0dc5b6325db2c69">Box3F</a> (F32 xmin, F32 ymin, F32 zmin, F32 max, F32 ymax, F32 zmax)</td></tr>
  87. <tr class="separator:a55165a0ef7d5a630d0dc5b6325db2c69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:add40f79c4243cb81895acaf38bb1c054" id="r_add40f79c4243cb81895acaf38bb1c054"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#add40f79c4243cb81895acaf38bb1c054">isContained</a> (const <a class="el" href="class_point3_f.html">Point3F</a> &amp;in_rContained) const</td></tr>
  89. <tr class="memdesc:add40f79c4243cb81895acaf38bb1c054"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check to see if a point is contained in this box. <br /></td></tr>
  90. <tr class="separator:add40f79c4243cb81895acaf38bb1c054"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a6403c9d26de06024f4f2edad24a587ed" id="r_a6403c9d26de06024f4f2edad24a587ed"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a6403c9d26de06024f4f2edad24a587ed">isOverlapped</a> (const <a class="el" href="class_box3_f.html">Box3F</a> &amp;in_rOverlap) const</td></tr>
  92. <tr class="memdesc:a6403c9d26de06024f4f2edad24a587ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check to see if another box overlaps this box. <br /></td></tr>
  93. <tr class="separator:a6403c9d26de06024f4f2edad24a587ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a6f5954b78a6a59ccfb19505909f2fba5" id="r_a6f5954b78a6a59ccfb19505909f2fba5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a6f5954b78a6a59ccfb19505909f2fba5">isContained</a> (const <a class="el" href="class_box3_f.html">Box3F</a> &amp;in_rContained) const</td></tr>
  95. <tr class="memdesc:a6f5954b78a6a59ccfb19505909f2fba5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check to see if another box is contained in this box. <br /></td></tr>
  96. <tr class="separator:a6f5954b78a6a59ccfb19505909f2fba5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a765b93a7c005c024f0a08819f3ed4c8f" id="r_a765b93a7c005c024f0a08819f3ed4c8f"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a765b93a7c005c024f0a08819f3ed4c8f">len_x</a> () const</td></tr>
  98. <tr class="separator:a765b93a7c005c024f0a08819f3ed4c8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ac53343b4f4a67f5f06f7d8990b99b5e4" id="r_ac53343b4f4a67f5f06f7d8990b99b5e4"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#ac53343b4f4a67f5f06f7d8990b99b5e4">len_y</a> () const</td></tr>
  100. <tr class="separator:ac53343b4f4a67f5f06f7d8990b99b5e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a039ad6f4926a72e5bd41f6386070ebf9" id="r_a039ad6f4926a72e5bd41f6386070ebf9"><td class="memItemLeft" align="right" valign="top">F32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a039ad6f4926a72e5bd41f6386070ebf9">len_z</a> () const</td></tr>
  102. <tr class="separator:a039ad6f4926a72e5bd41f6386070ebf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:abb777f0ba921fe2b7e7c1a9321af5bb8" id="r_abb777f0ba921fe2b7e7c1a9321af5bb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#abb777f0ba921fe2b7e7c1a9321af5bb8">intersect</a> (const <a class="el" href="class_box3_f.html">Box3F</a> &amp;in_rIntersect)</td></tr>
  104. <tr class="separator:abb777f0ba921fe2b7e7c1a9321af5bb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:ac9f291362c2ab30c27f0e86173f84b02" id="r_ac9f291362c2ab30c27f0e86173f84b02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#ac9f291362c2ab30c27f0e86173f84b02">intersect</a> (const <a class="el" href="class_point3_f.html">Point3F</a> &amp;in_rIntersect)</td></tr>
  106. <tr class="separator:ac9f291362c2ab30c27f0e86173f84b02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:adc6d278d7d187999e54149a3954ce53b" id="r_adc6d278d7d187999e54149a3954ce53b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#adc6d278d7d187999e54149a3954ce53b">getCenter</a> (<a class="el" href="class_point3_f.html">Point3F</a> *center) const</td></tr>
  108. <tr class="separator:adc6d278d7d187999e54149a3954ce53b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ac62f5922674a34f2415efd01848531db" id="r_ac62f5922674a34f2415efd01848531db"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#ac62f5922674a34f2415efd01848531db">collideLine</a> (const <a class="el" href="class_point3_f.html">Point3F</a> &amp;start, const <a class="el" href="class_point3_f.html">Point3F</a> &amp;end, F32 *t, <a class="el" href="class_point3_f.html">Point3F</a> *n) const</td></tr>
  110. <tr class="separator:ac62f5922674a34f2415efd01848531db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:a36a1e73aa3b446af1c6c230fe8648622" id="r_a36a1e73aa3b446af1c6c230fe8648622"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a36a1e73aa3b446af1c6c230fe8648622">collideLine</a> (const <a class="el" href="class_point3_f.html">Point3F</a> &amp;start, const <a class="el" href="class_point3_f.html">Point3F</a> &amp;end) const</td></tr>
  112. <tr class="separator:a36a1e73aa3b446af1c6c230fe8648622"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a32de4c910f7d39191261089db3347c82" id="r_a32de4c910f7d39191261089db3347c82"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a32de4c910f7d39191261089db3347c82">collideOrientedBox</a> (const <a class="el" href="class_point3_f.html">Point3F</a> &amp;radii, const <a class="el" href="class_matrix_f.html">MatrixF</a> &amp;toUs) const</td></tr>
  114. <tr class="separator:a32de4c910f7d39191261089db3347c82"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a0bb0171e51f09c6301a50c62d8c8de9b" id="r_a0bb0171e51f09c6301a50c62d8c8de9b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a0bb0171e51f09c6301a50c62d8c8de9b">isValidBox</a> () const</td></tr>
  116. <tr class="separator:a0bb0171e51f09c6301a50c62d8c8de9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:ab11f92a21705945eb9ec65bd7721e74e" id="r_ab11f92a21705945eb9ec65bd7721e74e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">Point3F</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#ab11f92a21705945eb9ec65bd7721e74e">getClosestPoint</a> (const <a class="el" href="class_point3_f.html">Point3F</a> &amp;refPt) const</td></tr>
  118. <tr class="memdesc:ab11f92a21705945eb9ec65bd7721e74e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the closest point of the box, relative to the passed point. <br /></td></tr>
  119. <tr class="separator:ab11f92a21705945eb9ec65bd7721e74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. </table><table class="memberdecls">
  121. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  122. Public Attributes</h2></td></tr>
  123. <tr class="memitem:acc76c42e59040fb81caccc01b3d077ee" id="r_acc76c42e59040fb81caccc01b3d077ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">Point3F</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#acc76c42e59040fb81caccc01b3d077ee">mMin</a></td></tr>
  124. <tr class="memdesc:acc76c42e59040fb81caccc01b3d077ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum extents of box. <br /></td></tr>
  125. <tr class="separator:acc76c42e59040fb81caccc01b3d077ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a6cabca359d2778ce65c69c0afe6a6f6f" id="r_a6cabca359d2778ce65c69c0afe6a6f6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">Point3F</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a6cabca359d2778ce65c69c0afe6a6f6f">mMax</a></td></tr>
  127. <tr class="memdesc:a6cabca359d2778ce65c69c0afe6a6f6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum extents of box. <br /></td></tr>
  128. <tr class="separator:a6cabca359d2778ce65c69c0afe6a6f6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. </table>
  130. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  131. <div class="textblock"><p>Bounding Box</p>
  132. <p>A helper class for working with boxes. It runs at F32 precision.</p>
  133. <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_box3_d.html">Box3D</a> </dd></dl>
  134. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  135. <a id="a943019e7b2f966d033e7b8fdcbd0394c" name="a943019e7b2f966d033e7b8fdcbd0394c"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#a943019e7b2f966d033e7b8fdcbd0394c">&#9670;&#160;</a></span>Box3F() <span class="overload">[1/3]</span></h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <table class="mlabels">
  140. <tr>
  141. <td class="mlabels-left">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname"><a class="el" href="class_box3_f.html">Box3F</a> </td>
  145. <td>(</td>
  146. <td class="paramname"></td><td>)</td>
  147. <td></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. </div>
  157. </div>
  158. <a id="a031e89908dd33bab9d20d43934671901" name="a031e89908dd33bab9d20d43934671901"></a>
  159. <h2 class="memtitle"><span class="permalink"><a href="#a031e89908dd33bab9d20d43934671901">&#9670;&#160;</a></span>Box3F() <span class="overload">[2/3]</span></h2>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <table class="mlabels">
  163. <tr>
  164. <td class="mlabels-left">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname"><a class="el" href="class_box3_f.html">Box3F</a> </td>
  168. <td>(</td>
  169. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  170. <td class="paramname"><em>in_rMin</em>, </td>
  171. </tr>
  172. <tr>
  173. <td class="paramkey"></td>
  174. <td></td>
  175. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  176. <td class="paramname"><em>in_rMax</em>, </td>
  177. </tr>
  178. <tr>
  179. <td class="paramkey"></td>
  180. <td></td>
  181. <td class="paramtype">const bool&#160;</td>
  182. <td class="paramname"><em>in_overrideCheck</em> = <code>false</code>&#160;</td>
  183. </tr>
  184. <tr>
  185. <td></td>
  186. <td>)</td>
  187. <td></td><td></td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. <p>Create a box from two points.</p>
  197. <p>Normally, this function will compensate for mismatched min/max values. If you know your values are valid, you can set in_overrideCheck to true and skip this.</p>
  198. <dl class="params"><dt>Parameters</dt><dd>
  199. <table class="params">
  200. <tr><td class="paramname">in_rMin</td><td>Minimum extents of box. </td></tr>
  201. <tr><td class="paramname">in_rMax</td><td>Maximum extents of box. </td></tr>
  202. <tr><td class="paramname">in_overrideCheck</td><td>Pass true to skip check of extents. </td></tr>
  203. </table>
  204. </dd>
  205. </dl>
  206. </div>
  207. </div>
  208. <a id="a55165a0ef7d5a630d0dc5b6325db2c69" name="a55165a0ef7d5a630d0dc5b6325db2c69"></a>
  209. <h2 class="memtitle"><span class="permalink"><a href="#a55165a0ef7d5a630d0dc5b6325db2c69">&#9670;&#160;</a></span>Box3F() <span class="overload">[3/3]</span></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"><a class="el" href="class_box3_f.html">Box3F</a> </td>
  218. <td>(</td>
  219. <td class="paramtype">F32&#160;</td>
  220. <td class="paramname"><em>xmin</em>, </td>
  221. </tr>
  222. <tr>
  223. <td class="paramkey"></td>
  224. <td></td>
  225. <td class="paramtype">F32&#160;</td>
  226. <td class="paramname"><em>ymin</em>, </td>
  227. </tr>
  228. <tr>
  229. <td class="paramkey"></td>
  230. <td></td>
  231. <td class="paramtype">F32&#160;</td>
  232. <td class="paramname"><em>zmin</em>, </td>
  233. </tr>
  234. <tr>
  235. <td class="paramkey"></td>
  236. <td></td>
  237. <td class="paramtype">F32&#160;</td>
  238. <td class="paramname"><em>max</em>, </td>
  239. </tr>
  240. <tr>
  241. <td class="paramkey"></td>
  242. <td></td>
  243. <td class="paramtype">F32&#160;</td>
  244. <td class="paramname"><em>ymax</em>, </td>
  245. </tr>
  246. <tr>
  247. <td class="paramkey"></td>
  248. <td></td>
  249. <td class="paramtype">F32&#160;</td>
  250. <td class="paramname"><em>zmax</em>&#160;</td>
  251. </tr>
  252. <tr>
  253. <td></td>
  254. <td>)</td>
  255. <td></td><td></td>
  256. </tr>
  257. </table>
  258. </td>
  259. <td class="mlabels-right">
  260. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  261. </tr>
  262. </table>
  263. </div><div class="memdoc">
  264. <p>Create a box from six extent values.</p>
  265. <p>No checking is performed as to the validity of these extents, unlike the other constructor. </p>
  266. </div>
  267. </div>
  268. <h2 class="groupheader">Member Function Documentation</h2>
  269. <a id="a36a1e73aa3b446af1c6c230fe8648622" name="a36a1e73aa3b446af1c6c230fe8648622"></a>
  270. <h2 class="memtitle"><span class="permalink"><a href="#a36a1e73aa3b446af1c6c230fe8648622">&#9670;&#160;</a></span>collideLine() <span class="overload">[1/2]</span></h2>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <table class="memname">
  274. <tr>
  275. <td class="memname">bool collideLine </td>
  276. <td>(</td>
  277. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  278. <td class="paramname"><em>start</em>, </td>
  279. </tr>
  280. <tr>
  281. <td class="paramkey"></td>
  282. <td></td>
  283. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  284. <td class="paramname"><em>end</em>&#160;</td>
  285. </tr>
  286. <tr>
  287. <td></td>
  288. <td>)</td>
  289. <td></td><td> const</td>
  290. </tr>
  291. </table>
  292. </div><div class="memdoc">
  293. <p>Collide a line against the box.</p>
  294. <p>Returns true on collision. </p>
  295. </div>
  296. </div>
  297. <a id="ac62f5922674a34f2415efd01848531db" name="ac62f5922674a34f2415efd01848531db"></a>
  298. <h2 class="memtitle"><span class="permalink"><a href="#ac62f5922674a34f2415efd01848531db">&#9670;&#160;</a></span>collideLine() <span class="overload">[2/2]</span></h2>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <table class="memname">
  302. <tr>
  303. <td class="memname">bool collideLine </td>
  304. <td>(</td>
  305. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  306. <td class="paramname"><em>start</em>, </td>
  307. </tr>
  308. <tr>
  309. <td class="paramkey"></td>
  310. <td></td>
  311. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  312. <td class="paramname"><em>end</em>, </td>
  313. </tr>
  314. <tr>
  315. <td class="paramkey"></td>
  316. <td></td>
  317. <td class="paramtype">F32 *&#160;</td>
  318. <td class="paramname"><em>t</em>, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype"><a class="el" href="class_point3_f.html">Point3F</a> *&#160;</td>
  324. <td class="paramname"><em>n</em>&#160;</td>
  325. </tr>
  326. <tr>
  327. <td></td>
  328. <td>)</td>
  329. <td></td><td> const</td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Collide a line against the box.</p>
  334. <dl class="params"><dt>Parameters</dt><dd>
  335. <table class="params">
  336. <tr><td class="paramname">start</td><td>Start of line. </td></tr>
  337. <tr><td class="paramname">end</td><td>End of line. </td></tr>
  338. <tr><td class="paramname">t</td><td>Value from 0.0-1.0, indicating position along line of collision. </td></tr>
  339. <tr><td class="paramname">n</td><td>Normal of collision. </td></tr>
  340. </table>
  341. </dd>
  342. </dl>
  343. </div>
  344. </div>
  345. <a id="a32de4c910f7d39191261089db3347c82" name="a32de4c910f7d39191261089db3347c82"></a>
  346. <h2 class="memtitle"><span class="permalink"><a href="#a32de4c910f7d39191261089db3347c82">&#9670;&#160;</a></span>collideOrientedBox()</h2>
  347. <div class="memitem">
  348. <div class="memproto">
  349. <table class="memname">
  350. <tr>
  351. <td class="memname">bool collideOrientedBox </td>
  352. <td>(</td>
  353. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  354. <td class="paramname"><em>radii</em>, </td>
  355. </tr>
  356. <tr>
  357. <td class="paramkey"></td>
  358. <td></td>
  359. <td class="paramtype">const <a class="el" href="class_matrix_f.html">MatrixF</a> &amp;&#160;</td>
  360. <td class="paramname"><em>toUs</em>&#160;</td>
  361. </tr>
  362. <tr>
  363. <td></td>
  364. <td>)</td>
  365. <td></td><td> const</td>
  366. </tr>
  367. </table>
  368. </div><div class="memdoc">
  369. <p>Collide an oriented box against the box.</p>
  370. <p>Returns true if "oriented" box collides with us. Assumes incoming box is centered at origin of source space.</p>
  371. <dl class="params"><dt>Parameters</dt><dd>
  372. <table class="params">
  373. <tr><td class="paramname">radii</td><td>The dimension of incoming box (half x,y,z length). </td></tr>
  374. <tr><td class="paramname">toUs</td><td>A transform that takes incoming box into our space. </td></tr>
  375. </table>
  376. </dd>
  377. </dl>
  378. </div>
  379. </div>
  380. <a id="adc6d278d7d187999e54149a3954ce53b" name="adc6d278d7d187999e54149a3954ce53b"></a>
  381. <h2 class="memtitle"><span class="permalink"><a href="#adc6d278d7d187999e54149a3954ce53b">&#9670;&#160;</a></span>getCenter()</h2>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="mlabels">
  385. <tr>
  386. <td class="mlabels-left">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">void getCenter </td>
  390. <td>(</td>
  391. <td class="paramtype"><a class="el" href="class_point3_f.html">Point3F</a> *&#160;</td>
  392. <td class="paramname"><em>center</em></td><td>)</td>
  393. <td> const</td>
  394. </tr>
  395. </table>
  396. </td>
  397. <td class="mlabels-right">
  398. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Get the center of this box.</p>
  403. <p>This is the average of min and mMax. </p>
  404. </div>
  405. </div>
  406. <a id="ab11f92a21705945eb9ec65bd7721e74e" name="ab11f92a21705945eb9ec65bd7721e74e"></a>
  407. <h2 class="memtitle"><span class="permalink"><a href="#ab11f92a21705945eb9ec65bd7721e74e">&#9670;&#160;</a></span>getClosestPoint()</h2>
  408. <div class="memitem">
  409. <div class="memproto">
  410. <table class="mlabels">
  411. <tr>
  412. <td class="mlabels-left">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname"><a class="el" href="class_point3_f.html">Point3F</a> getClosestPoint </td>
  416. <td>(</td>
  417. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  418. <td class="paramname"><em>refPt</em></td><td>)</td>
  419. <td> const</td>
  420. </tr>
  421. </table>
  422. </td>
  423. <td class="mlabels-right">
  424. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  425. </tr>
  426. </table>
  427. </div><div class="memdoc">
  428. <p>Return the closest point of the box, relative to the passed point. </p>
  429. </div>
  430. </div>
  431. <a id="abb777f0ba921fe2b7e7c1a9321af5bb8" name="abb777f0ba921fe2b7e7c1a9321af5bb8"></a>
  432. <h2 class="memtitle"><span class="permalink"><a href="#abb777f0ba921fe2b7e7c1a9321af5bb8">&#9670;&#160;</a></span>intersect() <span class="overload">[1/2]</span></h2>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="mlabels">
  436. <tr>
  437. <td class="mlabels-left">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">void intersect </td>
  441. <td>(</td>
  442. <td class="paramtype">const <a class="el" href="class_box3_f.html">Box3F</a> &amp;&#160;</td>
  443. <td class="paramname"><em>in_rIntersect</em></td><td>)</td>
  444. <td></td>
  445. </tr>
  446. </table>
  447. </td>
  448. <td class="mlabels-right">
  449. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Perform an intersection operation with another box and store the results in this box. </p>
  454. </div>
  455. </div>
  456. <a id="ac9f291362c2ab30c27f0e86173f84b02" name="ac9f291362c2ab30c27f0e86173f84b02"></a>
  457. <h2 class="memtitle"><span class="permalink"><a href="#ac9f291362c2ab30c27f0e86173f84b02">&#9670;&#160;</a></span>intersect() <span class="overload">[2/2]</span></h2>
  458. <div class="memitem">
  459. <div class="memproto">
  460. <table class="mlabels">
  461. <tr>
  462. <td class="mlabels-left">
  463. <table class="memname">
  464. <tr>
  465. <td class="memname">void intersect </td>
  466. <td>(</td>
  467. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  468. <td class="paramname"><em>in_rIntersect</em></td><td>)</td>
  469. <td></td>
  470. </tr>
  471. </table>
  472. </td>
  473. <td class="mlabels-right">
  474. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  475. </tr>
  476. </table>
  477. </div><div class="memdoc">
  478. </div>
  479. </div>
  480. <a id="a6f5954b78a6a59ccfb19505909f2fba5" name="a6f5954b78a6a59ccfb19505909f2fba5"></a>
  481. <h2 class="memtitle"><span class="permalink"><a href="#a6f5954b78a6a59ccfb19505909f2fba5">&#9670;&#160;</a></span>isContained() <span class="overload">[1/2]</span></h2>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="mlabels">
  485. <tr>
  486. <td class="mlabels-left">
  487. <table class="memname">
  488. <tr>
  489. <td class="memname">bool isContained </td>
  490. <td>(</td>
  491. <td class="paramtype">const <a class="el" href="class_box3_f.html">Box3F</a> &amp;&#160;</td>
  492. <td class="paramname"><em>in_rContained</em></td><td>)</td>
  493. <td> const</td>
  494. </tr>
  495. </table>
  496. </td>
  497. <td class="mlabels-right">
  498. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  499. </tr>
  500. </table>
  501. </div><div class="memdoc">
  502. <p>Check to see if another box is contained in this box. </p>
  503. </div>
  504. </div>
  505. <a id="add40f79c4243cb81895acaf38bb1c054" name="add40f79c4243cb81895acaf38bb1c054"></a>
  506. <h2 class="memtitle"><span class="permalink"><a href="#add40f79c4243cb81895acaf38bb1c054">&#9670;&#160;</a></span>isContained() <span class="overload">[2/2]</span></h2>
  507. <div class="memitem">
  508. <div class="memproto">
  509. <table class="mlabels">
  510. <tr>
  511. <td class="mlabels-left">
  512. <table class="memname">
  513. <tr>
  514. <td class="memname">bool isContained </td>
  515. <td>(</td>
  516. <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> &amp;&#160;</td>
  517. <td class="paramname"><em>in_rContained</em></td><td>)</td>
  518. <td> const</td>
  519. </tr>
  520. </table>
  521. </td>
  522. <td class="mlabels-right">
  523. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  524. </tr>
  525. </table>
  526. </div><div class="memdoc">
  527. <p>Check to see if a point is contained in this box. </p>
  528. </div>
  529. </div>
  530. <a id="a6403c9d26de06024f4f2edad24a587ed" name="a6403c9d26de06024f4f2edad24a587ed"></a>
  531. <h2 class="memtitle"><span class="permalink"><a href="#a6403c9d26de06024f4f2edad24a587ed">&#9670;&#160;</a></span>isOverlapped()</h2>
  532. <div class="memitem">
  533. <div class="memproto">
  534. <table class="mlabels">
  535. <tr>
  536. <td class="mlabels-left">
  537. <table class="memname">
  538. <tr>
  539. <td class="memname">bool isOverlapped </td>
  540. <td>(</td>
  541. <td class="paramtype">const <a class="el" href="class_box3_f.html">Box3F</a> &amp;&#160;</td>
  542. <td class="paramname"><em>in_rOverlap</em></td><td>)</td>
  543. <td> const</td>
  544. </tr>
  545. </table>
  546. </td>
  547. <td class="mlabels-right">
  548. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  549. </tr>
  550. </table>
  551. </div><div class="memdoc">
  552. <p>Check to see if another box overlaps this box. </p>
  553. </div>
  554. </div>
  555. <a id="a0bb0171e51f09c6301a50c62d8c8de9b" name="a0bb0171e51f09c6301a50c62d8c8de9b"></a>
  556. <h2 class="memtitle"><span class="permalink"><a href="#a0bb0171e51f09c6301a50c62d8c8de9b">&#9670;&#160;</a></span>isValidBox()</h2>
  557. <div class="memitem">
  558. <div class="memproto">
  559. <table class="mlabels">
  560. <tr>
  561. <td class="mlabels-left">
  562. <table class="memname">
  563. <tr>
  564. <td class="memname">bool isValidBox </td>
  565. <td>(</td>
  566. <td class="paramname"></td><td>)</td>
  567. <td> const</td>
  568. </tr>
  569. </table>
  570. </td>
  571. <td class="mlabels-right">
  572. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  573. </tr>
  574. </table>
  575. </div><div class="memdoc">
  576. <p>Check that the box is valid.</p>
  577. <p>Currently, this just means that min &lt; mMax. </p>
  578. </div>
  579. </div>
  580. <a id="a765b93a7c005c024f0a08819f3ed4c8f" name="a765b93a7c005c024f0a08819f3ed4c8f"></a>
  581. <h2 class="memtitle"><span class="permalink"><a href="#a765b93a7c005c024f0a08819f3ed4c8f">&#9670;&#160;</a></span>len_x()</h2>
  582. <div class="memitem">
  583. <div class="memproto">
  584. <table class="mlabels">
  585. <tr>
  586. <td class="mlabels-left">
  587. <table class="memname">
  588. <tr>
  589. <td class="memname">F32 len_x </td>
  590. <td>(</td>
  591. <td class="paramname"></td><td>)</td>
  592. <td> const</td>
  593. </tr>
  594. </table>
  595. </td>
  596. <td class="mlabels-right">
  597. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  598. </tr>
  599. </table>
  600. </div><div class="memdoc">
  601. </div>
  602. </div>
  603. <a id="ac53343b4f4a67f5f06f7d8990b99b5e4" name="ac53343b4f4a67f5f06f7d8990b99b5e4"></a>
  604. <h2 class="memtitle"><span class="permalink"><a href="#ac53343b4f4a67f5f06f7d8990b99b5e4">&#9670;&#160;</a></span>len_y()</h2>
  605. <div class="memitem">
  606. <div class="memproto">
  607. <table class="mlabels">
  608. <tr>
  609. <td class="mlabels-left">
  610. <table class="memname">
  611. <tr>
  612. <td class="memname">F32 len_y </td>
  613. <td>(</td>
  614. <td class="paramname"></td><td>)</td>
  615. <td> const</td>
  616. </tr>
  617. </table>
  618. </td>
  619. <td class="mlabels-right">
  620. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  621. </tr>
  622. </table>
  623. </div><div class="memdoc">
  624. </div>
  625. </div>
  626. <a id="a039ad6f4926a72e5bd41f6386070ebf9" name="a039ad6f4926a72e5bd41f6386070ebf9"></a>
  627. <h2 class="memtitle"><span class="permalink"><a href="#a039ad6f4926a72e5bd41f6386070ebf9">&#9670;&#160;</a></span>len_z()</h2>
  628. <div class="memitem">
  629. <div class="memproto">
  630. <table class="mlabels">
  631. <tr>
  632. <td class="mlabels-left">
  633. <table class="memname">
  634. <tr>
  635. <td class="memname">F32 len_z </td>
  636. <td>(</td>
  637. <td class="paramname"></td><td>)</td>
  638. <td> const</td>
  639. </tr>
  640. </table>
  641. </td>
  642. <td class="mlabels-right">
  643. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  644. </tr>
  645. </table>
  646. </div><div class="memdoc">
  647. </div>
  648. </div>
  649. <h2 class="groupheader">Member Data Documentation</h2>
  650. <a id="a6cabca359d2778ce65c69c0afe6a6f6f" name="a6cabca359d2778ce65c69c0afe6a6f6f"></a>
  651. <h2 class="memtitle"><span class="permalink"><a href="#a6cabca359d2778ce65c69c0afe6a6f6f">&#9670;&#160;</a></span>mMax</h2>
  652. <div class="memitem">
  653. <div class="memproto">
  654. <table class="memname">
  655. <tr>
  656. <td class="memname"><a class="el" href="class_point3_f.html">Point3F</a> mMax</td>
  657. </tr>
  658. </table>
  659. </div><div class="memdoc">
  660. <p>Maximum extents of box. </p>
  661. </div>
  662. </div>
  663. <a id="acc76c42e59040fb81caccc01b3d077ee" name="acc76c42e59040fb81caccc01b3d077ee"></a>
  664. <h2 class="memtitle"><span class="permalink"><a href="#acc76c42e59040fb81caccc01b3d077ee">&#9670;&#160;</a></span>mMin</h2>
  665. <div class="memitem">
  666. <div class="memproto">
  667. <table class="memname">
  668. <tr>
  669. <td class="memname"><a class="el" href="class_point3_f.html">Point3F</a> mMin</td>
  670. </tr>
  671. </table>
  672. </div><div class="memdoc">
  673. <p>Minimum extents of box. </p>
  674. </div>
  675. </div>
  676. <hr/>The documentation for this class was generated from the following files:<ul>
  677. <li>math/<b>mBox.h</b></li>
  678. <li>math/<b>mBox.cc</b></li>
  679. </ul>
  680. </div><!-- contents -->
  681. <!-- start footer part -->
  682. <hr class="footer"/><address class="footer"><small>
  683. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  684. </small></address>
  685. </body>
  686. </html>