-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_geometry_8h_source.html
79 lines (79 loc) · 34.7 KB
/
_geometry_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
<!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): Geometry.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">Geometry.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_GEOMETRY_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_GEOMETRY_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> <span class="preprocessor"><</span><span class="preprocessor">vector</span><span class="preprocessor">></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </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="_array_ref_8h.html">"ArrayRef.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="_heightmap_8h.html">"Heightmap.h"</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</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="l00029"></a><span class="lineno"> 29</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="l00030"></a><span class="lineno"> 30</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="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace</span> <a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">inline</span> <span class="keyword">namespace</span> v1 {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</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"> * @ingroup core</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @brief State for the Bresenham's line algorithm</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"> * @sa gf::generateLine()</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @sa [Bresenham's line algorithm - Wikipedia](https://en.wikipedia.org/wiki/Bresenham%27s_line_algorithm)</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"><a class="line" href="classgf_1_1_bresenham.html"> 44</a></span>  <span class="keyword">class</span> <a class="code" href="classgf_1_1_bresenham.html">Bresenham</a> {</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keyword">public</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"> 47</span> <span class="comment"> * @brief Constructor</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> *</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @param p0 The first point of the line</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * @param p1 The last point of the line</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>  <a class="code" href="classgf_1_1_bresenham.html#a961de3bf3f9e3c10bc99872234412a35">Bresenham</a>(Vector2i p0, Vector2i p1);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</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"> 55</span> <span class="comment"> * @brief Generate a new point on the line</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> *</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> * @param res The resulting point if one was generated</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * @returns True if the algorithm is finished</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="keywordtype">bool</span> <a class="code" href="classgf_1_1_bresenham.html#a3264df6d89a1251564ecb2f7a4b1549e">step</a>(Vector2i& res);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  Vector2i m_p0;</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  Vector2i m_p1;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  Vector2i m_delta;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  Vector2i m_step;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">int</span> m_error;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  };</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</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"> 71</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * @brief Generate a line between two positions</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"> * This function uses [Bresenham's line algorithm](https://en.wikipedia.org/wiki/Bresenham%27s_line_algorithm).</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"> * @param p0 The first point of the line</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> * @param p1 The last point of the line</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * @return A series of point beginning at the first point and ending just before the last point</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"> 80</span> <span class="comment"> * @sa gf::Bresenham</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> */</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">std</a>::<a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">vector</a><<a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">Vector2i</a>> <a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">generateLine</a>(<a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">Vector2i</a> <a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">p0</a>, <a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">Vector2i</a> <a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">p1</a>);</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"> * @ingroup core</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> * @brief 1D midpoint displacement</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> *</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @param p0 The first end point</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @param p1 The second end point</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * @param random A random engine</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> * @param iterations The number of iterations</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @param direction The direction to make a displacement</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @param initialFactor The initial factor to apply to the displacement</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> * @param reductionFactor The factor to apply at each iteration</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> */</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">std</a>::<a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">vector</a><<a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">Vector2f</a>> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">midpointDisplacement1D</a>(<a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">Vector2f</a> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">p0</a>, <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">Vector2f</a> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">p1</a>, <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">Random</a>& <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">random</a>, <span class="keywordtype">unsigned</span> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">iterations</a>, <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">Vector2f</a> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">direction</a>, <span class="keywordtype">float</span> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">initialFactor</a> = 1.0f, <span class="keywordtype">float</span> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">reductionFactor</a> = 0.5f);</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>  <span class="comment">/**</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * @brief 1D midpoint displacement</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"> * The direction is perpendicular to the segment @f$ [P_0 P_1] @f$</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 p0 The first end point</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @param p1 The second end point</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @param random A random engine</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * @param iterations The number of iterations</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @param initialFactor The initial factor to apply to the displacement</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @param reductionFactor The factor to apply at each iteration</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> */</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">std</a>::<a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">vector</a><<a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">Vector2f</a>> <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">midpointDisplacement1D</a>(<a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">Vector2f</a> <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">p0</a>, <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">Vector2f</a> <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">p1</a>, <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">Random</a>& <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">random</a>, <span class="keywordtype">unsigned</span> <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">iterations</a>, <span class="keywordtype">float</span> <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">initialFactor</a> = 1.0f, <span class="keywordtype">float</span> <a class="code" href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">reductionFactor</a> = 0.5f);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</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"> * @ingroup core</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> * @brief 2D midpoint displacement</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> *</span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * The size can be anything. If the size is not a power of two plus one,</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * then a greater heightmap is generated and a submap of the right size</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * is returned (in the middle of the generated map).</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> *</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> * The function takes initial values. If there are less than three values,</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * only the first one is used to initialize the four corners. If there are</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * more than four, only the first four are used to initialize the four</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * corners in that order: north-west, north-east, south-east, south-west.</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> * If no values are given, the four corners are initialized to @f$ 0.0 @f$.</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"> * @param size The size of the map</span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> * @param random A random engine</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @param initialValues The initial values of the four corners</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> <span class="comment"> * @sa gf::diamondSquare2D()</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> */</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="classgf_1_1_heightmap.html">Heightmap</a> <a class="code" href="group__core.html#ga00bbf9120e2ef9f449e55547a0e41324">midpointDisplacement2D</a>(Vector2i size, <a class="code" href="classgf_1_1_random.html">Random</a>& random, <a class="code" href="classgf_1_1_array_ref.html">ArrayRef</a><<span class="keywordtype">double</span>> initialValues = <span class="keywordtype">nullptr</span>);</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> </div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">/**</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> * @ingroup core</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @brief 2D diamond square</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> <span class="comment"> * The size can be anything. If the size is not a power of two plus one,</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * then a greater heightmap is generated and a submap of the right size</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * is returned (in the middle of the generated map).</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> *</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * The function takes initial values. If there are less than three values,</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * only the first one is used to initialize the four corners. If there are</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * more than four, only the first four are used to initialize the four</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * corners in that order: north-west, north-east, south-east, south-west.</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * If no values are given, the four corners are initialized to @f$ 0.0 @f$.</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"> * @param size The size of the map</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @param random A random engine</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @param initialValues The initial values of the four corners</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"> * @sa gf::midpointDisplacement2D()</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>  <a class="code" href="_portability_8h.html#a0169111e0ff1d9fe0f23dee89e904d57">GF_API</a> <a class="code" href="classgf_1_1_heightmap.html">Heightmap</a> <a class="code" href="group__core.html#ga224a9e63967d8b82789bdc3c87797c26">diamondSquare2D</a>(Vector2i size, <a class="code" href="classgf_1_1_random.html">Random</a>& random, <a class="code" href="classgf_1_1_array_ref.html">ArrayRef</a><<span class="keywordtype">double</span>> initialValues = <span class="keywordtype">nullptr</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> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="preprocessor">#</span><span class="preprocessor">ifndef</span> <span class="preprocessor">DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> }</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> }</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> </div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="preprocessor">#</span><span class="preprocessor">endif</span> <span class="comment">// GF_GEOMETRY_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="group__core_html_ga488a9efee6bb0ff4d2cb1028a60a83c6"><div class="ttname"><a href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">gf::midpointDisplacement1D</a></div><div class="ttdeci">std::vector< Vector2f > midpointDisplacement1D(Vector2f p0, Vector2f p1, Random &random, unsigned iterations, Vector2f direction, float initialFactor=1.0f, float reductionFactor=0.5f)</div><div class="ttdoc">1D midpoint displacement </div></div>
<div class="ttc" id="group__core_html_ga224a9e63967d8b82789bdc3c87797c26"><div class="ttname"><a href="group__core.html#ga224a9e63967d8b82789bdc3c87797c26">gf::diamondSquare2D</a></div><div class="ttdeci">Heightmap diamondSquare2D(Vector2i size, Random &random, ArrayRef< double > initialValues=nullptr)</div><div class="ttdoc">2D diamond square </div></div>
<div class="ttc" id="classgf_1_1_heightmap_html"><div class="ttname"><a href="classgf_1_1_heightmap.html">gf::Heightmap</a></div><div class="ttdoc">A heightmap. </div><div class="ttdef"><b>Definition:</b> Heightmap.h:44</div></div>
<div class="ttc" id="group__core_html_gae219e7f9ceb8e7a56511019c5a4b082a"><div class="ttname"><a href="group__core.html#gae219e7f9ceb8e7a56511019c5a4b082a">gf::midpointDisplacement1D</a></div><div class="ttdeci">std::vector< Vector2f > midpointDisplacement1D(Vector2f p0, Vector2f p1, Random &random, unsigned iterations, float initialFactor=1.0f, float reductionFactor=0.5f)</div><div class="ttdoc">1D midpoint displacement </div></div>
<div class="ttc" id="group__core_html_ga1ef096f0d24fef43c511b1a384a48e57"><div class="ttname"><a href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">gf::generateLine</a></div><div class="ttdeci">std::vector< Vector2i > generateLine(Vector2i p0, Vector2i p1)</div><div class="ttdoc">Generate a line between two positions. </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_array_ref_html"><div class="ttname"><a href="classgf_1_1_array_ref.html">gf::ArrayRef</a></div><div class="ttdoc">A constant reference to an array and its size. </div><div class="ttdef"><b>Definition:</b> ArrayRef.h:42</div></div>
<div class="ttc" id="classgf_1_1_bresenham_html"><div class="ttname"><a href="classgf_1_1_bresenham.html">gf::Bresenham</a></div><div class="ttdoc">State for the Bresenham&#39;s line algorithm. </div><div class="ttdef"><b>Definition:</b> Geometry.h:44</div></div>
<div class="ttc" id="classgf_1_1_bresenham_html_a961de3bf3f9e3c10bc99872234412a35"><div class="ttname"><a href="classgf_1_1_bresenham.html#a961de3bf3f9e3c10bc99872234412a35">gf::Bresenham::Bresenham</a></div><div class="ttdeci">Bresenham(Vector2i p0, Vector2i p1)</div><div class="ttdoc">Constructor. </div></div>
<div class="ttc" id="classgf_1_1_bresenham_html_a3264df6d89a1251564ecb2f7a4b1549e"><div class="ttname"><a href="classgf_1_1_bresenham.html#a3264df6d89a1251564ecb2f7a4b1549e">gf::Bresenham::step</a></div><div class="ttdeci">bool step(Vector2i &res)</div><div class="ttdoc">Generate a new point on the line. </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__core_html_ga00bbf9120e2ef9f449e55547a0e41324"><div class="ttname"><a href="group__core.html#ga00bbf9120e2ef9f449e55547a0e41324">gf::midpointDisplacement2D</a></div><div class="ttdeci">Heightmap midpointDisplacement2D(Vector2i size, Random &random, ArrayRef< double > initialValues=nullptr)</div><div class="ttdoc">2D midpoint displacement </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>