class_box3_d.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401
  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: Box3D 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_d-members.html">List of all members</a> </div>
  75. <div class="headertitle"><div class="title">Box3D 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:ae90342a42f0af112e99976ba2e33dd36" id="r_ae90342a42f0af112e99976ba2e33dd36"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#ae90342a42f0af112e99976ba2e33dd36">Box3D</a> ()</td></tr>
  83. <tr class="separator:ae90342a42f0af112e99976ba2e33dd36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a74f6a114c042f91568bdb73c046742de" id="r_a74f6a114c042f91568bdb73c046742de"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a74f6a114c042f91568bdb73c046742de">Box3D</a> (const <a class="el" href="class_point3_d.html">Point3D</a> &amp;in_rMin, const <a class="el" href="class_point3_d.html">Point3D</a> &amp;in_rMax, const bool in_overrideCheck=false)</td></tr>
  85. <tr class="separator:a74f6a114c042f91568bdb73c046742de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ad614f0934b5a3d3df97595d32c82d570" id="r_ad614f0934b5a3d3df97595d32c82d570"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#ad614f0934b5a3d3df97595d32c82d570">isContained</a> (const <a class="el" href="class_point3_d.html">Point3D</a> &amp;in_rContained) const</td></tr>
  87. <tr class="separator:ad614f0934b5a3d3df97595d32c82d570"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a9141e00b1f0e5e994f760985042e567b" id="r_a9141e00b1f0e5e994f760985042e567b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a9141e00b1f0e5e994f760985042e567b">isOverlapped</a> (const <a class="el" href="class_box3_d.html">Box3D</a> &amp;in_rOverlap) const</td></tr>
  89. <tr class="separator:a9141e00b1f0e5e994f760985042e567b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:acdb1f113056c98e33ff3d10b09321825" id="r_acdb1f113056c98e33ff3d10b09321825"><td class="memItemLeft" align="right" valign="top">F64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#acdb1f113056c98e33ff3d10b09321825">len_x</a> () const</td></tr>
  91. <tr class="separator:acdb1f113056c98e33ff3d10b09321825"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a873049aabd952fab29ddc17f89245d1b" id="r_a873049aabd952fab29ddc17f89245d1b"><td class="memItemLeft" align="right" valign="top">F64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a873049aabd952fab29ddc17f89245d1b">len_y</a> () const</td></tr>
  93. <tr class="separator:a873049aabd952fab29ddc17f89245d1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a53a5ce994b83ec9b405be19976ce83f7" id="r_a53a5ce994b83ec9b405be19976ce83f7"><td class="memItemLeft" align="right" valign="top">F64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a53a5ce994b83ec9b405be19976ce83f7">len_z</a> () const</td></tr>
  95. <tr class="separator:a53a5ce994b83ec9b405be19976ce83f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a5e2c8091f951562c71f3a9229bc9cc28" id="r_a5e2c8091f951562c71f3a9229bc9cc28"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a5e2c8091f951562c71f3a9229bc9cc28">intersect</a> (const <a class="el" href="class_box3_d.html">Box3D</a> &amp;in_rIntersect)</td></tr>
  97. <tr class="separator:a5e2c8091f951562c71f3a9229bc9cc28"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a9cc8b2bb3ba37fb82989749e386c91ec" id="r_a9cc8b2bb3ba37fb82989749e386c91ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a9cc8b2bb3ba37fb82989749e386c91ec">getCenter</a> (<a class="el" href="class_point3_d.html">Point3D</a> *center) const</td></tr>
  99. <tr class="separator:a9cc8b2bb3ba37fb82989749e386c91ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table><table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  102. Public Attributes</h2></td></tr>
  103. <tr class="memitem:a43fd2872d1c6077a1d7e34b463c0379b" id="r_a43fd2872d1c6077a1d7e34b463c0379b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_d.html">Point3D</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a43fd2872d1c6077a1d7e34b463c0379b">mMin</a></td></tr>
  104. <tr class="separator:a43fd2872d1c6077a1d7e34b463c0379b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a330fbfa657c9b79ea5b71ae4083bb5d4" id="r_a330fbfa657c9b79ea5b71ae4083bb5d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_d.html">Point3D</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_d.html#a330fbfa657c9b79ea5b71ae4083bb5d4">mMax</a></td></tr>
  106. <tr class="separator:a330fbfa657c9b79ea5b71ae4083bb5d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table>
  108. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  109. <div class="textblock"><p>Clone of <a class="el" href="class_box3_f.html">Box3F</a>, using 3D types.</p>
  110. <p>3D types use F64.</p>
  111. <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_box3_f.html">Box3F</a> </dd></dl>
  112. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  113. <a id="ae90342a42f0af112e99976ba2e33dd36" name="ae90342a42f0af112e99976ba2e33dd36"></a>
  114. <h2 class="memtitle"><span class="permalink"><a href="#ae90342a42f0af112e99976ba2e33dd36">&#9670;&#160;</a></span>Box3D() <span class="overload">[1/2]</span></h2>
  115. <div class="memitem">
  116. <div class="memproto">
  117. <table class="mlabels">
  118. <tr>
  119. <td class="mlabels-left">
  120. <table class="memname">
  121. <tr>
  122. <td class="memname"><a class="el" href="class_box3_d.html">Box3D</a> </td>
  123. <td>(</td>
  124. <td class="paramname"></td><td>)</td>
  125. <td></td>
  126. </tr>
  127. </table>
  128. </td>
  129. <td class="mlabels-right">
  130. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  131. </tr>
  132. </table>
  133. </div><div class="memdoc">
  134. </div>
  135. </div>
  136. <a id="a74f6a114c042f91568bdb73c046742de" name="a74f6a114c042f91568bdb73c046742de"></a>
  137. <h2 class="memtitle"><span class="permalink"><a href="#a74f6a114c042f91568bdb73c046742de">&#9670;&#160;</a></span>Box3D() <span class="overload">[2/2]</span></h2>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <table class="mlabels">
  141. <tr>
  142. <td class="mlabels-left">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname"><a class="el" href="class_box3_d.html">Box3D</a> </td>
  146. <td>(</td>
  147. <td class="paramtype">const <a class="el" href="class_point3_d.html">Point3D</a> &amp;&#160;</td>
  148. <td class="paramname"><em>in_rMin</em>, </td>
  149. </tr>
  150. <tr>
  151. <td class="paramkey"></td>
  152. <td></td>
  153. <td class="paramtype">const <a class="el" href="class_point3_d.html">Point3D</a> &amp;&#160;</td>
  154. <td class="paramname"><em>in_rMax</em>, </td>
  155. </tr>
  156. <tr>
  157. <td class="paramkey"></td>
  158. <td></td>
  159. <td class="paramtype">const bool&#160;</td>
  160. <td class="paramname"><em>in_overrideCheck</em> = <code>false</code>&#160;</td>
  161. </tr>
  162. <tr>
  163. <td></td>
  164. <td>)</td>
  165. <td></td><td></td>
  166. </tr>
  167. </table>
  168. </td>
  169. <td class="mlabels-right">
  170. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  171. </tr>
  172. </table>
  173. </div><div class="memdoc">
  174. </div>
  175. </div>
  176. <h2 class="groupheader">Member Function Documentation</h2>
  177. <a id="a9cc8b2bb3ba37fb82989749e386c91ec" name="a9cc8b2bb3ba37fb82989749e386c91ec"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#a9cc8b2bb3ba37fb82989749e386c91ec">&#9670;&#160;</a></span>getCenter()</h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <table class="mlabels">
  182. <tr>
  183. <td class="mlabels-left">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">void getCenter </td>
  187. <td>(</td>
  188. <td class="paramtype"><a class="el" href="class_point3_d.html">Point3D</a> *&#160;</td>
  189. <td class="paramname"><em>center</em></td><td>)</td>
  190. <td> const</td>
  191. </tr>
  192. </table>
  193. </td>
  194. <td class="mlabels-right">
  195. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. </div>
  200. </div>
  201. <a id="a5e2c8091f951562c71f3a9229bc9cc28" name="a5e2c8091f951562c71f3a9229bc9cc28"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#a5e2c8091f951562c71f3a9229bc9cc28">&#9670;&#160;</a></span>intersect()</h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="mlabels">
  206. <tr>
  207. <td class="mlabels-left">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">void intersect </td>
  211. <td>(</td>
  212. <td class="paramtype">const <a class="el" href="class_box3_d.html">Box3D</a> &amp;&#160;</td>
  213. <td class="paramname"><em>in_rIntersect</em></td><td>)</td>
  214. <td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. </div>
  224. </div>
  225. <a id="ad614f0934b5a3d3df97595d32c82d570" name="ad614f0934b5a3d3df97595d32c82d570"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#ad614f0934b5a3d3df97595d32c82d570">&#9670;&#160;</a></span>isContained()</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">bool isContained </td>
  235. <td>(</td>
  236. <td class="paramtype">const <a class="el" href="class_point3_d.html">Point3D</a> &amp;&#160;</td>
  237. <td class="paramname"><em>in_rContained</em></td><td>)</td>
  238. <td> const</td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. </div>
  248. </div>
  249. <a id="a9141e00b1f0e5e994f760985042e567b" name="a9141e00b1f0e5e994f760985042e567b"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#a9141e00b1f0e5e994f760985042e567b">&#9670;&#160;</a></span>isOverlapped()</h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <table class="mlabels">
  254. <tr>
  255. <td class="mlabels-left">
  256. <table class="memname">
  257. <tr>
  258. <td class="memname">bool isOverlapped </td>
  259. <td>(</td>
  260. <td class="paramtype">const <a class="el" href="class_box3_d.html">Box3D</a> &amp;&#160;</td>
  261. <td class="paramname"><em>in_rOverlap</em></td><td>)</td>
  262. <td> const</td>
  263. </tr>
  264. </table>
  265. </td>
  266. <td class="mlabels-right">
  267. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. </div>
  272. </div>
  273. <a id="acdb1f113056c98e33ff3d10b09321825" name="acdb1f113056c98e33ff3d10b09321825"></a>
  274. <h2 class="memtitle"><span class="permalink"><a href="#acdb1f113056c98e33ff3d10b09321825">&#9670;&#160;</a></span>len_x()</h2>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <table class="mlabels">
  278. <tr>
  279. <td class="mlabels-left">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">F64 len_x </td>
  283. <td>(</td>
  284. <td class="paramname"></td><td>)</td>
  285. <td> const</td>
  286. </tr>
  287. </table>
  288. </td>
  289. <td class="mlabels-right">
  290. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. </div>
  295. </div>
  296. <a id="a873049aabd952fab29ddc17f89245d1b" name="a873049aabd952fab29ddc17f89245d1b"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#a873049aabd952fab29ddc17f89245d1b">&#9670;&#160;</a></span>len_y()</h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">F64 len_y </td>
  306. <td>(</td>
  307. <td class="paramname"></td><td>)</td>
  308. <td> const</td>
  309. </tr>
  310. </table>
  311. </td>
  312. <td class="mlabels-right">
  313. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. </div>
  318. </div>
  319. <a id="a53a5ce994b83ec9b405be19976ce83f7" name="a53a5ce994b83ec9b405be19976ce83f7"></a>
  320. <h2 class="memtitle"><span class="permalink"><a href="#a53a5ce994b83ec9b405be19976ce83f7">&#9670;&#160;</a></span>len_z()</h2>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <table class="mlabels">
  324. <tr>
  325. <td class="mlabels-left">
  326. <table class="memname">
  327. <tr>
  328. <td class="memname">F64 len_z </td>
  329. <td>(</td>
  330. <td class="paramname"></td><td>)</td>
  331. <td> const</td>
  332. </tr>
  333. </table>
  334. </td>
  335. <td class="mlabels-right">
  336. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  337. </tr>
  338. </table>
  339. </div><div class="memdoc">
  340. </div>
  341. </div>
  342. <h2 class="groupheader">Member Data Documentation</h2>
  343. <a id="a330fbfa657c9b79ea5b71ae4083bb5d4" name="a330fbfa657c9b79ea5b71ae4083bb5d4"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a330fbfa657c9b79ea5b71ae4083bb5d4">&#9670;&#160;</a></span>mMax</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname"><a class="el" href="class_point3_d.html">Point3D</a> mMax</td>
  350. </tr>
  351. </table>
  352. </div><div class="memdoc">
  353. </div>
  354. </div>
  355. <a id="a43fd2872d1c6077a1d7e34b463c0379b" name="a43fd2872d1c6077a1d7e34b463c0379b"></a>
  356. <h2 class="memtitle"><span class="permalink"><a href="#a43fd2872d1c6077a1d7e34b463c0379b">&#9670;&#160;</a></span>mMin</h2>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <table class="memname">
  360. <tr>
  361. <td class="memname"><a class="el" href="class_point3_d.html">Point3D</a> mMin</td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. </div>
  366. </div>
  367. <hr/>The documentation for this class was generated from the following file:<ul>
  368. <li>math/<b>mBox.h</b></li>
  369. </ul>
  370. </div><!-- contents -->
  371. <!-- start footer part -->
  372. <hr class="footer"/><address class="footer"><small>
  373. 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
  374. </small></address>
  375. </body>
  376. </html>