-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_space_tree_8h_source.html
87 lines (87 loc) · 45.1 KB
/
_space_tree_8h_source.html
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
<!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.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): SpaceTree.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.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 id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Gamedev Framework (gf)
 <span id="projectnumber">0.6.0</span>
</div>
<div id="projectbrief">A C++11 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_6d069d519ae9d12fa11dd8e685586b60.html">gf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SpaceTree.h</div> </div>
</div><!--header-->
<div class="contents">
<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"> * Gamedev Framework (gf)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright (C) 2016-2017 Julien Bernard</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * arising from the use of this software.</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * freely, subject to the following restrictions:</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"> * 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * appreciated but is not required.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * misrepresented as being the original software.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> *</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * Part of this file comes from SFML, with the same license:</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Copyright (C) 2007-2015 Laurent Gomila ([email protected])</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">GF_SPACE_TREE_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">GF_SPACE_TREE_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">functional</span><span class="preprocessor">></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor"><</span><span class="preprocessor">memory</span><span class="preprocessor">></span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_portability_8h.html">"Portability.h"</a></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_random_8h.html">"Random.h"</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_rect_8h.html">"Rect.h"</a></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_vector_8h.html">"Vector.h"</a></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">namespace</span> <a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">inline</span> <span class="keyword">namespace</span> v1 {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">/**</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @brief Binary space random partionning tree</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> *</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * This class implements a random binary space partitioning tree. More</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * precisely, this class is a node in the tree.</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html"> 47</a></span>  <span class="keyword">class</span> <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="classgf_1_1_space_tree.html">SpaceTree</a> {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">/**</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @brief A callback function for traversing the tree</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> *</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * The function returns a boolean indicating if the traversal can</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> * continue.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> */</span></div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html#a8bd4660affab69f5e212b36ffe4c4e8c"> 55</a></span>  <span class="keyword">using</span> Callback = std::function<<span class="keywordtype">bool</span>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_space_tree.html">SpaceTree</a>&)>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">/**</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @brief Constructor</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> *</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * @param area The area to split for this node</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classgf_1_1_space_tree.html#aa98ebb65a493a9d2ce33930be0c791b7">SpaceTree</a>(<span class="keyword">const</span> RectI& area);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">/**</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * @brief Get the area of the node</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> *</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @return The area of the node</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> */</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html#a263e021be898be8e55dc73dad00d0faf"> 69</a></span>  <span class="keyword">const</span> RectI& <a class="code" href="classgf_1_1_space_tree.html#a263e021be898be8e55dc73dad00d0faf">getArea</a>() <span class="keyword">const</span> {</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> m_area;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">/**</span></div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * @brief Get the level of the node in the tree</span></div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> *</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * The root of the tree is at level 0, its children at level 1, etc.</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> *</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @returns The level of the node</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html#abb31e04f19948f17b0015d4e99ddb6b9"> 80</a></span>  <span class="keywordtype">int</span> <a class="code" href="classgf_1_1_space_tree.html#abb31e04f19948f17b0015d4e99ddb6b9">getLevel</a>() <span class="keyword">const</span> {</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">return</span> m_level;</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> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">/**</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * @brief Remove the children of the node</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> */</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_space_tree.html#a0c1ece59e87cd33b29e56d60c561d103">removeChildren</a>();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="comment">/**</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @brief Split the node once</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> *</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * This function may create two children if the conditions are met.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> *</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @param random A random generator</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @param minSize The minimum size under which a node cannot be split</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @param maxRatio The maximum ratio between the width and height</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @returns True if the node has actually been split</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> */</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#a43977ff8132117ac056c5da003b3f2cf">splitOnce</a>(<a class="code" href="classgf_1_1_random.html">Random</a>& random, Vector2i minSize, <span class="keywordtype">float</span> maxRatio = 1.5f);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="comment">/**</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @brief Split a node recursively</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> *</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param random A random generator</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param levelMax The maximum level of a node</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param minSize The minimum size under which a node cannot be split</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @param maxSize The maximum size over which a node must be split</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @param maxRatio The maximum ratio between the width and height</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> */</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_space_tree.html#a649f845ce1e75039cc06e06676ccd7ce">splitRecursive</a>(<a class="code" href="classgf_1_1_random.html">Random</a>& random, <span class="keywordtype">int</span> levelMax, Vector2i minSize, Vector2i maxSize, <span class="keywordtype">float</span> maxRatio = 1.5f);</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="comment">/**</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * @brief Check if a node is a leaf</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> *</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> * A leaf has no children.</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> *</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @returns True if the node is a leaf</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> */</span></div><div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html#aa3f37785dbfbebe63be924bb9dc35351"> 119</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#aa3f37785dbfbebe63be924bb9dc35351">isLeaf</a>() <span class="keyword">const</span> {</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="keywordflow">return</span> !m_left && !m_right;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="comment">/**</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @brief Get the left child</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> *</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * @returns The left child if it exists or `nullptr`</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> <span class="comment"> */</span></div><div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html#a4d84231b3285a513de6a2a12b39b3c84"> 128</a></span>  <span class="keyword">const</span> <a class="code" href="classgf_1_1_space_tree.html">SpaceTree</a> *<a class="code" href="classgf_1_1_space_tree.html#a4d84231b3285a513de6a2a12b39b3c84">getLeftChild</a>() <span class="keyword">const</span> {</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordflow">return</span> m_left.get();</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  }</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">/**</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * @brief Get the right child</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> *</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> * @returns The right child if it exists or `nullptr`</span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> */</span></div><div class="line"><a name="l00137"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html#ae061aafbcb13e0c02652c35915887645"> 137</a></span>  <span class="keyword">const</span> <a class="code" href="classgf_1_1_space_tree.html">SpaceTree</a> *<a class="code" href="classgf_1_1_space_tree.html#ae061aafbcb13e0c02652c35915887645">getRightChild</a>() <span class="keyword">const</span> {</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordflow">return</span> m_right.get();</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="comment">/**</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @brief Get the father of the node</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> *</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * The root of the tree has no father.</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> *</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * @returns The father of the node</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> */</span></div><div class="line"><a name="l00148"></a><span class="lineno"><a class="line" href="classgf_1_1_space_tree.html#af0f2ef77776aa83c18b9434e3914b480"> 148</a></span>  <span class="keyword">const</span> <a class="code" href="classgf_1_1_space_tree.html">SpaceTree</a> *<a class="code" href="classgf_1_1_space_tree.html#af0f2ef77776aa83c18b9434e3914b480">getFather</a>() <span class="keyword">const</span> {</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordflow">return</span> m_father;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  }</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="comment">/**</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @brief Check if the area of the node contains a position</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> *</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @param position The position to check</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> */</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#aec87a1eae162f44bf2330f695cada760">contains</a>(Vector2i position) <span class="keyword">const</span>;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="comment">/**</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * @brief Find the deepest node containing a position</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> *</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * @param position The position to find</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @returns A node or `nullptr` if the position is outside the tree</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> */</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keyword">const</span> <a class="code" href="classgf_1_1_space_tree.html">SpaceTree</a> *<a class="code" href="classgf_1_1_space_tree.html#a04d634e379594f7ee6c8d3e46509ab68">find</a>(Vector2i position) <span class="keyword">const</span>;</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> </div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  <span class="comment">/**</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> * @brief Traverse the nodes in pre-order</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> *</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> * @param callback A function to call on each node</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> *</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @sa [Tree traversal - Wikipedia](https://en.wikipedia.org/wiki/Tree_traversal)</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> */</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#a52348fbe1896be459b5bb4f714d995a6">traversePreOrder</a>(Callback callback) <span class="keyword">const</span>;</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="comment">/**</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @brief Traverse the nodes in in-order</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> *</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> * @param callback A function to call on each node</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> *</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * @sa [Tree traversal - Wikipedia](https://en.wikipedia.org/wiki/Tree_traversal)</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> */</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#a3f757f8e9d677e7e3ee7ea140f7b8627">traverseInOrder</a>(Callback callback) <span class="keyword">const</span>;</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="comment">/**</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"> * @brief Traverse the nodes in post-order</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> *</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @param callback A function to call on each node</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> *</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @sa [Tree traversal - Wikipedia](https://en.wikipedia.org/wiki/Tree_traversal)</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> */</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#ad745cfda36ca5eacac0745b53d9e9471">traversePostOrder</a>(Callback callback) <span class="keyword">const</span>;</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="comment">/**</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment"> * @brief Traverse the nodes in level-order</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> *</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * Level-order is also known as breadth first search</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> *</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> * @param callback A function to call on each node</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment"> *</span></div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"> * @sa [Tree traversal - Wikipedia](https://en.wikipedia.org/wiki/Tree_traversal)</span></div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment"> */</span></div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#afbbf193f2c2955f103df029c1f389b67">traverseLevelOrder</a>(Callback callback) <span class="keyword">const</span>;</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="comment">/**</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> * @brief Traverse the nodes in inverted level-order</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> *</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> * @param callback A function to call on each node</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> *</span></div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * @sa [Tree traversal - Wikipedia](https://en.wikipedia.org/wiki/Tree_traversal)</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> */</span></div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_space_tree.html#a400015a388da534227e01f65dd445ddf">traverseInvertedLevelOrder</a>(Callback callback) <span class="keyword">const</span>;</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> </div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keyword">enum</span> <span class="keyword">class</span> Split {</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  None,</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  Vertical,</div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  Horizontal,</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  };</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span> </div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  RectI m_area;</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> </div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  Split m_split;</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <span class="keywordtype">int</span> m_position;</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordtype">int</span> m_level;</div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span> </div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  std::unique_ptr<SpaceTree> m_left;</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  std::unique_ptr<SpaceTree> m_right;</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  <a class="code" href="classgf_1_1_space_tree.html">SpaceTree</a> *m_father;</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  };</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> </div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> }</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span> }</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span> <span class="comment">// GF_SPACE_TREE_H</span></div><div class="ttc" id="classgf_1_1_random_html"><div class="ttname"><a href="classgf_1_1_random.html">gf::Random</a></div><div class="ttdoc">A random engine. </div><div class="ttdef"><b>Definition:</b> Random.h:43</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a43977ff8132117ac056c5da003b3f2cf"><div class="ttname"><a href="classgf_1_1_space_tree.html#a43977ff8132117ac056c5da003b3f2cf">gf::SpaceTree::splitOnce</a></div><div class="ttdeci">bool splitOnce(Random &random, Vector2i minSize, float maxRatio=1.5f)</div><div class="ttdoc">Split the node once. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_ae061aafbcb13e0c02652c35915887645"><div class="ttname"><a href="classgf_1_1_space_tree.html#ae061aafbcb13e0c02652c35915887645">gf::SpaceTree::getRightChild</a></div><div class="ttdeci">const SpaceTree * getRightChild() const</div><div class="ttdoc">Get the right child. </div><div class="ttdef"><b>Definition:</b> SpaceTree.h:137</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a649f845ce1e75039cc06e06676ccd7ce"><div class="ttname"><a href="classgf_1_1_space_tree.html#a649f845ce1e75039cc06e06676ccd7ce">gf::SpaceTree::splitRecursive</a></div><div class="ttdeci">void splitRecursive(Random &random, int levelMax, Vector2i minSize, Vector2i maxSize, float maxRatio=1.5f)</div><div class="ttdoc">Split a node recursively. </div></div>
<div class="ttc" id="namespacegf_html"><div class="ttname"><a href="namespacegf.html">gf</a></div><div class="ttdoc">The namespace for gf classes. </div><div class="ttdef"><b>Definition:</b> Action.h:34</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a52348fbe1896be459b5bb4f714d995a6"><div class="ttname"><a href="classgf_1_1_space_tree.html#a52348fbe1896be459b5bb4f714d995a6">gf::SpaceTree::traversePreOrder</a></div><div class="ttdeci">bool traversePreOrder(Callback callback) const</div><div class="ttdoc">Traverse the nodes in pre-order. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_af0f2ef77776aa83c18b9434e3914b480"><div class="ttname"><a href="classgf_1_1_space_tree.html#af0f2ef77776aa83c18b9434e3914b480">gf::SpaceTree::getFather</a></div><div class="ttdeci">const SpaceTree * getFather() const</div><div class="ttdoc">Get the father of the node. </div><div class="ttdef"><b>Definition:</b> SpaceTree.h:148</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a04d634e379594f7ee6c8d3e46509ab68"><div class="ttname"><a href="classgf_1_1_space_tree.html#a04d634e379594f7ee6c8d3e46509ab68">gf::SpaceTree::find</a></div><div class="ttdeci">const SpaceTree * find(Vector2i position) const</div><div class="ttdoc">Find the deepest node containing a position. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a400015a388da534227e01f65dd445ddf"><div class="ttname"><a href="classgf_1_1_space_tree.html#a400015a388da534227e01f65dd445ddf">gf::SpaceTree::traverseInvertedLevelOrder</a></div><div class="ttdeci">bool traverseInvertedLevelOrder(Callback callback) const</div><div class="ttdoc">Traverse the nodes in inverted level-order. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a0c1ece59e87cd33b29e56d60c561d103"><div class="ttname"><a href="classgf_1_1_space_tree.html#a0c1ece59e87cd33b29e56d60c561d103">gf::SpaceTree::removeChildren</a></div><div class="ttdeci">void removeChildren()</div><div class="ttdoc">Remove the children of the node. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a3f757f8e9d677e7e3ee7ea140f7b8627"><div class="ttname"><a href="classgf_1_1_space_tree.html#a3f757f8e9d677e7e3ee7ea140f7b8627">gf::SpaceTree::traverseInOrder</a></div><div class="ttdeci">bool traverseInOrder(Callback callback) const</div><div class="ttdoc">Traverse the nodes in in-order. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_aa3f37785dbfbebe63be924bb9dc35351"><div class="ttname"><a href="classgf_1_1_space_tree.html#aa3f37785dbfbebe63be924bb9dc35351">gf::SpaceTree::isLeaf</a></div><div class="ttdeci">bool isLeaf() const</div><div class="ttdoc">Check if a node is a leaf. </div><div class="ttdef"><b>Definition:</b> SpaceTree.h:119</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a263e021be898be8e55dc73dad00d0faf"><div class="ttname"><a href="classgf_1_1_space_tree.html#a263e021be898be8e55dc73dad00d0faf">gf::SpaceTree::getArea</a></div><div class="ttdeci">const RectI & getArea() const</div><div class="ttdoc">Get the area of the node. </div><div class="ttdef"><b>Definition:</b> SpaceTree.h:69</div></div>
<div class="ttc" id="_portability_8h_html_a0169111e0ff1d9fe0f23dee89e904d57"><div class="ttname"><a href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a></div><div class="ttdeci">#define GF_API</div><div class="ttdef"><b>Definition:</b> Portability.h:35</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html"><div class="ttname"><a href="classgf_1_1_space_tree.html">gf::SpaceTree</a></div><div class="ttdoc">Binary space random partionning tree. </div><div class="ttdef"><b>Definition:</b> SpaceTree.h:47</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_afbbf193f2c2955f103df029c1f389b67"><div class="ttname"><a href="classgf_1_1_space_tree.html#afbbf193f2c2955f103df029c1f389b67">gf::SpaceTree::traverseLevelOrder</a></div><div class="ttdeci">bool traverseLevelOrder(Callback callback) const</div><div class="ttdoc">Traverse the nodes in level-order. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_abb31e04f19948f17b0015d4e99ddb6b9"><div class="ttname"><a href="classgf_1_1_space_tree.html#abb31e04f19948f17b0015d4e99ddb6b9">gf::SpaceTree::getLevel</a></div><div class="ttdeci">int getLevel() const</div><div class="ttdoc">Get the level of the node in the tree. </div><div class="ttdef"><b>Definition:</b> SpaceTree.h:80</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_aec87a1eae162f44bf2330f695cada760"><div class="ttname"><a href="classgf_1_1_space_tree.html#aec87a1eae162f44bf2330f695cada760">gf::SpaceTree::contains</a></div><div class="ttdeci">bool contains(Vector2i position) const</div><div class="ttdoc">Check if the area of the node contains a position. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_aa98ebb65a493a9d2ce33930be0c791b7"><div class="ttname"><a href="classgf_1_1_space_tree.html#aa98ebb65a493a9d2ce33930be0c791b7">gf::SpaceTree::SpaceTree</a></div><div class="ttdeci">SpaceTree(const RectI &area)</div><div class="ttdoc">Constructor. </div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_a4d84231b3285a513de6a2a12b39b3c84"><div class="ttname"><a href="classgf_1_1_space_tree.html#a4d84231b3285a513de6a2a12b39b3c84">gf::SpaceTree::getLeftChild</a></div><div class="ttdeci">const SpaceTree * getLeftChild() const</div><div class="ttdoc">Get the left child. </div><div class="ttdef"><b>Definition:</b> SpaceTree.h:128</div></div>
<div class="ttc" id="classgf_1_1_space_tree_html_ad745cfda36ca5eacac0745b53d9e9471"><div class="ttname"><a href="classgf_1_1_space_tree.html#ad745cfda36ca5eacac0745b53d9e9471">gf::SpaceTree::traversePostOrder</a></div><div class="ttdeci">bool traversePostOrder(Callback callback) const</div><div class="ttdoc">Traverse the nodes in post-order. </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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.8.13
</small></address>
</body>
</html>