-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_polygon_8h_source.html
78 lines (78 loc) · 19.5 KB
/
_polygon_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
<!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): Polygon.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">Polygon.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_POLYGON_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_POLYGON_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 "Math.h"</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "Matrix.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 "SerializationFwd.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> <span class="preprocessor">#include "Winding.h"</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="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">struct </span>Transform;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classgf_1_1_polygon.html"> 46</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_polygon.html">Polygon</a> {</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</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_polygon.html">Polygon</a>() = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classgf_1_1_polygon.html">Polygon</a>(<a class="code" href="classgf_1_1_array_ref.html">ArrayRef<Vector2f></a> points);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">template</span><<span class="keyword">typename</span> Iterator></div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classgf_1_1_polygon.html#a1afe5d43ef0385b447950317454d3d47"> 67</a></span>  <a class="code" href="classgf_1_1_polygon.html#a1afe5d43ef0385b447950317454d3d47">Polygon</a>(Iterator first, Iterator last)</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  : m_points(first, last)</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="l00071"></a><span class="lineno"> 71</span>  }</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> isEmpty() <span class="keyword">const</span>;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">void</span> addPoint(<a class="code" href="structgf_1_1_vector.html">Vector2f</a> point);</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::size_t getPointCount() <span class="keyword">const</span>;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="structgf_1_1_vector.html">Vector2f</a> getPoint(std::size_t index) <span class="keyword">const</span>;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <a class="code" href="structgf_1_1_vector.html">Vector2f</a> getCenter() <span class="keyword">const</span>;</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="structgf_1_1_vector.html">Vector2f</a> getSupport(<a class="code" href="structgf_1_1_vector.html">Vector2f</a> direction, <span class="keyword">const</span> <a class="code" href="structgf_1_1_transform.html">Transform</a>& <a class="code" href="group__core.html#gac4e4c75521a6691a917073fa54a99dcf">transform</a>) <span class="keyword">const</span>;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <a class="code" href="structgf_1_1_vector.html">Vector2f</a> getSupport(<a class="code" href="structgf_1_1_vector.html">Vector2f</a> direction) <span class="keyword">const</span>;</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">const</span> <a class="code" href="structgf_1_1_vector.html">Vector2f</a> *begin() <span class="keyword">const</span>;</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keyword">const</span> <a class="code" href="structgf_1_1_vector.html">Vector2f</a> *end() <span class="keyword">const</span>;</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordtype">bool</span> isConvex() <span class="keyword">const</span>;</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  <a class="code" href="group__core.html#ga834b7c90c6d90647e9ba10caad190efa">Winding</a> getWinding() <span class="keyword">const</span>;</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordtype">float</span> getArea() <span class="keyword">const</span>;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  <span class="keywordtype">void</span> applyTransform(<span class="keyword">const</span> <a class="code" href="structgf_1_1_matrix.html">Matrix3f</a>& mat);</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">void</span> simplify(<span class="keywordtype">float</span> distance = <a class="code" href="group__core.html#gab4aa74a0cbea2a97c107bc5a1dc63a64">Epsilon</a>);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  std::vector<Vector2f> m_points;</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  };</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  GF_API <a class="code" href="classgf_1_1_serializer.html">Serializer</a>& operator|(<a class="code" href="classgf_1_1_serializer.html">Serializer</a>& ar, <span class="keyword">const</span> <a class="code" href="classgf_1_1_polygon.html">Polygon</a>& polygon);</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span> </div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  GF_API <a class="code" href="classgf_1_1_deserializer.html">Deserializer</a>& operator|(<a class="code" href="classgf_1_1_deserializer.html">Deserializer</a>& ar, <a class="code" href="classgf_1_1_polygon.html">Polygon</a>& polygon);</div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> }</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> }</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> </div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="preprocessor">#endif // GF_POLYGON_H</span></div><div class="ttc" id="classgf_1_1_deserializer_html"><div class="ttname"><a href="classgf_1_1_deserializer.html">gf::Deserializer</a></div><div class="ttdoc">A deserializer from a binary file. </div><div class="ttdef"><b>Definition:</b> Serialization.h:153</div></div>
<div class="ttc" id="classgf_1_1_polygon_html_a1afe5d43ef0385b447950317454d3d47"><div class="ttname"><a href="classgf_1_1_polygon.html#a1afe5d43ef0385b447950317454d3d47">gf::Polygon::Polygon</a></div><div class="ttdeci">Polygon(Iterator first, Iterator last)</div><div class="ttdoc">Constructor from points. </div><div class="ttdef"><b>Definition:</b> Polygon.h:67</div></div>
<div class="ttc" id="group__core_html_gac4e4c75521a6691a917073fa54a99dcf"><div class="ttname"><a href="group__core.html#gac4e4c75521a6691a917073fa54a99dcf">gf::transform</a></div><div class="ttdeci">constexpr Vector2f transform(const Matrix3f &mat, Vector2f point)</div><div class="ttdoc">Apply an affine transformation to a 2D point. </div><div class="ttdef"><b>Definition:</b> Transform.h:323</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="structgf_1_1_transform_html"><div class="ttname"><a href="structgf_1_1_transform.html">gf::Transform</a></div><div class="ttdoc">A simple transformation (rotation then translation) </div><div class="ttdef"><b>Definition:</b> Transform.h:200</div></div>
<div class="ttc" id="structgf_1_1_matrix_html"><div class="ttname"><a href="structgf_1_1_matrix.html">gf::Matrix< float, 3, 3 ></a></div></div>
<div class="ttc" id="classgf_1_1_serializer_html"><div class="ttname"><a href="classgf_1_1_serializer.html">gf::Serializer</a></div><div class="ttdoc">A serializer to a binary file. </div><div class="ttdef"><b>Definition:</b> Serialization.h:45</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_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_ga834b7c90c6d90647e9ba10caad190efa"><div class="ttname"><a href="group__core.html#ga834b7c90c6d90647e9ba10caad190efa">gf::Winding</a></div><div class="ttdeci">Winding</div><div class="ttdoc">The direction of a polygon&#39;s rotation. </div><div class="ttdef"><b>Definition:</b> Winding.h:33</div></div>
<div class="ttc" id="structgf_1_1_vector_html"><div class="ttname"><a href="structgf_1_1_vector.html">gf::Vector< float, 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>