1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<!-- HTML header for doxygen 1.8.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<title>MinGfx Toolkit: src/bvh.h Source File</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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">MinGfx Toolkit
 <span id="projectnumber">1.0</span>
</div>
<div id="projectbrief">A minimal library for writing cross-platform (Windows, OSX, linux) graphics programs.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">bvh.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="bvh_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> This file is part of the MinGfx Project.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> </span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2017,2018 Regents of the University of Minnesota.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> All Rights Reserved.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> </span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Original Author(s) of this File:</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> David Schroeder, 2010-ish, University of Minnesota</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> Author(s) of Significant Updates/Modifications to the File:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> Dan Keefe, 2018, University of Minnesota</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> ...</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef SRC_BVH_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define SRC_BVH_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="aabb_8h.html">aabb.h</a>"</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="point3_8h.html">point3.h</a>"</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span><a class="code" href="namespacemingfx.html">mingfx</a> {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// forward declarations</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span>Mesh;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span>Ray;</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classmingfx_1_1_b_v_h.html"> 40</a></span> <span class="keyword">class </span><a class="code" href="classmingfx_1_1_b_v_h.html">BVH</a> {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classmingfx_1_1_b_v_h.html#af812656193d247be31dd038a8e2fff75"> 43</a></span>  <a class="code" href="classmingfx_1_1_b_v_h.html#af812656193d247be31dd038a8e2fff75">BVH</a>();</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classmingfx_1_1_b_v_h.html#af81906830adcf4648cc8cf4e214b4269"> 45</a></span>  <span class="keyword">virtual</span> <a class="code" href="classmingfx_1_1_b_v_h.html#af81906830adcf4648cc8cf4e214b4269">~BVH</a>();</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classmingfx_1_1_b_v_h.html#a8ed3e91ecd2a0585a0dbac605d6f2c71"> 57</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmingfx_1_1_b_v_h.html#a8ed3e91ecd2a0585a0dbac605d6f2c71">CreateFromMesh</a>(<span class="keyword">const</span> <a class="code" href="classmingfx_1_1_mesh.html">Mesh</a> &mesh);</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classmingfx_1_1_b_v_h.html#a964420ca931fa93c420f0820e1b95942"> 63</a></span>  <span class="keywordtype">void</span> <a class="code" href="classmingfx_1_1_b_v_h.html#a964420ca931fa93c420f0820e1b95942">CreateFromListOfBoxes</a>(<span class="keyword">const</span> std::vector<AABB> &boxes);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classmingfx_1_1_b_v_h.html#afad54f50a29e8b3aace6cdec5c792c56"> 73</a></span>  std::vector<int> <a class="code" href="classmingfx_1_1_b_v_h.html#afad54f50a29e8b3aace6cdec5c792c56">IntersectAndReturnUserData</a>(<span class="keyword">const</span> <a class="code" href="classmingfx_1_1_ray.html">Ray</a> &r) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// Simple internal data structure for storing each node of the BVH tree.</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keyword">class </span>Node {</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keyword">public</span>:</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  Node() : child1(NULL), child2(NULL) {}</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// Links to children</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  Node *child1;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  Node *child2;</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// Contains all geometry below this node.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <a class="code" href="classmingfx_1_1_a_a_b_b.html">AABB</a> box;</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  };</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// for now, the copy constructor is private so no copies are allowed.</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// eventually, this would be good to implement and then it can be made public.</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <a class="code" href="classmingfx_1_1_b_v_h.html#af812656193d247be31dd038a8e2fff75">BVH</a>(<span class="keyword">const</span> <a class="code" href="classmingfx_1_1_b_v_h.html#af812656193d247be31dd038a8e2fff75">BVH</a> &other);</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> BuildHierarchyRecursive(Node *node, std::vector<AABB> boxes);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> IntersectRecursive(<span class="keyword">const</span> Ray &r, Node *node, std::vector<int> *data_list) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span> FreeNodeRecursive(Node* node);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  Node* root_;</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> };</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> } <span class="comment">// end namespace</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aaabb_8h_html"><div class="ttname"><a href="aabb_8h.html">aabb.h</a></div></div>
<div class="ttc" id="aclassmingfx_1_1_a_a_b_b_html"><div class="ttname"><a href="classmingfx_1_1_a_a_b_b.html">mingfx::AABB</a></div><div class="ttdoc">A 3D axis-aligned bounding box defined by two corners (min and max).</div><div class="ttdef"><b>Definition:</b> <a href="aabb_8h_source.html#l00031">aabb.h:31</a></div></div>
<div class="ttc" id="aclassmingfx_1_1_b_v_h_html"><div class="ttname"><a href="classmingfx_1_1_b_v_h.html">mingfx::BVH</a></div><div class="ttdoc">A Bounding Volume Hierarchy (BVH) data structure that can be used to accelerate ray-object intersecti...</div><div class="ttdef"><b>Definition:</b> <a href="bvh_8h_source.html#l00040">bvh.h:40</a></div></div>
<div class="ttc" id="aclassmingfx_1_1_b_v_h_html_a8ed3e91ecd2a0585a0dbac605d6f2c71"><div class="ttname"><a href="classmingfx_1_1_b_v_h.html#a8ed3e91ecd2a0585a0dbac605d6f2c71">mingfx::BVH::CreateFromMesh</a></div><div class="ttdeci">void CreateFromMesh(const Mesh &mesh)</div><div class="ttdoc">Creates a bounding volume hierarchy where each leaf node contains a single triangle from the mesh.</div></div>
<div class="ttc" id="aclassmingfx_1_1_b_v_h_html_a964420ca931fa93c420f0820e1b95942"><div class="ttname"><a href="classmingfx_1_1_b_v_h.html#a964420ca931fa93c420f0820e1b95942">mingfx::BVH::CreateFromListOfBoxes</a></div><div class="ttdeci">void CreateFromListOfBoxes(const std::vector< AABB > &boxes)</div><div class="ttdoc">Creates a BVH where each leaf node contains one of the boxes passed in to the function.</div></div>
<div class="ttc" id="aclassmingfx_1_1_b_v_h_html_af812656193d247be31dd038a8e2fff75"><div class="ttname"><a href="classmingfx_1_1_b_v_h.html#af812656193d247be31dd038a8e2fff75">mingfx::BVH::BVH</a></div><div class="ttdeci">BVH()</div><div class="ttdoc">Initializes the class with an empty hierarchy.</div></div>
<div class="ttc" id="aclassmingfx_1_1_b_v_h_html_af81906830adcf4648cc8cf4e214b4269"><div class="ttname"><a href="classmingfx_1_1_b_v_h.html#af81906830adcf4648cc8cf4e214b4269">mingfx::BVH::~BVH</a></div><div class="ttdeci">virtual ~BVH()</div></div>
<div class="ttc" id="aclassmingfx_1_1_b_v_h_html_afad54f50a29e8b3aace6cdec5c792c56"><div class="ttname"><a href="classmingfx_1_1_b_v_h.html#afad54f50a29e8b3aace6cdec5c792c56">mingfx::BVH::IntersectAndReturnUserData</a></div><div class="ttdeci">std::vector< int > IntersectAndReturnUserData(const Ray &r) const</div><div class="ttdoc">Traverse the BVH to find leaf nodes whose AABBs are intersected by the ray.</div></div>
<div class="ttc" id="aclassmingfx_1_1_mesh_html"><div class="ttname"><a href="classmingfx_1_1_mesh.html">mingfx::Mesh</a></div><div class="ttdoc">A triangle mesh data structure that can be rendered with a ShaderProgram like DefaultShader.</div><div class="ttdef"><b>Definition:</b> <a href="mesh_8h_source.html#l00127">mesh.h:127</a></div></div>
<div class="ttc" id="aclassmingfx_1_1_ray_html"><div class="ttname"><a href="classmingfx_1_1_ray.html">mingfx::Ray</a></div><div class="ttdoc">Stores the mathematical object of a ray that begins at an origin (a 3D point) and points in a directi...</div><div class="ttdef"><b>Definition:</b> <a href="ray_8h_source.html#l00054">ray.h:54</a></div></div>
<div class="ttc" id="anamespacemingfx_html"><div class="ttname"><a href="namespacemingfx.html">mingfx</a></div><div class="ttdoc">Namespace for the MinGfx Toolkit.</div><div class="ttdef"><b>Definition:</b> <a href="aabb_8h_source.html#l00021">aabb.h:21</a></div></div>
<div class="ttc" id="apoint3_8h_html"><div class="ttname"><a href="point3_8h.html">point3.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- HTML footer for doxygen 1.8.9.1-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.9.1
</small></address>
</body>
</html>
|
