-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_heightmap_8h_source.html
80 lines (80 loc) · 21.9 KB
/
_heightmap_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
<!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): Heightmap.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.11.0</span>
</div>
<div id="projectbrief">A C++14 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">Heightmap.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-2018 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">#ifndef GF_HEIGHTMAP_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_HEIGHTMAP_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">#include <tuple></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">#include "Array2D.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "ColorRamp.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "Image.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "Noise.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "Rect.h"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="classgf_1_1_heightmap.html"> 44</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_heightmap.html">Heightmap</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="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classgf_1_1_heightmap.html">Heightmap</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classgf_1_1_heightmap.html#ae77848b6cdd60658af1d15764cde6bac"> 58</a></span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> <a class="code" href="classgf_1_1_heightmap.html#ae77848b6cdd60658af1d15764cde6bac">getSize</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordflow">return</span> m_data.getSize();</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> reset();</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="classgf_1_1_heightmap.html#ad4025649625bd737917459a9cef8437e"> 75</a></span>  <span class="keywordtype">double</span> <a class="code" href="classgf_1_1_heightmap.html#ad4025649625bd737917459a9cef8437e">getValue</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> position)<span class="keyword"> const </span>{</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordflow">return</span> m_data(position);</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classgf_1_1_heightmap.html#a61242f9a76feea5df8cc87242e0d9274"> 85</a></span>  <span class="keywordtype">void</span> <a class="code" href="classgf_1_1_heightmap.html#a61242f9a76feea5df8cc87242e0d9274">setValue</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> position, <span class="keywordtype">double</span> value) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  m_data(position) = value;</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> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  std::tuple<double, double> getMinMax() <span class="keyword">const</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">void</span> normalize(<span class="keywordtype">double</span> min = 0.0, <span class="keywordtype">double</span> max = 1.0);</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">void</span> addHill(<a class="code" href="structgf_1_1_vector.html">Vector2d</a> center, <span class="keywordtype">double</span> radius, <span class="keywordtype">double</span> height);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">void</span> digHill(<a class="code" href="structgf_1_1_vector.html">Vector2d</a> center, <span class="keywordtype">double</span> radius, <span class="keywordtype">double</span> height);</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">void</span> addNoise(<a class="code" href="classgf_1_1_noise2_d.html">Noise2D</a>& noise, <span class="keywordtype">double</span> <a class="code" href="group__core.html#ga9a28734646b10ca5179fc221c103545a">scale</a> = 1.0);</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">void</span> addValue(<span class="keywordtype">double</span> value);</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> </div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  <span class="keywordtype">void</span> <a class="code" href="group__core.html#ga9a28734646b10ca5179fc221c103545a">scale</a>(<span class="keywordtype">double</span> value);</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  <span class="keywordtype">void</span> <a class="code" href="group__core.html#ga671bdda5a52c335e68d391147c70cc16">clamp</a>(<span class="keywordtype">double</span> min = 0.0, <span class="keywordtype">double</span> max = 1.0);</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  <span class="keywordtype">double</span> getSlope(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> position) <span class="keyword">const</span>;</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">void</span> thermalErosion(<span class="keywordtype">unsigned</span> iterations, <span class="keywordtype">double</span> talus, <span class="keywordtype">double</span> fraction);</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> </div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <span class="keywordtype">void</span> hydraulicErosion(<span class="keywordtype">unsigned</span> iterations, <span class="keywordtype">double</span> rainAmount, <span class="keywordtype">double</span> solubility, <span class="keywordtype">double</span> evaporation, <span class="keywordtype">double</span> capacity);</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordtype">void</span> fastErosion(<span class="keywordtype">unsigned</span> iterations, <span class="keywordtype">double</span> talus, <span class="keywordtype">double</span> fraction);</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">double</span> getErosionScore() <span class="keyword">const</span>;</div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span> </div><div class="line"><a name="l00224"></a><span class="lineno"><a class="line" href="classgf_1_1_heightmap.html#aca20336340f6c9f326e6aeeee96d4ae4"> 224</a></span>  <span class="keyword">enum class</span> <a class="code" href="classgf_1_1_heightmap.html#aca20336340f6c9f326e6aeeee96d4ae4">Render</a> {</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  Colored, </div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  Shaded, </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  };</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span> </div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <a class="code" href="classgf_1_1_heightmap.html">Heightmap</a> subMap(<a class="code" href="structgf_1_1_rect.html">RectI</a> area) <span class="keyword">const</span>;</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span> </div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  <a class="code" href="classgf_1_1_image.html">Image</a> copyToGrayscaleImage() <span class="keyword">const</span>;</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span> </div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  <a class="code" href="classgf_1_1_image.html">Image</a> copyToColoredImage(<span class="keyword">const</span> <a class="code" href="structgf_1_1_color_ramp.html">ColorRamp</a>& ramp, <span class="keywordtype">double</span> waterLevel = 0.5, <a class="code" href="classgf_1_1_heightmap.html#aca20336340f6c9f326e6aeeee96d4ae4">Render</a> render = Render::Colored) <span class="keyword">const</span>;</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span>  <a class="code" href="classgf_1_1_array2_d.html">Array2D<double, int></a> m_data;</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  };</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> </div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> }</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> }</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="preprocessor">#endif // GF_HEIGHTMAP_H</span></div><div class="ttc" id="classgf_1_1_heightmap_html_a61242f9a76feea5df8cc87242e0d9274"><div class="ttname"><a href="classgf_1_1_heightmap.html#a61242f9a76feea5df8cc87242e0d9274">gf::Heightmap::setValue</a></div><div class="ttdeci">void setValue(Vector2i position, double value)</div><div class="ttdoc">Set the value at the specified position. </div><div class="ttdef"><b>Definition:</b> Heightmap.h:85</div></div>
<div class="ttc" id="group__core_html_ga9a28734646b10ca5179fc221c103545a"><div class="ttname"><a href="group__core.html#ga9a28734646b10ca5179fc221c103545a">gf::scale</a></div><div class="ttdeci">void scale(Matrix3f &mat, Vector2f factor)</div><div class="ttdoc">Combine the current transform with a scaling. </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< double, int ></a></div></div>
<div class="ttc" id="structgf_1_1_color_ramp_html"><div class="ttname"><a href="structgf_1_1_color_ramp.html">gf::ColorRamp</a></div><div class="ttdoc">A color ramp. </div><div class="ttdef"><b>Definition:</b> ColorRamp.h:41</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="classgf_1_1_noise2_d_html"><div class="ttname"><a href="classgf_1_1_noise2_d.html">gf::Noise2D</a></div><div class="ttdoc">2D A noise function </div><div class="ttdef"><b>Definition:</b> Noise.h:35</div></div>
<div class="ttc" id="group__core_html_ga671bdda5a52c335e68d391147c70cc16"><div class="ttname"><a href="group__core.html#ga671bdda5a52c335e68d391147c70cc16">gf::clamp</a></div><div class="ttdeci">constexpr T clamp(T val, T lo, T hi)</div><div class="ttdoc">Clamping function. </div><div class="ttdef"><b>Definition:</b> Math.h:260</div></div>
<div class="ttc" id="classgf_1_1_heightmap_html_ae77848b6cdd60658af1d15764cde6bac"><div class="ttname"><a href="classgf_1_1_heightmap.html#ae77848b6cdd60658af1d15764cde6bac">gf::Heightmap::getSize</a></div><div class="ttdeci">Vector2i getSize() const</div><div class="ttdoc">Get the size of the heightmap. </div><div class="ttdef"><b>Definition:</b> Heightmap.h:58</div></div>
<div class="ttc" id="classgf_1_1_heightmap_html_aca20336340f6c9f326e6aeeee96d4ae4"><div class="ttname"><a href="classgf_1_1_heightmap.html#aca20336340f6c9f326e6aeeee96d4ae4">gf::Heightmap::Render</a></div><div class="ttdeci">Render</div><div class="ttdoc">Rendering mode. </div><div class="ttdef"><b>Definition:</b> Heightmap.h:224</div></div>
<div class="ttc" id="structgf_1_1_rect_html"><div class="ttname"><a href="structgf_1_1_rect.html">gf::Rect< int ></a></div></div>
<div class="ttc" id="classgf_1_1_image_html"><div class="ttname"><a href="classgf_1_1_image.html">gf::Image</a></div><div class="ttdoc">Class for loading, manipulating and saving images. </div><div class="ttdef"><b>Definition:</b> Image.h:92</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:35</div></div>
<div class="ttc" id="classgf_1_1_heightmap_html_ad4025649625bd737917459a9cef8437e"><div class="ttname"><a href="classgf_1_1_heightmap.html#ad4025649625bd737917459a9cef8437e">gf::Heightmap::getValue</a></div><div class="ttdeci">double getValue(Vector2i position) const</div><div class="ttdoc">Get the value at the specified position. </div><div class="ttdef"><b>Definition:</b> Heightmap.h:75</div></div>
<div class="ttc" id="structgf_1_1_vector_html"><div class="ttname"><a href="structgf_1_1_vector.html">gf::Vector< int, 2 ></a></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>