classgameplay_1_1_frustum.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Frustum Class Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  9. <link href="custom.css" rel="stylesheet" type="text/css" />
  10. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  11. <script type="text/javascript" src="jquery.js"></script>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div! -->
  19. <table class="header" border="0">
  20. <tbody>
  21. <tr>
  22. <td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
  23. <td width="100%"/>
  24. <td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
  25. <td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
  26. <td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
  27. <td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. <!-- Generated by Doxygen 1.7.6.1 -->
  32. <script type="text/javascript">
  33. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  34. </script>
  35. <div id="navrow1" class="tabs">
  36. <ul class="tablist">
  37. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  38. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  39. <li>
  40. <div id="MSearchBox" class="MSearchBoxInactive">
  41. <span class="left">
  42. <img id="MSearchSelect" src="search/mag_sel.png"
  43. onmouseover="return searchBox.OnSearchSelectShow()"
  44. onmouseout="return searchBox.OnSearchSelectHide()"
  45. alt=""/>
  46. <input type="text" id="MSearchField" value="Search" accesskey="S"
  47. onfocus="searchBox.OnSearchFieldFocus(true)"
  48. onblur="searchBox.OnSearchFieldFocus(false)"
  49. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  50. </span><span class="right">
  51. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  52. </span>
  53. </div>
  54. </li>
  55. </ul>
  56. </div>
  57. <div id="navrow2" class="tabs2">
  58. <ul class="tablist">
  59. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  60. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  61. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  62. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  63. </ul>
  64. </div>
  65. <!-- window showing the filter options -->
  66. <div id="MSearchSelectWindow"
  67. onmouseover="return searchBox.OnSearchSelectShow()"
  68. onmouseout="return searchBox.OnSearchSelectHide()"
  69. onkeydown="return searchBox.OnSearchSelectKey(event)">
  70. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  71. <!-- iframe showing the search results (closed by default) -->
  72. <div id="MSearchResultsWindow">
  73. <iframe src="javascript:void(0)" frameborder="0"
  74. name="MSearchResults" id="MSearchResults">
  75. </iframe>
  76. </div>
  77. <div id="nav-path" class="navpath">
  78. <ul>
  79. <li class="navelem"><b>gameplay</b> </li>
  80. <li class="navelem"><a class="el" href="classgameplay_1_1_frustum.html">Frustum</a> </li>
  81. </ul>
  82. </div>
  83. </div>
  84. <div class="header">
  85. <div class="summary">
  86. <a href="#pub-methods">Public Member Functions</a> </div>
  87. <div class="headertitle">
  88. <div class="title">gameplay::Frustum Class Reference</div> </div>
  89. </div><!--header-->
  90. <div class="contents">
  91. <!-- doxytag: class="gameplay::Frustum" -->
  92. <p><code>#include &lt;Frustum.h&gt;</code></p>
  93. <p><a href="classgameplay_1_1_frustum-members.html">List of all members.</a></p>
  94. <table class="memberdecls">
  95. <tr><td colspan="2"><h2><a name="pub-methods"></a>
  96. Public Member Functions</h2></td></tr>
  97. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a592778a70f00d2e7438481e968208e93">Frustum</a> ()</td></tr>
  98. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#ab48e7150951e5247e6901624e3781d65">Frustum</a> (const <a class="el" href="classgameplay_1_1_matrix.html">Matrix</a> &amp;matrix)</td></tr>
  99. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a96d45ad30ba1bdf4c3ad91b8ecde6963">Frustum</a> (const <a class="el" href="classgameplay_1_1_frustum.html">Frustum</a> &amp;frustum)</td></tr>
  100. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a0e5615de855608f7359364282ee45b73">~Frustum</a> ()</td></tr>
  101. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#af1bc8533dd9791ab2114552c34b3b1b9">getNear</a> () const </td></tr>
  102. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a201a20084dbbd2c1b557ec70a687b8a9">getFar</a> () const </td></tr>
  103. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a63da043797d8768e9307459c107e7c56">getLeft</a> () const </td></tr>
  104. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#ad6cd6a1803c36662f5c58ff7baf31596">getRight</a> () const </td></tr>
  105. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#aa9492ad1056e134d820f5a8cb5a45a90">getBottom</a> () const </td></tr>
  106. <tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#ac9135b4becaea0698c29e5d43cda72a9">getTop</a> () const </td></tr>
  107. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#ad1ae967dc50ed4c262af0727cf4a701d">getMatrix</a> (<a class="el" href="classgameplay_1_1_matrix.html">Matrix</a> *dst) const </td></tr>
  108. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a2570da2f955daec8fb44a95fe25af049">getCorners</a> (<a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> *corners) const </td></tr>
  109. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a50294637b164c85b164da850cfde0a35">getNearCorners</a> (<a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> *corners) const </td></tr>
  110. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#ad15680f12579a40d94600aec6cff7384">getFarCorners</a> (<a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> *corners) const </td></tr>
  111. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a796be313f7c0d1e4f9e604eca635cd33">intersects</a> (const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;point) const </td></tr>
  112. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#aec557e485662234c4d36b616d11b4ab0">intersects</a> (float x, float y, float z) const </td></tr>
  113. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a36cccd1d74cec754ffc8d4a239f60521">intersects</a> (const <a class="el" href="classgameplay_1_1_bounding_sphere.html">BoundingSphere</a> &amp;sphere) const </td></tr>
  114. <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#a30b343395cbc095eb70144e1f81caf03">intersects</a> (const <a class="el" href="classgameplay_1_1_bounding_box.html">BoundingBox</a> &amp;box) const </td></tr>
  115. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#af0e15b937bf1146962b02045d2be03ef">intersects</a> (const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;plane) const </td></tr>
  116. <tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#aba6a55c86c0821f2ed58afdabc0a0a1e">intersects</a> (const <a class="el" href="classgameplay_1_1_ray.html">Ray</a> &amp;ray) const </td></tr>
  117. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#afb4092a1bcf95d34f095a339c070bf1d">set</a> (const <a class="el" href="classgameplay_1_1_frustum.html">Frustum</a> &amp;frustum)</td></tr>
  118. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_frustum.html#ac0d38971b895ff8955d0ad9ea8b5fbb5">set</a> (const <a class="el" href="classgameplay_1_1_matrix.html">Matrix</a> &amp;matrix)</td></tr>
  119. </table>
  120. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
  121. <div class="textblock"><p>Defines a 3-dimensional frustum.</p>
  122. <p>A frustum in computer graphics is generally a volume of 3D space, defined as the part of a rectangular pyramid that lies between two planes perpendicular to its center line. A frustum is often used to represent what a "camera" sees in your 3D space.</p>
  123. <p>The <a class="el" href="classgameplay_1_1_frustum.html">Frustum</a> class allows you to define a bounding frustum using a combined matrix that is generally the product of a view matrix and a projection matrix.</p>
  124. <p>You can query a <a class="el" href="classgameplay_1_1_frustum.html">Frustum</a> object for any one of its bounding planes, for its corners, and for whether it intersects with a given object. Since objects that don't intersect with your view frustum generally don't need to be rendered, culling them quickly can save you a lot of rendering time. </p>
  125. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
  126. <a class="anchor" id="a592778a70f00d2e7438481e968208e93"></a><!-- doxytag: member="gameplay::Frustum::Frustum" ref="a592778a70f00d2e7438481e968208e93" args="()" -->
  127. <div class="memitem">
  128. <div class="memproto">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname"><a class="el" href="classgameplay_1_1_frustum.html#a592778a70f00d2e7438481e968208e93">gameplay::Frustum::Frustum</a> </td>
  132. <td>(</td>
  133. <td class="paramname"></td><td>)</td>
  134. <td></td>
  135. </tr>
  136. </table>
  137. </div>
  138. <div class="memdoc">
  139. <p>Constructs the default frustum (corresponds to the identity matrix). </p>
  140. </div>
  141. </div>
  142. <a class="anchor" id="ab48e7150951e5247e6901624e3781d65"></a><!-- doxytag: member="gameplay::Frustum::Frustum" ref="ab48e7150951e5247e6901624e3781d65" args="(const Matrix &amp;matrix)" -->
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname"><a class="el" href="classgameplay_1_1_frustum.html#a592778a70f00d2e7438481e968208e93">gameplay::Frustum::Frustum</a> </td>
  148. <td>(</td>
  149. <td class="paramtype">const <a class="el" href="classgameplay_1_1_matrix.html">Matrix</a> &amp;&#160;</td>
  150. <td class="paramname"><em>matrix</em></td><td>)</td>
  151. <td></td>
  152. </tr>
  153. </table>
  154. </div>
  155. <div class="memdoc">
  156. <p>Constructs a new frustum from the specified view projection matrix.</p>
  157. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  158. <table class="params">
  159. <tr><td class="paramname">matrix</td><td>The view projection matrix to create this frustum from. </td></tr>
  160. </table>
  161. </dd>
  162. </dl>
  163. </div>
  164. </div>
  165. <a class="anchor" id="a96d45ad30ba1bdf4c3ad91b8ecde6963"></a><!-- doxytag: member="gameplay::Frustum::Frustum" ref="a96d45ad30ba1bdf4c3ad91b8ecde6963" args="(const Frustum &amp;frustum)" -->
  166. <div class="memitem">
  167. <div class="memproto">
  168. <table class="memname">
  169. <tr>
  170. <td class="memname"><a class="el" href="classgameplay_1_1_frustum.html#a592778a70f00d2e7438481e968208e93">gameplay::Frustum::Frustum</a> </td>
  171. <td>(</td>
  172. <td class="paramtype">const <a class="el" href="classgameplay_1_1_frustum.html">Frustum</a> &amp;&#160;</td>
  173. <td class="paramname"><em>frustum</em></td><td>)</td>
  174. <td></td>
  175. </tr>
  176. </table>
  177. </div>
  178. <div class="memdoc">
  179. <p>Constructs a new frustum from the given frustum.</p>
  180. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  181. <table class="params">
  182. <tr><td class="paramname">frustum</td><td>The frustum to create this frustum from. </td></tr>
  183. </table>
  184. </dd>
  185. </dl>
  186. </div>
  187. </div>
  188. <a class="anchor" id="a0e5615de855608f7359364282ee45b73"></a><!-- doxytag: member="gameplay::Frustum::~Frustum" ref="a0e5615de855608f7359364282ee45b73" args="()" -->
  189. <div class="memitem">
  190. <div class="memproto">
  191. <table class="memname">
  192. <tr>
  193. <td class="memname"><a class="el" href="classgameplay_1_1_frustum.html#a0e5615de855608f7359364282ee45b73">gameplay::Frustum::~Frustum</a> </td>
  194. <td>(</td>
  195. <td class="paramname"></td><td>)</td>
  196. <td></td>
  197. </tr>
  198. </table>
  199. </div>
  200. <div class="memdoc">
  201. <p>Destructor. </p>
  202. </div>
  203. </div>
  204. <hr/><h2>Member Function Documentation</h2>
  205. <a class="anchor" id="aa9492ad1056e134d820f5a8cb5a45a90"></a><!-- doxytag: member="gameplay::Frustum::getBottom" ref="aa9492ad1056e134d820f5a8cb5a45a90" args="() const " -->
  206. <div class="memitem">
  207. <div class="memproto">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a>&amp; <a class="el" href="classgameplay_1_1_frustum.html#aa9492ad1056e134d820f5a8cb5a45a90">gameplay::Frustum::getBottom</a> </td>
  211. <td>(</td>
  212. <td class="paramname"></td><td>)</td>
  213. <td> const</td>
  214. </tr>
  215. </table>
  216. </div>
  217. <div class="memdoc">
  218. <p>Gets the bottom plane of the frustum.</p>
  219. <dl class="return"><dt><b>Returns:</b></dt><dd>bottom The bottom plane. </dd></dl>
  220. </div>
  221. </div>
  222. <a class="anchor" id="a2570da2f955daec8fb44a95fe25af049"></a><!-- doxytag: member="gameplay::Frustum::getCorners" ref="a2570da2f955daec8fb44a95fe25af049" args="(Vector3 *corners) const " -->
  223. <div class="memitem">
  224. <div class="memproto">
  225. <table class="memname">
  226. <tr>
  227. <td class="memname">void <a class="el" href="classgameplay_1_1_frustum.html#a2570da2f955daec8fb44a95fe25af049">gameplay::Frustum::getCorners</a> </td>
  228. <td>(</td>
  229. <td class="paramtype"><a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> *&#160;</td>
  230. <td class="paramname"><em>corners</em></td><td>)</td>
  231. <td> const</td>
  232. </tr>
  233. </table>
  234. </div>
  235. <div class="memdoc">
  236. <p>Gets the corners of the frustum in the specified array.</p>
  237. <p>The corners are stored in the following order: (N-near, F-far, L-left, R-right, B-bottom, T-top) LTN, LBN, RBN, RTN, RTF, RBF, LBF, LTF.</p>
  238. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  239. <table class="params">
  240. <tr><td class="paramname">corners</td><td>The array (of at least size 8) to store the corners in. </td></tr>
  241. </table>
  242. </dd>
  243. </dl>
  244. </div>
  245. </div>
  246. <a class="anchor" id="a201a20084dbbd2c1b557ec70a687b8a9"></a><!-- doxytag: member="gameplay::Frustum::getFar" ref="a201a20084dbbd2c1b557ec70a687b8a9" args="() const " -->
  247. <div class="memitem">
  248. <div class="memproto">
  249. <table class="memname">
  250. <tr>
  251. <td class="memname">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a>&amp; <a class="el" href="classgameplay_1_1_frustum.html#a201a20084dbbd2c1b557ec70a687b8a9">gameplay::Frustum::getFar</a> </td>
  252. <td>(</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td> const</td>
  255. </tr>
  256. </table>
  257. </div>
  258. <div class="memdoc">
  259. <p>Gets the far plane of the frustum.</p>
  260. <dl class="return"><dt><b>Returns:</b></dt><dd>far The far plane. </dd></dl>
  261. </div>
  262. </div>
  263. <a class="anchor" id="ad15680f12579a40d94600aec6cff7384"></a><!-- doxytag: member="gameplay::Frustum::getFarCorners" ref="ad15680f12579a40d94600aec6cff7384" args="(Vector3 *corners) const " -->
  264. <div class="memitem">
  265. <div class="memproto">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">void <a class="el" href="classgameplay_1_1_frustum.html#ad15680f12579a40d94600aec6cff7384">gameplay::Frustum::getFarCorners</a> </td>
  269. <td>(</td>
  270. <td class="paramtype"><a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> *&#160;</td>
  271. <td class="paramname"><em>corners</em></td><td>)</td>
  272. <td> const</td>
  273. </tr>
  274. </table>
  275. </div>
  276. <div class="memdoc">
  277. <p>Gets the corners of the frustum's far plane in the specified array.</p>
  278. <p>The corners are stored in the following order: right-top, right-bottom, left-bottom, left-top.</p>
  279. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  280. <table class="params">
  281. <tr><td class="paramname">corners</td><td>The array (of at least size 4) to store the corners in. </td></tr>
  282. </table>
  283. </dd>
  284. </dl>
  285. </div>
  286. </div>
  287. <a class="anchor" id="a63da043797d8768e9307459c107e7c56"></a><!-- doxytag: member="gameplay::Frustum::getLeft" ref="a63da043797d8768e9307459c107e7c56" args="() const " -->
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a>&amp; <a class="el" href="classgameplay_1_1_frustum.html#a63da043797d8768e9307459c107e7c56">gameplay::Frustum::getLeft</a> </td>
  293. <td>(</td>
  294. <td class="paramname"></td><td>)</td>
  295. <td> const</td>
  296. </tr>
  297. </table>
  298. </div>
  299. <div class="memdoc">
  300. <p>Gets the left plane of the frustum.</p>
  301. <dl class="return"><dt><b>Returns:</b></dt><dd>left The left plane. </dd></dl>
  302. </div>
  303. </div>
  304. <a class="anchor" id="ad1ae967dc50ed4c262af0727cf4a701d"></a><!-- doxytag: member="gameplay::Frustum::getMatrix" ref="ad1ae967dc50ed4c262af0727cf4a701d" args="(Matrix *dst) const " -->
  305. <div class="memitem">
  306. <div class="memproto">
  307. <table class="memname">
  308. <tr>
  309. <td class="memname">void <a class="el" href="classgameplay_1_1_frustum.html#ad1ae967dc50ed4c262af0727cf4a701d">gameplay::Frustum::getMatrix</a> </td>
  310. <td>(</td>
  311. <td class="paramtype"><a class="el" href="classgameplay_1_1_matrix.html">Matrix</a> *&#160;</td>
  312. <td class="paramname"><em>dst</em></td><td>)</td>
  313. <td> const</td>
  314. </tr>
  315. </table>
  316. </div>
  317. <div class="memdoc">
  318. <p>Gets the projection matrix corresponding to the frustum in the specified matrix.</p>
  319. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  320. <table class="params">
  321. <tr><td class="paramname">dst</td><td>The projection matrix to copy into. </td></tr>
  322. </table>
  323. </dd>
  324. </dl>
  325. </div>
  326. </div>
  327. <a class="anchor" id="af1bc8533dd9791ab2114552c34b3b1b9"></a><!-- doxytag: member="gameplay::Frustum::getNear" ref="af1bc8533dd9791ab2114552c34b3b1b9" args="() const " -->
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="memname">
  331. <tr>
  332. <td class="memname">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a>&amp; <a class="el" href="classgameplay_1_1_frustum.html#af1bc8533dd9791ab2114552c34b3b1b9">gameplay::Frustum::getNear</a> </td>
  333. <td>(</td>
  334. <td class="paramname"></td><td>)</td>
  335. <td> const</td>
  336. </tr>
  337. </table>
  338. </div>
  339. <div class="memdoc">
  340. <p>Gets the near plane of the frustum.</p>
  341. <dl class="return"><dt><b>Returns:</b></dt><dd>near The near plane. </dd></dl>
  342. </div>
  343. </div>
  344. <a class="anchor" id="a50294637b164c85b164da850cfde0a35"></a><!-- doxytag: member="gameplay::Frustum::getNearCorners" ref="a50294637b164c85b164da850cfde0a35" args="(Vector3 *corners) const " -->
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">void <a class="el" href="classgameplay_1_1_frustum.html#a50294637b164c85b164da850cfde0a35">gameplay::Frustum::getNearCorners</a> </td>
  350. <td>(</td>
  351. <td class="paramtype"><a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> *&#160;</td>
  352. <td class="paramname"><em>corners</em></td><td>)</td>
  353. <td> const</td>
  354. </tr>
  355. </table>
  356. </div>
  357. <div class="memdoc">
  358. <p>Gets the corners of the frustum's near plane in the specified array.</p>
  359. <p>The corners are stored in the following order: left-top, left-bottom, right-bottom, right-top.</p>
  360. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  361. <table class="params">
  362. <tr><td class="paramname">corners</td><td>The array (of at least size 4) to store the corners in. </td></tr>
  363. </table>
  364. </dd>
  365. </dl>
  366. </div>
  367. </div>
  368. <a class="anchor" id="ad6cd6a1803c36662f5c58ff7baf31596"></a><!-- doxytag: member="gameplay::Frustum::getRight" ref="ad6cd6a1803c36662f5c58ff7baf31596" args="() const " -->
  369. <div class="memitem">
  370. <div class="memproto">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a>&amp; <a class="el" href="classgameplay_1_1_frustum.html#ad6cd6a1803c36662f5c58ff7baf31596">gameplay::Frustum::getRight</a> </td>
  374. <td>(</td>
  375. <td class="paramname"></td><td>)</td>
  376. <td> const</td>
  377. </tr>
  378. </table>
  379. </div>
  380. <div class="memdoc">
  381. <p>Gets the right plane of the frustum.</p>
  382. <dl class="return"><dt><b>Returns:</b></dt><dd>right The right plane. </dd></dl>
  383. </div>
  384. </div>
  385. <a class="anchor" id="ac9135b4becaea0698c29e5d43cda72a9"></a><!-- doxytag: member="gameplay::Frustum::getTop" ref="ac9135b4becaea0698c29e5d43cda72a9" args="() const " -->
  386. <div class="memitem">
  387. <div class="memproto">
  388. <table class="memname">
  389. <tr>
  390. <td class="memname">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a>&amp; <a class="el" href="classgameplay_1_1_frustum.html#ac9135b4becaea0698c29e5d43cda72a9">gameplay::Frustum::getTop</a> </td>
  391. <td>(</td>
  392. <td class="paramname"></td><td>)</td>
  393. <td> const</td>
  394. </tr>
  395. </table>
  396. </div>
  397. <div class="memdoc">
  398. <p>Gets the top plane of the frustum.</p>
  399. <dl class="return"><dt><b>Returns:</b></dt><dd>top The top plane. </dd></dl>
  400. </div>
  401. </div>
  402. <a class="anchor" id="a796be313f7c0d1e4f9e604eca635cd33"></a><!-- doxytag: member="gameplay::Frustum::intersects" ref="a796be313f7c0d1e4f9e604eca635cd33" args="(const Vector3 &amp;point) const " -->
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname">bool <a class="el" href="classgameplay_1_1_frustum.html#a796be313f7c0d1e4f9e604eca635cd33">gameplay::Frustum::intersects</a> </td>
  408. <td>(</td>
  409. <td class="paramtype">const <a class="el" href="classgameplay_1_1_vector3.html">Vector3</a> &amp;&#160;</td>
  410. <td class="paramname"><em>point</em></td><td>)</td>
  411. <td> const</td>
  412. </tr>
  413. </table>
  414. </div>
  415. <div class="memdoc">
  416. <p>Tests whether this frustum intersects the specified point.</p>
  417. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  418. <table class="params">
  419. <tr><td class="paramname">point</td><td>The point to test intersection with.</td></tr>
  420. </table>
  421. </dd>
  422. </dl>
  423. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the specified point intersects this frustum; false otherwise. </dd></dl>
  424. </div>
  425. </div>
  426. <a class="anchor" id="aec557e485662234c4d36b616d11b4ab0"></a><!-- doxytag: member="gameplay::Frustum::intersects" ref="aec557e485662234c4d36b616d11b4ab0" args="(float x, float y, float z) const " -->
  427. <div class="memitem">
  428. <div class="memproto">
  429. <table class="memname">
  430. <tr>
  431. <td class="memname">bool <a class="el" href="classgameplay_1_1_frustum.html#a796be313f7c0d1e4f9e604eca635cd33">gameplay::Frustum::intersects</a> </td>
  432. <td>(</td>
  433. <td class="paramtype">float&#160;</td>
  434. <td class="paramname"><em>x</em>, </td>
  435. </tr>
  436. <tr>
  437. <td class="paramkey"></td>
  438. <td></td>
  439. <td class="paramtype">float&#160;</td>
  440. <td class="paramname"><em>y</em>, </td>
  441. </tr>
  442. <tr>
  443. <td class="paramkey"></td>
  444. <td></td>
  445. <td class="paramtype">float&#160;</td>
  446. <td class="paramname"><em>z</em>&#160;</td>
  447. </tr>
  448. <tr>
  449. <td></td>
  450. <td>)</td>
  451. <td></td><td> const</td>
  452. </tr>
  453. </table>
  454. </div>
  455. <div class="memdoc">
  456. <p>Tests whether this frustum intersects the specified point.</p>
  457. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  458. <table class="params">
  459. <tr><td class="paramname">x</td><td>The x coordinate. </td></tr>
  460. <tr><td class="paramname">y</td><td>The y coordinate. </td></tr>
  461. <tr><td class="paramname">z</td><td>The z coordinate.</td></tr>
  462. </table>
  463. </dd>
  464. </dl>
  465. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the specified point intersects this frustum; false otherwise. </dd></dl>
  466. </div>
  467. </div>
  468. <a class="anchor" id="a36cccd1d74cec754ffc8d4a239f60521"></a><!-- doxytag: member="gameplay::Frustum::intersects" ref="a36cccd1d74cec754ffc8d4a239f60521" args="(const BoundingSphere &amp;sphere) const " -->
  469. <div class="memitem">
  470. <div class="memproto">
  471. <table class="memname">
  472. <tr>
  473. <td class="memname">bool <a class="el" href="classgameplay_1_1_frustum.html#a796be313f7c0d1e4f9e604eca635cd33">gameplay::Frustum::intersects</a> </td>
  474. <td>(</td>
  475. <td class="paramtype">const <a class="el" href="classgameplay_1_1_bounding_sphere.html">BoundingSphere</a> &amp;&#160;</td>
  476. <td class="paramname"><em>sphere</em></td><td>)</td>
  477. <td> const</td>
  478. </tr>
  479. </table>
  480. </div>
  481. <div class="memdoc">
  482. <p>Tests whether this frustum intersects the specified bounding sphere.</p>
  483. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  484. <table class="params">
  485. <tr><td class="paramname">sphere</td><td>The bounding sphere to test intersection with.</td></tr>
  486. </table>
  487. </dd>
  488. </dl>
  489. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the specified bounding sphere intersects this frustum; false otherwise. </dd></dl>
  490. </div>
  491. </div>
  492. <a class="anchor" id="a30b343395cbc095eb70144e1f81caf03"></a><!-- doxytag: member="gameplay::Frustum::intersects" ref="a30b343395cbc095eb70144e1f81caf03" args="(const BoundingBox &amp;box) const " -->
  493. <div class="memitem">
  494. <div class="memproto">
  495. <table class="memname">
  496. <tr>
  497. <td class="memname">bool <a class="el" href="classgameplay_1_1_frustum.html#a796be313f7c0d1e4f9e604eca635cd33">gameplay::Frustum::intersects</a> </td>
  498. <td>(</td>
  499. <td class="paramtype">const <a class="el" href="classgameplay_1_1_bounding_box.html">BoundingBox</a> &amp;&#160;</td>
  500. <td class="paramname"><em>box</em></td><td>)</td>
  501. <td> const</td>
  502. </tr>
  503. </table>
  504. </div>
  505. <div class="memdoc">
  506. <p>Tests whether this frustum intersects the specified bounding box.</p>
  507. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  508. <table class="params">
  509. <tr><td class="paramname">box</td><td>The bounding box to test intersection with.</td></tr>
  510. </table>
  511. </dd>
  512. </dl>
  513. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the specified bounding box intersects this frustum; false otherwise. </dd></dl>
  514. </div>
  515. </div>
  516. <a class="anchor" id="af0e15b937bf1146962b02045d2be03ef"></a><!-- doxytag: member="gameplay::Frustum::intersects" ref="af0e15b937bf1146962b02045d2be03ef" args="(const Plane &amp;plane) const " -->
  517. <div class="memitem">
  518. <div class="memproto">
  519. <table class="memname">
  520. <tr>
  521. <td class="memname">float <a class="el" href="classgameplay_1_1_frustum.html#a796be313f7c0d1e4f9e604eca635cd33">gameplay::Frustum::intersects</a> </td>
  522. <td>(</td>
  523. <td class="paramtype">const <a class="el" href="classgameplay_1_1_plane.html">Plane</a> &amp;&#160;</td>
  524. <td class="paramname"><em>plane</em></td><td>)</td>
  525. <td> const</td>
  526. </tr>
  527. </table>
  528. </div>
  529. <div class="memdoc">
  530. <p>Tests whether this frustum intersects the specified plane.</p>
  531. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  532. <table class="params">
  533. <tr><td class="paramname">plane</td><td>The plane to test intersection with.</td></tr>
  534. </table>
  535. </dd>
  536. </dl>
  537. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classgameplay_1_1_plane.html#ae1efc1fd96443343d3a0a289ec8f3858">Plane::INTERSECTS_BACK</a> if the specified bounding object is in the negative half-space of this plane, <a class="el" href="classgameplay_1_1_plane.html#abb4fdfda5773a0d6e7c31d80e5f33a6e">Plane::INTERSECTS_FRONT</a> if it is in the positive half-space of this plane, and <a class="el" href="classgameplay_1_1_plane.html#a4120d77f30efdb5274bc5a7a4ae87dd1">Plane::INTERSECTS_INTERSECTING</a> if it intersects this plane. </dd></dl>
  538. </div>
  539. </div>
  540. <a class="anchor" id="aba6a55c86c0821f2ed58afdabc0a0a1e"></a><!-- doxytag: member="gameplay::Frustum::intersects" ref="aba6a55c86c0821f2ed58afdabc0a0a1e" args="(const Ray &amp;ray) const " -->
  541. <div class="memitem">
  542. <div class="memproto">
  543. <table class="memname">
  544. <tr>
  545. <td class="memname">float <a class="el" href="classgameplay_1_1_frustum.html#a796be313f7c0d1e4f9e604eca635cd33">gameplay::Frustum::intersects</a> </td>
  546. <td>(</td>
  547. <td class="paramtype">const <a class="el" href="classgameplay_1_1_ray.html">Ray</a> &amp;&#160;</td>
  548. <td class="paramname"><em>ray</em></td><td>)</td>
  549. <td> const</td>
  550. </tr>
  551. </table>
  552. </div>
  553. <div class="memdoc">
  554. <p>Tests whether this frustum intersects the specified ray.</p>
  555. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  556. <table class="params">
  557. <tr><td class="paramname">ray</td><td>The ray to test intersection with.</td></tr>
  558. </table>
  559. </dd>
  560. </dl>
  561. <dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classgameplay_1_1_plane.html#ae1efc1fd96443343d3a0a289ec8f3858">Plane::INTERSECTS_BACK</a> if the specified ray is in the negative half-space of this plane, <a class="el" href="classgameplay_1_1_plane.html#abb4fdfda5773a0d6e7c31d80e5f33a6e">Plane::INTERSECTS_FRONT</a> if it is in the positive half-space of this plane, and <a class="el" href="classgameplay_1_1_plane.html#a4120d77f30efdb5274bc5a7a4ae87dd1">Plane::INTERSECTS_INTERSECTING</a> if it intersects this plane. </dd></dl>
  562. </div>
  563. </div>
  564. <a class="anchor" id="afb4092a1bcf95d34f095a339c070bf1d"></a><!-- doxytag: member="gameplay::Frustum::set" ref="afb4092a1bcf95d34f095a339c070bf1d" args="(const Frustum &amp;frustum)" -->
  565. <div class="memitem">
  566. <div class="memproto">
  567. <table class="memname">
  568. <tr>
  569. <td class="memname">void <a class="el" href="classgameplay_1_1_frustum.html#afb4092a1bcf95d34f095a339c070bf1d">gameplay::Frustum::set</a> </td>
  570. <td>(</td>
  571. <td class="paramtype">const <a class="el" href="classgameplay_1_1_frustum.html">Frustum</a> &amp;&#160;</td>
  572. <td class="paramname"><em>frustum</em></td><td>)</td>
  573. <td></td>
  574. </tr>
  575. </table>
  576. </div>
  577. <div class="memdoc">
  578. <p>Sets this frustum to the specified frustum.</p>
  579. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  580. <table class="params">
  581. <tr><td class="paramname">frustum</td><td>The frustum to set to. </td></tr>
  582. </table>
  583. </dd>
  584. </dl>
  585. </div>
  586. </div>
  587. <a class="anchor" id="ac0d38971b895ff8955d0ad9ea8b5fbb5"></a><!-- doxytag: member="gameplay::Frustum::set" ref="ac0d38971b895ff8955d0ad9ea8b5fbb5" args="(const Matrix &amp;matrix)" -->
  588. <div class="memitem">
  589. <div class="memproto">
  590. <table class="memname">
  591. <tr>
  592. <td class="memname">void <a class="el" href="classgameplay_1_1_frustum.html#afb4092a1bcf95d34f095a339c070bf1d">gameplay::Frustum::set</a> </td>
  593. <td>(</td>
  594. <td class="paramtype">const <a class="el" href="classgameplay_1_1_matrix.html">Matrix</a> &amp;&#160;</td>
  595. <td class="paramname"><em>matrix</em></td><td>)</td>
  596. <td></td>
  597. </tr>
  598. </table>
  599. </div>
  600. <div class="memdoc">
  601. <p>Sets the frustum to the frustum corresponding to the specified view projection matrix.</p>
  602. <dl class="params"><dt><b>Parameters:</b></dt><dd>
  603. <table class="params">
  604. <tr><td class="paramname">matrix</td><td>The view projection matrix. </td></tr>
  605. </table>
  606. </dd>
  607. </dl>
  608. </div>
  609. </div>
  610. </div><!-- contents -->
  611. <!-- window showing the filter options -->
  612. <div id="MSearchSelectWindow"
  613. onmouseover="return searchBox.OnSearchSelectShow()"
  614. onmouseout="return searchBox.OnSearchSelectHide()"
  615. onkeydown="return searchBox.OnSearchSelectKey(event)">
  616. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>
  617. <!-- iframe showing the search results (closed by default) -->
  618. <div id="MSearchResultsWindow">
  619. <iframe src="javascript:void(0)" frameborder="0"
  620. name="MSearchResults" id="MSearchResults">
  621. </iframe>
  622. </div>
  623. <hr class="footer"/><address class="footer"><small>
  624. Generated on Sat Jan 24 2015 15:29:42 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
  625. <img class="footer" src="doxygen.png" alt="doxygen"/>
  626. </a> 1.7.6.1
  627. </small></address>
  628. </body>
  629. </html>