| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.8"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Torque2D Reference: Box3F Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Torque2D Reference
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.8 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-attribs">Public Attributes</a> |
- <a href="class_box3_f-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">Box3F Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p><code>#include <mBox.h></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a943019e7b2f966d033e7b8fdcbd0394c" id="r_a943019e7b2f966d033e7b8fdcbd0394c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a943019e7b2f966d033e7b8fdcbd0394c">Box3F</a> ()</td></tr>
- <tr class="separator:a943019e7b2f966d033e7b8fdcbd0394c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a031e89908dd33bab9d20d43934671901" id="r_a031e89908dd33bab9d20d43934671901"><td class="memItemLeft" align="right" valign="top"> </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> &in_rMin, const <a class="el" href="class_point3_f.html">Point3F</a> &in_rMax, const bool in_overrideCheck=false)</td></tr>
- <tr class="separator:a031e89908dd33bab9d20d43934671901"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a55165a0ef7d5a630d0dc5b6325db2c69" id="r_a55165a0ef7d5a630d0dc5b6325db2c69"><td class="memItemLeft" align="right" valign="top"> </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>
- <tr class="separator:a55165a0ef7d5a630d0dc5b6325db2c69"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:add40f79c4243cb81895acaf38bb1c054" id="r_add40f79c4243cb81895acaf38bb1c054"><td class="memItemLeft" align="right" valign="top">bool </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> &in_rContained) const</td></tr>
- <tr class="memdesc:add40f79c4243cb81895acaf38bb1c054"><td class="mdescLeft"> </td><td class="mdescRight">Check to see if a point is contained in this box. <br /></td></tr>
- <tr class="separator:add40f79c4243cb81895acaf38bb1c054"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6403c9d26de06024f4f2edad24a587ed" id="r_a6403c9d26de06024f4f2edad24a587ed"><td class="memItemLeft" align="right" valign="top">bool </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> &in_rOverlap) const</td></tr>
- <tr class="memdesc:a6403c9d26de06024f4f2edad24a587ed"><td class="mdescLeft"> </td><td class="mdescRight">Check to see if another box overlaps this box. <br /></td></tr>
- <tr class="separator:a6403c9d26de06024f4f2edad24a587ed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6f5954b78a6a59ccfb19505909f2fba5" id="r_a6f5954b78a6a59ccfb19505909f2fba5"><td class="memItemLeft" align="right" valign="top">bool </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> &in_rContained) const</td></tr>
- <tr class="memdesc:a6f5954b78a6a59ccfb19505909f2fba5"><td class="mdescLeft"> </td><td class="mdescRight">Check to see if another box is contained in this box. <br /></td></tr>
- <tr class="separator:a6f5954b78a6a59ccfb19505909f2fba5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a765b93a7c005c024f0a08819f3ed4c8f" id="r_a765b93a7c005c024f0a08819f3ed4c8f"><td class="memItemLeft" align="right" valign="top">F32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a765b93a7c005c024f0a08819f3ed4c8f">len_x</a> () const</td></tr>
- <tr class="separator:a765b93a7c005c024f0a08819f3ed4c8f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac53343b4f4a67f5f06f7d8990b99b5e4" id="r_ac53343b4f4a67f5f06f7d8990b99b5e4"><td class="memItemLeft" align="right" valign="top">F32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#ac53343b4f4a67f5f06f7d8990b99b5e4">len_y</a> () const</td></tr>
- <tr class="separator:ac53343b4f4a67f5f06f7d8990b99b5e4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a039ad6f4926a72e5bd41f6386070ebf9" id="r_a039ad6f4926a72e5bd41f6386070ebf9"><td class="memItemLeft" align="right" valign="top">F32 </td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a039ad6f4926a72e5bd41f6386070ebf9">len_z</a> () const</td></tr>
- <tr class="separator:a039ad6f4926a72e5bd41f6386070ebf9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abb777f0ba921fe2b7e7c1a9321af5bb8" id="r_abb777f0ba921fe2b7e7c1a9321af5bb8"><td class="memItemLeft" align="right" valign="top">void </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> &in_rIntersect)</td></tr>
- <tr class="separator:abb777f0ba921fe2b7e7c1a9321af5bb8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac9f291362c2ab30c27f0e86173f84b02" id="r_ac9f291362c2ab30c27f0e86173f84b02"><td class="memItemLeft" align="right" valign="top">void </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> &in_rIntersect)</td></tr>
- <tr class="separator:ac9f291362c2ab30c27f0e86173f84b02"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adc6d278d7d187999e54149a3954ce53b" id="r_adc6d278d7d187999e54149a3954ce53b"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="separator:adc6d278d7d187999e54149a3954ce53b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac62f5922674a34f2415efd01848531db" id="r_ac62f5922674a34f2415efd01848531db"><td class="memItemLeft" align="right" valign="top">bool </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> &start, const <a class="el" href="class_point3_f.html">Point3F</a> &end, F32 *t, <a class="el" href="class_point3_f.html">Point3F</a> *n) const</td></tr>
- <tr class="separator:ac62f5922674a34f2415efd01848531db"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a36a1e73aa3b446af1c6c230fe8648622" id="r_a36a1e73aa3b446af1c6c230fe8648622"><td class="memItemLeft" align="right" valign="top">bool </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> &start, const <a class="el" href="class_point3_f.html">Point3F</a> &end) const</td></tr>
- <tr class="separator:a36a1e73aa3b446af1c6c230fe8648622"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32de4c910f7d39191261089db3347c82" id="r_a32de4c910f7d39191261089db3347c82"><td class="memItemLeft" align="right" valign="top">bool </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> &radii, const <a class="el" href="class_matrix_f.html">MatrixF</a> &toUs) const</td></tr>
- <tr class="separator:a32de4c910f7d39191261089db3347c82"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0bb0171e51f09c6301a50c62d8c8de9b" id="r_a0bb0171e51f09c6301a50c62d8c8de9b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a0bb0171e51f09c6301a50c62d8c8de9b">isValidBox</a> () const</td></tr>
- <tr class="separator:a0bb0171e51f09c6301a50c62d8c8de9b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab11f92a21705945eb9ec65bd7721e74e" id="r_ab11f92a21705945eb9ec65bd7721e74e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">Point3F</a> </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> &refPt) const</td></tr>
- <tr class="memdesc:ab11f92a21705945eb9ec65bd7721e74e"><td class="mdescLeft"> </td><td class="mdescRight">Return the closest point of the box, relative to the passed point. <br /></td></tr>
- <tr class="separator:ab11f92a21705945eb9ec65bd7721e74e"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
- Public Attributes</h2></td></tr>
- <tr class="memitem:acc76c42e59040fb81caccc01b3d077ee" id="r_acc76c42e59040fb81caccc01b3d077ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">Point3F</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#acc76c42e59040fb81caccc01b3d077ee">mMin</a></td></tr>
- <tr class="memdesc:acc76c42e59040fb81caccc01b3d077ee"><td class="mdescLeft"> </td><td class="mdescRight">Minimum extents of box. <br /></td></tr>
- <tr class="separator:acc76c42e59040fb81caccc01b3d077ee"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6cabca359d2778ce65c69c0afe6a6f6f" id="r_a6cabca359d2778ce65c69c0afe6a6f6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_point3_f.html">Point3F</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_box3_f.html#a6cabca359d2778ce65c69c0afe6a6f6f">mMax</a></td></tr>
- <tr class="memdesc:a6cabca359d2778ce65c69c0afe6a6f6f"><td class="mdescLeft"> </td><td class="mdescRight">Maximum extents of box. <br /></td></tr>
- <tr class="separator:a6cabca359d2778ce65c69c0afe6a6f6f"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Bounding Box</p>
- <p>A helper class for working with boxes. It runs at F32 precision.</p>
- <dl class="section see"><dt>See also</dt><dd><a class="el" href="class_box3_d.html">Box3D</a> </dd></dl>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a943019e7b2f966d033e7b8fdcbd0394c" name="a943019e7b2f966d033e7b8fdcbd0394c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a943019e7b2f966d033e7b8fdcbd0394c">◆ </a></span>Box3F() <span class="overload">[1/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_box3_f.html">Box3F</a> </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a031e89908dd33bab9d20d43934671901" name="a031e89908dd33bab9d20d43934671901"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a031e89908dd33bab9d20d43934671901">◆ </a></span>Box3F() <span class="overload">[2/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_box3_f.html">Box3F</a> </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>in_rMin</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>in_rMax</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const bool </td>
- <td class="paramname"><em>in_overrideCheck</em> = <code>false</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create a box from two points.</p>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">in_rMin</td><td>Minimum extents of box. </td></tr>
- <tr><td class="paramname">in_rMax</td><td>Maximum extents of box. </td></tr>
- <tr><td class="paramname">in_overrideCheck</td><td>Pass true to skip check of extents. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a55165a0ef7d5a630d0dc5b6325db2c69" name="a55165a0ef7d5a630d0dc5b6325db2c69"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a55165a0ef7d5a630d0dc5b6325db2c69">◆ </a></span>Box3F() <span class="overload">[3/3]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_box3_f.html">Box3F</a> </td>
- <td>(</td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>xmin</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>ymin</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>zmin</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>max</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>ymax</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 </td>
- <td class="paramname"><em>zmax</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create a box from six extent values.</p>
- <p>No checking is performed as to the validity of these extents, unlike the other constructor. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a36a1e73aa3b446af1c6c230fe8648622" name="a36a1e73aa3b446af1c6c230fe8648622"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a36a1e73aa3b446af1c6c230fe8648622">◆ </a></span>collideLine() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool collideLine </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>start</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>end</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Collide a line against the box.</p>
- <p>Returns true on collision. </p>
- </div>
- </div>
- <a id="ac62f5922674a34f2415efd01848531db" name="ac62f5922674a34f2415efd01848531db"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac62f5922674a34f2415efd01848531db">◆ </a></span>collideLine() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool collideLine </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>start</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>end</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">F32 * </td>
- <td class="paramname"><em>t</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="class_point3_f.html">Point3F</a> * </td>
- <td class="paramname"><em>n</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Collide a line against the box.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">start</td><td>Start of line. </td></tr>
- <tr><td class="paramname">end</td><td>End of line. </td></tr>
- <tr><td class="paramname">t</td><td>Value from 0.0-1.0, indicating position along line of collision. </td></tr>
- <tr><td class="paramname">n</td><td>Normal of collision. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a32de4c910f7d39191261089db3347c82" name="a32de4c910f7d39191261089db3347c82"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a32de4c910f7d39191261089db3347c82">◆ </a></span>collideOrientedBox()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool collideOrientedBox </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>radii</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="class_matrix_f.html">MatrixF</a> & </td>
- <td class="paramname"><em>toUs</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Collide an oriented box against the box.</p>
- <p>Returns true if "oriented" box collides with us. Assumes incoming box is centered at origin of source space.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">radii</td><td>The dimension of incoming box (half x,y,z length). </td></tr>
- <tr><td class="paramname">toUs</td><td>A transform that takes incoming box into our space. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="adc6d278d7d187999e54149a3954ce53b" name="adc6d278d7d187999e54149a3954ce53b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#adc6d278d7d187999e54149a3954ce53b">◆ </a></span>getCenter()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void getCenter </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="class_point3_f.html">Point3F</a> * </td>
- <td class="paramname"><em>center</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the center of this box.</p>
- <p>This is the average of min and mMax. </p>
- </div>
- </div>
- <a id="ab11f92a21705945eb9ec65bd7721e74e" name="ab11f92a21705945eb9ec65bd7721e74e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab11f92a21705945eb9ec65bd7721e74e">◆ </a></span>getClosestPoint()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_point3_f.html">Point3F</a> getClosestPoint </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>refPt</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the closest point of the box, relative to the passed point. </p>
- </div>
- </div>
- <a id="abb777f0ba921fe2b7e7c1a9321af5bb8" name="abb777f0ba921fe2b7e7c1a9321af5bb8"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abb777f0ba921fe2b7e7c1a9321af5bb8">◆ </a></span>intersect() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void intersect </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_box3_f.html">Box3F</a> & </td>
- <td class="paramname"><em>in_rIntersect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Perform an intersection operation with another box and store the results in this box. </p>
- </div>
- </div>
- <a id="ac9f291362c2ab30c27f0e86173f84b02" name="ac9f291362c2ab30c27f0e86173f84b02"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac9f291362c2ab30c27f0e86173f84b02">◆ </a></span>intersect() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void intersect </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>in_rIntersect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a6f5954b78a6a59ccfb19505909f2fba5" name="a6f5954b78a6a59ccfb19505909f2fba5"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6f5954b78a6a59ccfb19505909f2fba5">◆ </a></span>isContained() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isContained </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_box3_f.html">Box3F</a> & </td>
- <td class="paramname"><em>in_rContained</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Check to see if another box is contained in this box. </p>
- </div>
- </div>
- <a id="add40f79c4243cb81895acaf38bb1c054" name="add40f79c4243cb81895acaf38bb1c054"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#add40f79c4243cb81895acaf38bb1c054">◆ </a></span>isContained() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isContained </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_point3_f.html">Point3F</a> & </td>
- <td class="paramname"><em>in_rContained</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Check to see if a point is contained in this box. </p>
- </div>
- </div>
- <a id="a6403c9d26de06024f4f2edad24a587ed" name="a6403c9d26de06024f4f2edad24a587ed"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6403c9d26de06024f4f2edad24a587ed">◆ </a></span>isOverlapped()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isOverlapped </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="class_box3_f.html">Box3F</a> & </td>
- <td class="paramname"><em>in_rOverlap</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Check to see if another box overlaps this box. </p>
- </div>
- </div>
- <a id="a0bb0171e51f09c6301a50c62d8c8de9b" name="a0bb0171e51f09c6301a50c62d8c8de9b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0bb0171e51f09c6301a50c62d8c8de9b">◆ </a></span>isValidBox()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool isValidBox </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Check that the box is valid.</p>
- <p>Currently, this just means that min < mMax. </p>
- </div>
- </div>
- <a id="a765b93a7c005c024f0a08819f3ed4c8f" name="a765b93a7c005c024f0a08819f3ed4c8f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a765b93a7c005c024f0a08819f3ed4c8f">◆ </a></span>len_x()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">F32 len_x </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac53343b4f4a67f5f06f7d8990b99b5e4" name="ac53343b4f4a67f5f06f7d8990b99b5e4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac53343b4f4a67f5f06f7d8990b99b5e4">◆ </a></span>len_y()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">F32 len_y </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a039ad6f4926a72e5bd41f6386070ebf9" name="a039ad6f4926a72e5bd41f6386070ebf9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a039ad6f4926a72e5bd41f6386070ebf9">◆ </a></span>len_z()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">F32 len_z </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a id="a6cabca359d2778ce65c69c0afe6a6f6f" name="a6cabca359d2778ce65c69c0afe6a6f6f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6cabca359d2778ce65c69c0afe6a6f6f">◆ </a></span>mMax</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_point3_f.html">Point3F</a> mMax</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Maximum extents of box. </p>
- </div>
- </div>
- <a id="acc76c42e59040fb81caccc01b3d077ee" name="acc76c42e59040fb81caccc01b3d077ee"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#acc76c42e59040fb81caccc01b3d077ee">◆ </a></span>mMin</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="class_point3_f.html">Point3F</a> mMin</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Minimum extents of box. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>math/<b>mBox.h</b></li>
- <li>math/<b>mBox.cc</b></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
- </small></address>
- </body>
- </html>
|