-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_geometry_8h_source.html
80 lines (80 loc) · 18.9 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
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): 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="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/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.15.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">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-2019 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_GEOMETRY_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define 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">#include <vector></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 "ArrayRef.h"</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "Heightmap.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "Polygon.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "Random.h"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "Vector.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="l00045"></a><span class="lineno"><a class="line" href="classgf_1_1_bresenham.html"> 45</a></span>  <span class="keyword">class </span><a class="code" href="classgf_1_1_bresenham.html">Bresenham</a> {</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classgf_1_1_bresenham.html">Bresenham</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> p0, <a class="code" href="structgf_1_1_vector.html">Vector2i</a> p1);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keywordtype">bool</span> step(<a class="code" href="structgf_1_1_vector.html">Vector2i</a>& res);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> m_p0;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> m_p1;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> m_delta;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="structgf_1_1_vector.html">Vector2i</a> m_step;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">int</span> m_error;</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> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  GF_API std::vector<Vector2i> <a class="code" href="group__core.html#ga1ef096f0d24fef43c511b1a384a48e57">generateLine</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> p0, <a class="code" href="structgf_1_1_vector.html">Vector2i</a> p1);</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  GF_API std::vector<Vector2f> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">midpointDisplacement1D</a>(<a class="code" href="structgf_1_1_vector.html">Vector2f</a> p0, <a class="code" href="structgf_1_1_vector.html">Vector2f</a> p1, <a class="code" href="classgf_1_1_random.html">Random</a>& random, <span class="keywordtype">unsigned</span> iterations, <a class="code" href="structgf_1_1_vector.html">Vector2f</a> direction, <span class="keywordtype">float</span> initialFactor = 1.0f, <span class="keywordtype">float</span> reductionFactor = 0.5f);</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  GF_API std::vector<Vector2f> <a class="code" href="group__core.html#ga488a9efee6bb0ff4d2cb1028a60a83c6">midpointDisplacement1D</a>(<a class="code" href="structgf_1_1_vector.html">Vector2f</a> p0, <a class="code" href="structgf_1_1_vector.html">Vector2f</a> p1, <a class="code" href="classgf_1_1_random.html">Random</a>& random, <span class="keywordtype">unsigned</span> iterations, <span class="keywordtype">float</span> initialFactor = 1.0f, <span class="keywordtype">float</span> reductionFactor = 0.5f);</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> </div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  GF_API <a class="code" href="classgf_1_1_heightmap.html">Heightmap</a> <a class="code" href="group__core.html#ga00bbf9120e2ef9f449e55547a0e41324">midpointDisplacement2D</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size, <a class="code" href="classgf_1_1_random.html">Random</a>& random, <a class="code" href="classgf_1_1_array_ref.html">ArrayRef<double></a> initialValues = <span class="keyword">nullptr</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> </div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  GF_API <a class="code" href="classgf_1_1_heightmap.html">Heightmap</a> <a class="code" href="group__core.html#ga224a9e63967d8b82789bdc3c87797c26">diamondSquare2D</a>(<a class="code" href="structgf_1_1_vector.html">Vector2i</a> size, <a class="code" href="classgf_1_1_random.html">Random</a>& random, <a class="code" href="classgf_1_1_array_ref.html">ArrayRef<double></a> initialValues = <span class="keyword">nullptr</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> </div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  GF_API <a class="code" href="classgf_1_1_polygon.html">Polygon</a> <a class="code" href="group__core.html#gaf7b0d763c20f45b72e53ac274ca42e95">convexHull</a>(<a class="code" href="classgf_1_1_array_ref.html">ArrayRef<Vector2f></a> points);</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> </div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  GF_API std::vector<Vector2f> <a class="code" href="group__core.html#ga6182ea5351eb883f70f1a48e5cddd796">simplifyPoints</a>(<a class="code" href="classgf_1_1_array_ref.html">ArrayRef<Vector2f></a> points, <span class="keywordtype">float</span> distance = <a class="code" href="group__core.html#gab4aa74a0cbea2a97c107bc5a1dc63a64">Epsilon</a>);</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> }</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> }</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="preprocessor">#endif // 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:46</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="group__core_html_gab4aa74a0cbea2a97c107bc5a1dc63a64"><div class="ttname"><a href="group__core.html#gab4aa74a0cbea2a97c107bc5a1dc63a64">gf::Epsilon</a></div><div class="ttdeci">constexpr float Epsilon</div><div class="ttdoc">Machine epsilon. </div><div class="ttdef"><b>Definition:</b> Math.h:84</div></div>
<div class="ttc" id="group__core_html_ga6182ea5351eb883f70f1a48e5cddd796"><div class="ttname"><a href="group__core.html#ga6182ea5351eb883f70f1a48e5cddd796">gf::simplifyPoints</a></div><div class="ttdeci">std::vector< Vector2f > simplifyPoints(ArrayRef< Vector2f > points, float distance=Epsilon)</div><div class="ttdoc">Simplify a sequence of points. </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_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:35</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:43</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:45</div></div>
<div class="ttc" id="classgf_1_1_polygon_html"><div class="ttname"><a href="classgf_1_1_polygon.html">gf::Polygon</a></div><div class="ttdoc">A convex polygon. </div><div class="ttdef"><b>Definition:</b> Polygon.h:46</div></div>
<div class="ttc" id="group__core_html_gaf7b0d763c20f45b72e53ac274ca42e95"><div class="ttname"><a href="group__core.html#gaf7b0d763c20f45b72e53ac274ca42e95">gf::convexHull</a></div><div class="ttdeci">Polygon convexHull(ArrayRef< Vector2f > points)</div><div class="ttdoc">Compute the convex hull of a set of points. </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 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>