-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_map_8h_source.html
103 lines (103 loc) · 67.3 KB
/
_map_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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<!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): Map.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">Map.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="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">GF_MAP_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">GF_MAP_H</span></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="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_array2_d_8h.html">"Array2D.h"</a></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="_flags_8h.html">"Flags.h"</a></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</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="l00027"></a><span class="lineno"> 27</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="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace</span> <a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">inline</span> <span class="keyword">namespace</span> v1 {</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">/**</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @brief A property of a cell</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> *</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @sa gf::CellFlags, gf::SquareMap</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> */</span></div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="group__game.html#gad82e9592419fd671caafe4af9b4f89e7"> 40</a></span>  <span class="keyword">enum</span> <span class="keyword">class</span> <a class="code" href="group__game.html#gad82e9592419fd671caafe4af9b4f89e7">CellProperty</a> : <a class="code" href="group__game.html#gad82e9592419fd671caafe4af9b4f89e7">uint8_t</a> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7a3d971943089a3388c01fb297a32d9ba7">Transparent</a> = 0x01, <span class="comment">///< The cell is transparent</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7a69266ac9c6970974587fe7f8b6b3c0a4">Walkable</a> = 0x02, <span class="comment">///< The cell is walkable</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7aec24d78ce33048dc73a2b6b1a0690192">Visible</a> = 0x10, <span class="comment">///< The cell is visible (computed by FoV)</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7aae1f26f8b07a89ba8a7a85a4d860274b">Explored</a> = 0x20, <span class="comment">///< The cell has been explored (computed by FoV)</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  };</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">/**</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @brief Flags composed of cell properties</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> *</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * @sa gf::CellProperty</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> */</span></div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__game.html#gae210e17d82de9239110f20f97c5e4a2a"> 53</a></span>  <span class="keyword">using</span> CellFlags = <a class="code" href="classgf_1_1_flags.html">Flags</a><<a class="code" href="group__game.html#gad82e9592419fd671caafe4af9b4f89e7">CellProperty</a>>;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">/**</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @brief An empty cell</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> *</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * An empty cell is transparent and walkable.</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> *</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> * @sa gf::CellProperty, gf::SquareMap</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> */</span></div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="group__game.html#gabde4b40b7057b604d7be3e3ee6e44f83"> 63</a></span>  <span class="keyword">constexpr</span> CellFlags <a class="code" href="group__game.html#gabde4b40b7057b604d7be3e3ee6e44f83">EmptyCell</a> = combineFlags(CellProperty::Transparent, CellProperty::Walkable);</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>  <span class="comment">/**</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * @brief Algorithm for computing a field of vision</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"> 69</span> <span class="comment"> * @sa gf::SquareMap</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> */</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="group__game.html#ga74d29b35a0c62fa4662b9d13dfdb6a9c"> 71</a></span>  <span class="keyword">enum</span> <span class="keyword">class</span> <a class="code" href="group__game.html#ga74d29b35a0c62fa4662b9d13dfdb6a9c">FieldOfVision</a> {</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="group__game.html#gga74d29b35a0c62fa4662b9d13dfdb6a9ca972e73b7a882d0802a4e3a16946a2f94">Basic</a>, <span class="comment">///< A basic algorithm based on ray casting</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</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>  <span class="comment">/**</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @brief Constant to indicate if the limit is part of the field of vision</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> *</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> * The limit is generally a wall that is next to a visible ground cell.</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> *</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * @sa gf::SquareMap</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> */</span></div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="group__game.html#gae6054347bb8a3a23255c73431e200e1f"> 83</a></span>  <span class="keyword">enum</span> <span class="keyword">class</span> <a class="code" href="group__game.html#gae6054347bb8a3a23255c73431e200e1f">FieldOfVisionLimit</a> {</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa984ceac16fab685fc50b8d8a5eabf7de">Included</a>, <span class="comment">///< The limits are included in the field of vision</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="code" href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa122180683375b33fd7171ebba4660f80">Excluded</a>, <span class="comment">///< The limits are *not* included in the field of vision</span></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> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">/**</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @brief Algorithm for computing a route</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"> * @sa gf::SquareMap</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"><a class="line" href="group__game.html#gab9ae4451ababe77363f782b6f6b1a0b0"> 94</a></span>  <span class="keyword">enum</span> <span class="keyword">class</span> <a class="code" href="group__game.html#gab9ae4451ababe77363f782b6f6b1a0b0">Route</a> {</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="code" href="group__game.html#ggab9ae4451ababe77363f782b6f6b1a0b0a5dd57ad2903b807a288f1519c98dfc29">AStar</a>, <span class="comment">///< The A* algorithm</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="group__game.html#ggab9ae4451ababe77363f782b6f6b1a0b0a052d7289884a0d0dae24aa88a7e62e83">Dijkstra</a>, <span class="comment">///< The Dijkstra algorithm</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  };</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="comment">/**</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @ingroup game</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * @brief A square map</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> *</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * A square map is a model of map where cells are organized in a square grid.</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * This type of map is quite common in games. gf provides some useful</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * algorithms related to square maps: field of vision, route finding.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> *</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * A cell can be transparent and/or walkable. By default, all cells are</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * neither transparent nor walkable i.e. they are walls. The transparent</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * property of a cell is used to compute the field of vision. The walkable</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * property of a cell is used to compute routes. A cell can be transparent</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * and not walkable (e.g. lava or water), it can be walkable and not</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * transparent (e.g. a secret passage).</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> *</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @sa gf::CellProperty</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> */</span></div><div class="line"><a name="l00116"></a><span class="lineno"><a class="line" href="classgf_1_1_square_map.html"> 116</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_square_map.html">SquareMap</a> {</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="comment">/**</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @brief Constructor</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> *</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @param size The size of the map</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> */</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <a class="code" href="classgf_1_1_square_map.html#a934f20da2a0707e4eb0737d744f7fa93">SquareMap</a>(Vector2i size);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</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"> 128</span> <span class="comment"> * @brief Get the size of the map</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> *</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @returns The size of the map</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> */</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  Vector2i <a class="code" href="classgf_1_1_square_map.html#a472354c567835368d5d893187499bc35">getSize</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</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"> * @brief Get a range of the positions of the map</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"> 137</span> <span class="comment"> * @returns A 2D range of all the positions</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> *</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @sa Array2D::getPositionRange()</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> */</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <a class="code" href="structgf_1_1_position_range.html">PositionRange</a><<span class="keywordtype">int</span>> <a class="code" href="classgf_1_1_square_map.html#a2f3d4ef05f3e7e5f871a6bc62813503a">getRange</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</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"> * @name Cell properties</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"> */</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="comment">/**</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @brief Set the properties of a cell</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> *</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * This function directly set all the properties of a cell. You should use</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * the other functions that set a particular property.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> *</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @param pos The position of the cell</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @param flags The properties of the cell</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="comment"> * @sa setTransparent(), setWalkable(), setEmpty()</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> */</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#afa43cf7855d8bbad41916a17ec7ed9cb">setCell</a>(Vector2i pos, CellFlags flags);</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</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"> * @brief Initialize the cells with some properties</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> *</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @param flags The properties to set</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> */</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#ae115bdca151dc147181e4608b2f11a46">clear</a>(CellFlags flags);</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <span class="comment">/**</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> <span class="comment"> * @brief Make a cell transparent</span></div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"> *</span></div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"> * @param pos The position of the cell</span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> *</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @sa isTransparent()</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> */</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#a9e18a64367bf298330c17cd53c325722">setTransparent</a>(Vector2i pos);</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="comment">/**</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> * @brief Check if a cell is transparent</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment"> *</span></div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @returns True if the cell is transparent</span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> *</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * @sa setTransparent()</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> */</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_square_map.html#ab3a30126aa8839dd4540d022628e10ed">isTransparent</a>(Vector2i pos) <span class="keyword">const</span>;</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="comment">/**</span></div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"> * @brief Make a cell walkable</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> *</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param pos The position of the cell</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> *</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @sa isWalkable()</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> */</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#a5e0c6b09f5507dee579ea5eb8d8585de">setWalkable</a>(Vector2i pos);</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> </div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="comment">/**</span></div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @brief Check if a cell is walkable</span></div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> *</span></div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @sa setWalkable()</span></div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> */</span></div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_square_map.html#a6d71bfd5723c7c9ed5f4316e6dfb23ce">isWalkable</a>(Vector2i pos) <span class="keyword">const</span>;</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</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="comment"> * @brief Make a cell empty</span></div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> *</span></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> * An empty cell is walkable and transparent</span></div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> *</span></div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> * @param pos The position of the cell</span></div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"> */</span></div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#a2ffd7d330fb240fc2ed78a7a05510c63">setEmpty</a>(Vector2i pos);</div><div class="line"><a name="l00210"></a><span class="lineno"> 210</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="comment"> * @}</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> */</span></div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="comment">/**</span></div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * @name Field of Vision</span></div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> */</span></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>  <span class="comment">/**</span></div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> * @brief Make the whole map not visible</span></div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> *</span></div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * You should call this function before computing a new field of vision.</span></div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> *</span></div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * @sa computeFieldOfVision()</span></div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> */</span></div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#a59d6d9a061ed896b81c494b358da60a6">clearFieldOfVision</a>();</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span>  <span class="comment">/**</span></div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * @brief Make the whole map not explored</span></div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> *</span></div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * You should call this function before exploring a new map.</span></div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> *</span></div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> * @sa computeFieldOfVision()</span></div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> */</span></div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#aca558709549a4968daf99e74a4107563">clearExplored</a>();</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>  <span class="comment">/**</span></div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * @brief Compute a field of vision</span></div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> *</span></div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> * The map is not cleared before computing the field of vision. The</span></div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> * algorithm use the transparent property of the cells. After calling this</span></div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment"> * function, some cells are marked visible.</span></div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> *</span></div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * This algorithm marks visible cells as explored.</span></div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> *</span></div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> * @param pos The position of the entity</span></div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> * @param maxRadius The maximum radius that the entity can see</span></div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"> * @param limit Is the limit included in the field of vision?</span></div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * @param algorithm The algorithm to use for computing the field of vision</span></div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> *</span></div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> * @sa clearFieldOfVision(), isInFieldOfVision()</span></div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> */</span></div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#a9af3454bc9028bce089a4f4e60942451">computeFieldOfVision</a>(Vector2i pos, <span class="keywordtype">int</span> maxRadius = 0, <a class="code" href="group__game.html#gae6054347bb8a3a23255c73431e200e1f">FieldOfVisionLimit</a> limit = <a class="code" href="group__game.html#gae6054347bb8a3a23255c73431e200e1f">FieldOfVisionLimit</a><a class="code" href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa984ceac16fab685fc50b8d8a5eabf7de">::</a><a class="code" href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa984ceac16fab685fc50b8d8a5eabf7de">Included</a>, <a class="code" href="group__game.html#ga74d29b35a0c62fa4662b9d13dfdb6a9c">FieldOfVision</a> algorithm = <a class="code" href="group__game.html#ga74d29b35a0c62fa4662b9d13dfdb6a9c">FieldOfVision</a><a class="code" href="group__game.html#gga74d29b35a0c62fa4662b9d13dfdb6a9ca972e73b7a882d0802a4e3a16946a2f94">::</a><a class="code" href="group__game.html#gga74d29b35a0c62fa4662b9d13dfdb6a9ca972e73b7a882d0802a4e3a16946a2f94">Basic</a>);</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span> </div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span>  <span class="comment">/**</span></div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * @brief Compute a local field of vision</span></div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> *</span></div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * The map is not cleared before computing the field of vision. The</span></div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> * algorithm use the transparent property of the cells. After calling this</span></div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> <span class="comment"> * function, some cells are marked visible.</span></div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span> <span class="comment"> *</span></div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span> <span class="comment"> * This algorithm does not mark visible cells as explored. It can be used</span></div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> <span class="comment"> * for computing an ennemy field of view without modifying the explored</span></div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> <span class="comment"> * area of the hero.</span></div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span> <span class="comment"> *</span></div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment"> * @param pos The position of the entity</span></div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment"> * @param maxRadius The maximum radius that the entity can see</span></div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment"> * @param limit Is the limit included in the field of vision?</span></div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> * @param algorithm The algorithm to use for computing the field of vision</span></div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> *</span></div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"> * @sa clearFieldOfVision(), isInFieldOfVision()</span></div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> */</span></div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_square_map.html#acfb6d30a2ccf3c27bd9ed8dffc3e27b2">computeLocalFieldOfVision</a>(Vector2i pos, <span class="keywordtype">int</span> maxRadius = 0, <a class="code" href="group__game.html#gae6054347bb8a3a23255c73431e200e1f">FieldOfVisionLimit</a> limit = <a class="code" href="group__game.html#gae6054347bb8a3a23255c73431e200e1f">FieldOfVisionLimit</a><a class="code" href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa984ceac16fab685fc50b8d8a5eabf7de">::</a><a class="code" href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa984ceac16fab685fc50b8d8a5eabf7de">Included</a>, <a class="code" href="group__game.html#ga74d29b35a0c62fa4662b9d13dfdb6a9c">FieldOfVision</a> algorithm = <a class="code" href="group__game.html#ga74d29b35a0c62fa4662b9d13dfdb6a9c">FieldOfVision</a><a class="code" href="group__game.html#gga74d29b35a0c62fa4662b9d13dfdb6a9ca972e73b7a882d0802a4e3a16946a2f94">::</a><a class="code" href="group__game.html#gga74d29b35a0c62fa4662b9d13dfdb6a9ca972e73b7a882d0802a4e3a16946a2f94">Basic</a>);</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> </div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  <span class="comment">/**</span></div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> * @brief Check if a cell is visible</span></div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> *</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> * Cells can be made visible by computing a field of vision.</span></div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> *</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> * @returns True if the cell is visible</span></div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> *</span></div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> * @sa computeFieldOfVision()</span></div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> */</span></div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_square_map.html#a556ce64e728c8924114a913bd881e171">isInFieldOfVision</a>(Vector2i pos) <span class="keyword">const</span>;</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> </div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span>  <span class="comment">/**</span></div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"> * @brief Check if a cell is explored</span></div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> *</span></div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> * Cells are explored if they have been in the field of vision after a</span></div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> * call to clearExplored().</span></div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment"> *</span></div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment"> * @sa computeFieldOfVision(), isInFieldOfVision()</span></div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="comment"> */</span></div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  <span class="keywordtype">bool</span> <a class="code" href="classgf_1_1_square_map.html#ad7d67457c44e78b811bd56879eb6c7d3">isExplored</a>(Vector2i pos) <span class="keyword">const</span>;</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  <span class="comment">/**</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> <span class="comment"> * @}</span></div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> <span class="comment"> */</span></div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="comment">/**</span></div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> <span class="comment"> * @name Route</span></div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> <span class="comment"> * @{</span></div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> <span class="comment"> */</span></div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span>  <span class="comment">/**</span></div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> <span class="comment"> * @brief Compute a route between two points</span></div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span> <span class="comment"> *</span></div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment"> * The algorithm use the walkable property of the cells. Diagonal movement</span></div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment"> * can be allowed and its cost can be adjusted (defaults to</span></div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment"> * @f$ \sqrt{2} @f$).</span></div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> *</span></div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> * @param origin The origin of the route</span></div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> * @param target The target of the route</span></div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> * @param diagonalCost The cost of going diagonal between two cells (0 means no diagonal movement)</span></div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> * @param algorithm The algorithm to use for computing the route</span></div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> * @returns The route between the two points (included)</span></div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> */</span></div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span>  <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">std</a>::<a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">vector</a><<a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">Vector2i</a>> <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">computeRoute</a>(<a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">Vector2i</a> <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">origin</a>, <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">Vector2i</a> <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">target</a>, <span class="keywordtype">float</span> <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">diagonalCost</a> = <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">Sqrt2</a>, <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">Route</a> <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">algorithm</a> = <a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">Route</a>::<a class="code" href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">AStar</a>);</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> </div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span>  <span class="comment">/**</span></div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> * @}</span></div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> */</span></div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span>  <a class="code" href="classgf_1_1_array2_d.html">Array2D</a><CellFlags, <span class="keywordtype">int</span>> m_cells;</div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  };</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span> </div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> }</div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="keyword">template</span><></div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="keyword">struct</span> EnableBitmaskOperators<<a class="code" href="group__game.html#gad82e9592419fd671caafe4af9b4f89e7">CellProperty</a>> {</div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> value = <span class="keyword">true</span>;</div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span> };</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span> }</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span> </div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span> </div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span> </div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span> <span class="comment">// GF_MAP_H</span></div><div class="ttc" id="classgf_1_1_square_map_html_a5e0c6b09f5507dee579ea5eb8d8585de"><div class="ttname"><a href="classgf_1_1_square_map.html#a5e0c6b09f5507dee579ea5eb8d8585de">gf::SquareMap::setWalkable</a></div><div class="ttdeci">void setWalkable(Vector2i pos)</div><div class="ttdoc">Make a cell walkable. </div></div>
<div class="ttc" id="classgf_1_1_array2_d_html"><div class="ttname"><a href="classgf_1_1_array2_d.html">gf::Array2D</a></div><div class="ttdoc">A two-dimensional array. </div><div class="ttdef"><b>Definition:</b> Array2D.h:63</div></div>
<div class="ttc" id="classgf_1_1_square_map_html_aca558709549a4968daf99e74a4107563"><div class="ttname"><a href="classgf_1_1_square_map.html#aca558709549a4968daf99e74a4107563">gf::SquareMap::clearExplored</a></div><div class="ttdeci">void clearExplored()</div><div class="ttdoc">Make the whole map not explored. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a9e18a64367bf298330c17cd53c325722"><div class="ttname"><a href="classgf_1_1_square_map.html#a9e18a64367bf298330c17cd53c325722">gf::SquareMap::setTransparent</a></div><div class="ttdeci">void setTransparent(Vector2i pos)</div><div class="ttdoc">Make a cell transparent. </div></div>
<div class="ttc" id="group__game_html_gab9ae4451ababe77363f782b6f6b1a0b0"><div class="ttname"><a href="group__game.html#gab9ae4451ababe77363f782b6f6b1a0b0">gf::Route</a></div><div class="ttdeci">Route</div><div class="ttdoc">Algorithm for computing a route. </div><div class="ttdef"><b>Definition:</b> Map.h:94</div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a59d6d9a061ed896b81c494b358da60a6"><div class="ttname"><a href="classgf_1_1_square_map.html#a59d6d9a061ed896b81c494b358da60a6">gf::SquareMap::clearFieldOfVision</a></div><div class="ttdeci">void clearFieldOfVision()</div><div class="ttdoc">Make the whole map not visible. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a9af3454bc9028bce089a4f4e60942451"><div class="ttname"><a href="classgf_1_1_square_map.html#a9af3454bc9028bce089a4f4e60942451">gf::SquareMap::computeFieldOfVision</a></div><div class="ttdeci">void computeFieldOfVision(Vector2i pos, int maxRadius=0, FieldOfVisionLimit limit=FieldOfVisionLimit::Included, FieldOfVision algorithm=FieldOfVision::Basic)</div><div class="ttdoc">Compute a field of vision. </div></div>
<div class="ttc" id="classgf_1_1_flags_html"><div class="ttname"><a href="classgf_1_1_flags.html">gf::Flags</a></div><div class="ttdoc">Bitfield relying on an enumeration. </div><div class="ttdef"><b>Definition:</b> Flags.h:68</div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a2f3d4ef05f3e7e5f871a6bc62813503a"><div class="ttname"><a href="classgf_1_1_square_map.html#a2f3d4ef05f3e7e5f871a6bc62813503a">gf::SquareMap::getRange</a></div><div class="ttdeci">PositionRange< int > getRange() const</div><div class="ttdoc">Get a range of the positions of the map. </div></div>
<div class="ttc" id="group__game_html_ggae6054347bb8a3a23255c73431e200e1fa984ceac16fab685fc50b8d8a5eabf7de"><div class="ttname"><a href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa984ceac16fab685fc50b8d8a5eabf7de">gf::FieldOfVisionLimit::Included</a></div><div class="ttdoc">The limits are included in the field of vision. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a2ffd7d330fb240fc2ed78a7a05510c63"><div class="ttname"><a href="classgf_1_1_square_map.html#a2ffd7d330fb240fc2ed78a7a05510c63">gf::SquareMap::setEmpty</a></div><div class="ttdeci">void setEmpty(Vector2i pos)</div><div class="ttdoc">Make a cell empty. </div></div>
<div class="ttc" id="group__game_html_gad82e9592419fd671caafe4af9b4f89e7"><div class="ttname"><a href="group__game.html#gad82e9592419fd671caafe4af9b4f89e7">gf::CellProperty</a></div><div class="ttdeci">CellProperty</div><div class="ttdoc">A property of a cell. </div><div class="ttdef"><b>Definition:</b> Map.h:40</div></div>
<div class="ttc" id="classgf_1_1_square_map_html_ad7d67457c44e78b811bd56879eb6c7d3"><div class="ttname"><a href="classgf_1_1_square_map.html#ad7d67457c44e78b811bd56879eb6c7d3">gf::SquareMap::isExplored</a></div><div class="ttdeci">bool isExplored(Vector2i pos) const</div><div class="ttdoc">Check if a cell is explored. </div></div>
<div class="ttc" id="group__game_html_ggad82e9592419fd671caafe4af9b4f89e7aec24d78ce33048dc73a2b6b1a0690192"><div class="ttname"><a href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7aec24d78ce33048dc73a2b6b1a0690192">gf::CellProperty::Visible</a></div><div class="ttdoc">The cell is visible (computed by FoV) </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a556ce64e728c8924114a913bd881e171"><div class="ttname"><a href="classgf_1_1_square_map.html#a556ce64e728c8924114a913bd881e171">gf::SquareMap::isInFieldOfVision</a></div><div class="ttdeci">bool isInFieldOfVision(Vector2i pos) const</div><div class="ttdoc">Check if a cell is visible. </div></div>
<div class="ttc" id="group__game_html_gga74d29b35a0c62fa4662b9d13dfdb6a9ca972e73b7a882d0802a4e3a16946a2f94"><div class="ttname"><a href="group__game.html#gga74d29b35a0c62fa4662b9d13dfdb6a9ca972e73b7a882d0802a4e3a16946a2f94">gf::FieldOfVision::Basic</a></div><div class="ttdoc">A basic algorithm based on ray casting. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_ae115bdca151dc147181e4608b2f11a46"><div class="ttname"><a href="classgf_1_1_square_map.html#ae115bdca151dc147181e4608b2f11a46">gf::SquareMap::clear</a></div><div class="ttdeci">void clear(CellFlags flags)</div><div class="ttdoc">Initialize the cells with some properties. </div></div>
<div class="ttc" id="group__game_html_gae6054347bb8a3a23255c73431e200e1f"><div class="ttname"><a href="group__game.html#gae6054347bb8a3a23255c73431e200e1f">gf::FieldOfVisionLimit</a></div><div class="ttdeci">FieldOfVisionLimit</div><div class="ttdoc">Constant to indicate if the limit is part of the field of vision. </div><div class="ttdef"><b>Definition:</b> Map.h:83</div></div>
<div class="ttc" id="group__game_html_ggab9ae4451ababe77363f782b6f6b1a0b0a052d7289884a0d0dae24aa88a7e62e83"><div class="ttname"><a href="group__game.html#ggab9ae4451ababe77363f782b6f6b1a0b0a052d7289884a0d0dae24aa88a7e62e83">gf::Route::Dijkstra</a></div><div class="ttdoc">The Dijkstra algorithm. </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_square_map_html_afa43cf7855d8bbad41916a17ec7ed9cb"><div class="ttname"><a href="classgf_1_1_square_map.html#afa43cf7855d8bbad41916a17ec7ed9cb">gf::SquareMap::setCell</a></div><div class="ttdeci">void setCell(Vector2i pos, CellFlags flags)</div><div class="ttdoc">Set the properties of a cell. </div></div>
<div class="ttc" id="group__game_html_ga74d29b35a0c62fa4662b9d13dfdb6a9c"><div class="ttname"><a href="group__game.html#ga74d29b35a0c62fa4662b9d13dfdb6a9c">gf::FieldOfVision</a></div><div class="ttdeci">FieldOfVision</div><div class="ttdoc">Algorithm for computing a field of vision. </div><div class="ttdef"><b>Definition:</b> Map.h:71</div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a3260b594356c906e82e038565ded2c04"><div class="ttname"><a href="classgf_1_1_square_map.html#a3260b594356c906e82e038565ded2c04">gf::SquareMap::computeRoute</a></div><div class="ttdeci">std::vector< Vector2i > computeRoute(Vector2i origin, Vector2i target, float diagonalCost=Sqrt2, Route algorithm=Route::AStar)</div><div class="ttdoc">Compute a route between two points. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a472354c567835368d5d893187499bc35"><div class="ttname"><a href="classgf_1_1_square_map.html#a472354c567835368d5d893187499bc35">gf::SquareMap::getSize</a></div><div class="ttdeci">Vector2i getSize() const</div><div class="ttdoc">Get the size of the map. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html"><div class="ttname"><a href="classgf_1_1_square_map.html">gf::SquareMap</a></div><div class="ttdoc">A square map. </div><div class="ttdef"><b>Definition:</b> Map.h:116</div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a6d71bfd5723c7c9ed5f4316e6dfb23ce"><div class="ttname"><a href="classgf_1_1_square_map.html#a6d71bfd5723c7c9ed5f4316e6dfb23ce">gf::SquareMap::isWalkable</a></div><div class="ttdeci">bool isWalkable(Vector2i pos) const</div><div class="ttdoc">Check if a cell is walkable. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_a934f20da2a0707e4eb0737d744f7fa93"><div class="ttname"><a href="classgf_1_1_square_map.html#a934f20da2a0707e4eb0737d744f7fa93">gf::SquareMap::SquareMap</a></div><div class="ttdeci">SquareMap(Vector2i size)</div><div class="ttdoc">Constructor. </div></div>
<div class="ttc" id="classgf_1_1_square_map_html_ab3a30126aa8839dd4540d022628e10ed"><div class="ttname"><a href="classgf_1_1_square_map.html#ab3a30126aa8839dd4540d022628e10ed">gf::SquareMap::isTransparent</a></div><div class="ttdeci">bool isTransparent(Vector2i pos) const</div><div class="ttdoc">Check if a cell is transparent. </div></div>
<div class="ttc" id="group__game_html_ggab9ae4451ababe77363f782b6f6b1a0b0a5dd57ad2903b807a288f1519c98dfc29"><div class="ttname"><a href="group__game.html#ggab9ae4451ababe77363f782b6f6b1a0b0a5dd57ad2903b807a288f1519c98dfc29">gf::Route::AStar</a></div><div class="ttdoc">The A* algorithm. </div></div>
<div class="ttc" id="structgf_1_1_position_range_html"><div class="ttname"><a href="structgf_1_1_position_range.html">gf::PositionRange</a></div><div class="ttdoc">A 2D range. </div><div class="ttdef"><b>Definition:</b> Range.h:225</div></div>
<div class="ttc" id="classgf_1_1_square_map_html_acfb6d30a2ccf3c27bd9ed8dffc3e27b2"><div class="ttname"><a href="classgf_1_1_square_map.html#acfb6d30a2ccf3c27bd9ed8dffc3e27b2">gf::SquareMap::computeLocalFieldOfVision</a></div><div class="ttdeci">void computeLocalFieldOfVision(Vector2i pos, int maxRadius=0, FieldOfVisionLimit limit=FieldOfVisionLimit::Included, FieldOfVision algorithm=FieldOfVision::Basic)</div><div class="ttdoc">Compute a local field of vision. </div></div>
<div class="ttc" id="group__game_html_ggad82e9592419fd671caafe4af9b4f89e7a69266ac9c6970974587fe7f8b6b3c0a4"><div class="ttname"><a href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7a69266ac9c6970974587fe7f8b6b3c0a4">gf::CellProperty::Walkable</a></div><div class="ttdoc">The cell is walkable. </div></div>
<div class="ttc" id="group__game_html_ggad82e9592419fd671caafe4af9b4f89e7a3d971943089a3388c01fb297a32d9ba7"><div class="ttname"><a href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7a3d971943089a3388c01fb297a32d9ba7">gf::CellProperty::Transparent</a></div><div class="ttdoc">The cell is transparent. </div></div>
<div class="ttc" id="group__game_html_ggad82e9592419fd671caafe4af9b4f89e7aae1f26f8b07a89ba8a7a85a4d860274b"><div class="ttname"><a href="group__game.html#ggad82e9592419fd671caafe4af9b4f89e7aae1f26f8b07a89ba8a7a85a4d860274b">gf::CellProperty::Explored</a></div><div class="ttdoc">The cell has been explored (computed by FoV) </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="group__game_html_ggae6054347bb8a3a23255c73431e200e1fa122180683375b33fd7171ebba4660f80"><div class="ttname"><a href="group__game.html#ggae6054347bb8a3a23255c73431e200e1fa122180683375b33fd7171ebba4660f80">gf::FieldOfVisionLimit::Excluded</a></div><div class="ttdoc">The limits are not included in the field of vision. </div></div>
<div class="ttc" id="group__game_html_gabde4b40b7057b604d7be3e3ee6e44f83"><div class="ttname"><a href="group__game.html#gabde4b40b7057b604d7be3e3ee6e44f83">gf::EmptyCell</a></div><div class="ttdeci">constexpr CellFlags EmptyCell</div><div class="ttdoc">An empty cell. </div><div class="ttdef"><b>Definition:</b> Map.h:63</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>