298 lines
20 KiB
HTML
Raw Blame History

<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Khaotic Engine Reborn: frustum 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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" />
</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">Khaotic Engine Reborn
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('classfrustum.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classfrustum-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">frustum Class Reference</div></div>
</div><!--header-->
<div class="contents">
<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:a17fbc652d86a362739d01c66ab8aa036" id="r_a17fbc652d86a362739d01c66ab8aa036"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a17fbc652d86a362739d01c66ab8aa036">ConstructFrustum</a> (float screenDepth, XMMATRIX projectionMatrix, XMMATRIX viewMatrix)</td></tr>
<tr class="separator:a17fbc652d86a362739d01c66ab8aa036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa631d4d670499da25b2c3720cc15c855" id="r_aa631d4d670499da25b2c3720cc15c855"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa631d4d670499da25b2c3720cc15c855">CheckCube</a> (float xCenter, float yCenter, float zCenter, float radius, float tolerance)</td></tr>
<tr class="separator:aa631d4d670499da25b2c3720cc15c855"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="frustum_8h_source.html#l00004">4</a> of file <a class="el" href="frustum_8h_source.html">frustum.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa631d4d670499da25b2c3720cc15c855" name="aa631d4d670499da25b2c3720cc15c855"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa631d4d670499da25b2c3720cc15c855">&#9670;&#160;</a></span>CheckCube()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frustum::CheckCube </td>
<td>(</td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>xCenter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>yCenter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>zCenter</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>radius</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>tolerance</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a point is inside the frustum. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>X coordinate of the point. </td></tr>
<tr><td class="paramname">y</td><td>Y coordinate of the point. </td></tr>
<tr><td class="paramname">z</td><td>Z coordinate of the point. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the point is inside the frustum, otherwise false. </dd></dl>
<p class="definition">Definition at line <a class="el" href="frustum_8cpp_source.html#l00059">59</a> of file <a class="el" href="frustum_8cpp_source.html">frustum.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 60</span>{</div>
<div class="line"><span class="lineno"> 61</span> <span class="comment">// V<>rifiez chaque plan du frustum pour voir si le cube est <20> l&#39;int<EFBFBD>rieur</span></div>
<div class="line"><span class="lineno"> 62</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; 6; i++)</div>
<div class="line"><span class="lineno"> 63</span> {</div>
<div class="line"><span class="lineno"> 64</span> XMVECTOR plane = m_planes[i];</div>
<div class="line"><span class="lineno"> 65</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter - radius) + XMVectorGetY(plane) * (yCenter - radius) + XMVectorGetZ(plane) * (zCenter - radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 66</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 67</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter + radius) + XMVectorGetY(plane) * (yCenter - radius) + XMVectorGetZ(plane) * (zCenter - radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 68</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 69</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter - radius) + XMVectorGetY(plane) * (yCenter + radius) + XMVectorGetZ(plane) * (zCenter - radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 70</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 71</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter + radius) + XMVectorGetY(plane) * (yCenter + radius) + XMVectorGetZ(plane) * (zCenter - radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 72</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 73</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter - radius) + XMVectorGetY(plane) * (yCenter - radius) + XMVectorGetZ(plane) * (zCenter + radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 74</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 75</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter + radius) + XMVectorGetY(plane) * (yCenter - radius) + XMVectorGetZ(plane) * (zCenter + radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 76</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 77</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter - radius) + XMVectorGetY(plane) * (yCenter + radius) + XMVectorGetZ(plane) * (zCenter + radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 78</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 79</span> <span class="keywordflow">if</span> (XMVectorGetX(plane) * (xCenter + radius) + XMVectorGetY(plane) * (yCenter + radius) + XMVectorGetZ(plane) * (zCenter + radius) + XMVectorGetW(plane) &gt; -tolerance)</div>
<div class="line"><span class="lineno"> 80</span> <span class="keywordflow">continue</span>;</div>
<div class="line"><span class="lineno"> 81</span> </div>
<div class="line"><span class="lineno"> 82</span> <span class="comment">// Si le cube est en dehors de l&#39;un des plans, il n&#39;est pas dans le frustum</span></div>
<div class="line"><span class="lineno"> 83</span> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><span class="lineno"> 84</span> }</div>
<div class="line"><span class="lineno"> 85</span> </div>
<div class="line"><span class="lineno"> 86</span> <span class="comment">// Si le cube est <20> l&#39;int<EFBFBD>rieur de tous les plans, il est dans le frustum</span></div>
<div class="line"><span class="lineno"> 87</span> <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><span class="lineno"> 88</span>}</div>
</div><!-- fragment -->
</div>
</div>
<a id="a17fbc652d86a362739d01c66ab8aa036" name="a17fbc652d86a362739d01c66ab8aa036"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a17fbc652d86a362739d01c66ab8aa036">&#9670;&#160;</a></span>ConstructFrustum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frustum::ConstructFrustum </td>
<td>(</td>
<td class="paramtype">float</td> <td class="paramname"><span class="paramname"><em>screenDepth</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMMATRIX</td> <td class="paramname"><span class="paramname"><em>projectionMatrix</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XMMATRIX</td> <td class="paramname"><span class="paramname"><em>viewMatrix</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a frustum object. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">screenDepth</td><td></td></tr>
<tr><td class="paramname">projectionMatrix</td><td></td></tr>
<tr><td class="paramname">viewMatrix</td><td></td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="frustum_8cpp_source.html#l00003">3</a> of file <a class="el" href="frustum_8cpp_source.html">frustum.cpp</a>.</p>
<div class="fragment"><div class="line"><span class="lineno"> 4</span>{</div>
<div class="line"><span class="lineno"> 5</span> XMMATRIX matrix;</div>
<div class="line"><span class="lineno"> 6</span> XMVECTOR planes[6];</div>
<div class="line"><span class="lineno"> 7</span> </div>
<div class="line"><span class="lineno"> 8</span> <span class="comment">// Calculate the minimum Z distance in the frustum.</span></div>
<div class="line"><span class="lineno"> 9</span> <span class="keywordtype">float</span> zMinimum = -projectionMatrix.r[3].m128_f32[2] / projectionMatrix.r[2].m128_f32[2];</div>
<div class="line"><span class="lineno"> 10</span> <span class="keywordtype">float</span> r = screenDepth / (screenDepth - zMinimum);</div>
<div class="line"><span class="lineno"> 11</span> projectionMatrix.r[2].m128_f32[2] = r;</div>
<div class="line"><span class="lineno"> 12</span> projectionMatrix.r[3].m128_f32[2] = -r * zMinimum;</div>
<div class="line"><span class="lineno"> 13</span> </div>
<div class="line"><span class="lineno"> 14</span> <span class="comment">// Create the frustum matrix from the view matrix and updated projection matrix.</span></div>
<div class="line"><span class="lineno"> 15</span> matrix = XMMatrixMultiply(viewMatrix, projectionMatrix);</div>
<div class="line"><span class="lineno"> 16</span> </div>
<div class="line"><span class="lineno"> 17</span> <span class="comment">// Calculate near plane of frustum.</span></div>
<div class="line"><span class="lineno"> 18</span> planes[0] = XMPlaneNormalize(XMVectorSet(matrix.r[0].m128_f32[3] + matrix.r[0].m128_f32[2],</div>
<div class="line"><span class="lineno"> 19</span> matrix.r[1].m128_f32[3] + matrix.r[1].m128_f32[2],</div>
<div class="line"><span class="lineno"> 20</span> matrix.r[2].m128_f32[3] + matrix.r[2].m128_f32[2],</div>
<div class="line"><span class="lineno"> 21</span> matrix.r[3].m128_f32[3] + matrix.r[3].m128_f32[2]));</div>
<div class="line"><span class="lineno"> 22</span> </div>
<div class="line"><span class="lineno"> 23</span> <span class="comment">// Calculate far plane of frustum.</span></div>
<div class="line"><span class="lineno"> 24</span> planes[1] = XMPlaneNormalize(XMVectorSet(matrix.r[0].m128_f32[3] - matrix.r[0].m128_f32[2],</div>
<div class="line"><span class="lineno"> 25</span> matrix.r[1].m128_f32[3] - matrix.r[1].m128_f32[2],</div>
<div class="line"><span class="lineno"> 26</span> matrix.r[2].m128_f32[3] - matrix.r[2].m128_f32[2],</div>
<div class="line"><span class="lineno"> 27</span> matrix.r[3].m128_f32[3] - matrix.r[3].m128_f32[2]));</div>
<div class="line"><span class="lineno"> 28</span> </div>
<div class="line"><span class="lineno"> 29</span> <span class="comment">// Calculate left plane of frustum.</span></div>
<div class="line"><span class="lineno"> 30</span> planes[2] = XMPlaneNormalize(XMVectorSet(matrix.r[0].m128_f32[3] + matrix.r[0].m128_f32[0],</div>
<div class="line"><span class="lineno"> 31</span> matrix.r[1].m128_f32[3] + matrix.r[1].m128_f32[0],</div>
<div class="line"><span class="lineno"> 32</span> matrix.r[2].m128_f32[3] + matrix.r[2].m128_f32[0],</div>
<div class="line"><span class="lineno"> 33</span> matrix.r[3].m128_f32[3] + matrix.r[3].m128_f32[0]));</div>
<div class="line"><span class="lineno"> 34</span> </div>
<div class="line"><span class="lineno"> 35</span> <span class="comment">// Calculate right plane of frustum.</span></div>
<div class="line"><span class="lineno"> 36</span> planes[3] = XMPlaneNormalize(XMVectorSet(matrix.r[0].m128_f32[3] - matrix.r[0].m128_f32[0],</div>
<div class="line"><span class="lineno"> 37</span> matrix.r[1].m128_f32[3] - matrix.r[1].m128_f32[0],</div>
<div class="line"><span class="lineno"> 38</span> matrix.r[2].m128_f32[3] - matrix.r[2].m128_f32[0],</div>
<div class="line"><span class="lineno"> 39</span> matrix.r[3].m128_f32[3] - matrix.r[3].m128_f32[0]));</div>
<div class="line"><span class="lineno"> 40</span> </div>
<div class="line"><span class="lineno"> 41</span> <span class="comment">// Calculate top plane of frustum.</span></div>
<div class="line"><span class="lineno"> 42</span> planes[4] = XMPlaneNormalize(XMVectorSet(matrix.r[0].m128_f32[3] - matrix.r[0].m128_f32[1],</div>
<div class="line"><span class="lineno"> 43</span> matrix.r[1].m128_f32[3] - matrix.r[1].m128_f32[1],</div>
<div class="line"><span class="lineno"> 44</span> matrix.r[2].m128_f32[3] - matrix.r[2].m128_f32[1],</div>
<div class="line"><span class="lineno"> 45</span> matrix.r[3].m128_f32[3] - matrix.r[3].m128_f32[1]));</div>
<div class="line"><span class="lineno"> 46</span> </div>
<div class="line"><span class="lineno"> 47</span> <span class="comment">// Calculate bottom plane of frustum.</span></div>
<div class="line"><span class="lineno"> 48</span> planes[5] = XMPlaneNormalize(XMVectorSet(matrix.r[0].m128_f32[3] + matrix.r[0].m128_f32[1],</div>
<div class="line"><span class="lineno"> 49</span> matrix.r[1].m128_f32[3] + matrix.r[1].m128_f32[1],</div>
<div class="line"><span class="lineno"> 50</span> matrix.r[2].m128_f32[3] + matrix.r[2].m128_f32[1],</div>
<div class="line"><span class="lineno"> 51</span> matrix.r[3].m128_f32[3] + matrix.r[3].m128_f32[1]));</div>
<div class="line"><span class="lineno"> 52</span> </div>
<div class="line"><span class="lineno"> 53</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; 6; i++)</div>
<div class="line"><span class="lineno"> 54</span> {</div>
<div class="line"><span class="lineno"> 55</span> m_planes[i] = planes[i];</div>
<div class="line"><span class="lineno"> 56</span> }</div>
<div class="line"><span class="lineno"> 57</span>}</div>
</div><!-- fragment -->
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>enginecustom/src/inc/system/<a class="el" href="frustum_8h_source.html">frustum.h</a></li>
<li>enginecustom/src/src/system/<a class="el" href="frustum_8cpp_source.html">frustum.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classfrustum.html">frustum</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
</ul>
</div>
</body>
</html>