-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_coordinates_8h_source.html
142 lines (142 loc) · 17.8 KB
/
_coordinates_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.3"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Gamedev Framework (gf): Coordinates.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" async="async" 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 id="projectrow">
<td id="projectlogo"><img alt="Logo" src="gf_logo.png"/></td>
<td id="projectalign">
<div id="projectname">Gamedev Framework (gf)<span id="projectnumber"> 0.21.0</span>
</div>
<div id="projectbrief">A C++17 framework for 2D games</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</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">Coordinates.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Gamedev Framework (gf)</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * Copyright (C) 2016-2021 Julien Bernard</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" 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 id="l00006" 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 id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * arising from the use of this software.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" 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 id="l00010" 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 id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> * freely, subject to the following restrictions:</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> *</span></div>
<div class="line"><a id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * appreciated but is not required.</span></div>
<div class="line"><a id="l00017" 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 id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> * misrepresented as being the original software.</span></div>
<div class="line"><a id="l00019" 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 id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment"> */</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifndef GF_COORDINATES_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#define GF_COORDINATES_H</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include "Anchor.h"</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include "GraphicsApi.h"</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include "Vector.h"</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegf.html">gf</a> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">class </span>RenderTarget;</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html"> 39</a></span> <span class="keyword">class </span>GF_GRAPHICS_API <a class="code hl_class" href="classgf_1_1_coordinates.html">Coordinates</a> {</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#a15570ed8abbd43a951e23103e80b6485"> 46</a></span> <a class="code hl_function" href="classgf_1_1_coordinates.html#a15570ed8abbd43a951e23103e80b6485">Coordinates</a>(<a class="code hl_class" href="structgf_1_1_vector.html">Vector2i</a> size);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#a6b54ff683ec6304504ec1a2768b06306"> 53</a></span> <a class="code hl_function" href="classgf_1_1_coordinates.html#a6b54ff683ec6304504ec1a2768b06306">Coordinates</a>(<a class="code hl_class" href="classgf_1_1_render_target.html">RenderTarget</a>& target);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#a47ded7ad6ffadd9c8f0dd235652f300d"> 60</a></span> <a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> <a class="code hl_function" href="classgf_1_1_coordinates.html#a47ded7ad6ffadd9c8f0dd235652f300d">getWindowSize</a>()<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> m_size;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> }</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#ada9f2993eaf3bd1b4a747e6b075ac552"> 69</a></span> <a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> <a class="code hl_function" href="classgf_1_1_coordinates.html#ada9f2993eaf3bd1b4a747e6b075ac552">getCenter</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#af855c3d9c45789f8aac4bcaf05cc887f"> 76</a></span> <a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> <a class="code hl_function" href="classgf_1_1_coordinates.html#af855c3d9c45789f8aac4bcaf05cc887f">getRelativePoint</a>(<a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> percent) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#a5e3ace73c6379c7fc5deb80ed7e9fef2"> 83</a></span> <a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> <a class="code hl_function" href="classgf_1_1_coordinates.html#a5e3ace73c6379c7fc5deb80ed7e9fef2">getRelativeSize</a>(<a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> percent) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#a428bb9d962656b41491c4153f93d67dc"> 90</a></span> <span class="keywordtype">unsigned</span> <a class="code hl_function" href="classgf_1_1_coordinates.html#a428bb9d962656b41491c4153f93d67dc">getRelativeCharacterSize</a>(<span class="keywordtype">float</span> percent) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classgf_1_1_coordinates.html#a5f7139eb147c8c02ead7dc8d90bbc333"> 98</a></span> <a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> <a class="code hl_function" href="classgf_1_1_coordinates.html#a5f7139eb147c8c02ead7dc8d90bbc333">getAbsolutePoint</a>(<a class="code hl_class" href="structgf_1_1_vector.html">Vector2f</a> distance, <a class="code hl_enumeration" href="group__graphics__drawables.html#gadeb9cdf9d7e8eec2eb8cc638c54b5066">Anchor</a> anchor) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <a class="code hl_class" href="structgf_1_1_vector.html">Vector2i</a> m_size;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> };</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>}</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span>}</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="preprocessor">#endif </span><span class="comment">// GF_COORDINATES_H</span></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html"><div class="ttname"><a href="classgf_1_1_coordinates.html">gf::Coordinates</a></div><div class="ttdoc">Helper to compute coordinates in HUD.</div><div class="ttdef"><b>Definition:</b> Coordinates.h:39</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_a15570ed8abbd43a951e23103e80b6485"><div class="ttname"><a href="classgf_1_1_coordinates.html#a15570ed8abbd43a951e23103e80b6485">gf::Coordinates::Coordinates</a></div><div class="ttdeci">Coordinates(Vector2i size)</div><div class="ttdoc">Constructor with size.</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_a428bb9d962656b41491c4153f93d67dc"><div class="ttname"><a href="classgf_1_1_coordinates.html#a428bb9d962656b41491c4153f93d67dc">gf::Coordinates::getRelativeCharacterSize</a></div><div class="ttdeci">unsigned getRelativeCharacterSize(float percent) const</div><div class="ttdoc">Compute a relative character size.</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_a47ded7ad6ffadd9c8f0dd235652f300d"><div class="ttname"><a href="classgf_1_1_coordinates.html#a47ded7ad6ffadd9c8f0dd235652f300d">gf::Coordinates::getWindowSize</a></div><div class="ttdeci">Vector2f getWindowSize() const</div><div class="ttdoc">Get the size of the window.</div><div class="ttdef"><b>Definition:</b> Coordinates.h:60</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_a5e3ace73c6379c7fc5deb80ed7e9fef2"><div class="ttname"><a href="classgf_1_1_coordinates.html#a5e3ace73c6379c7fc5deb80ed7e9fef2">gf::Coordinates::getRelativeSize</a></div><div class="ttdeci">Vector2f getRelativeSize(Vector2f percent) const</div><div class="ttdoc">Compute a relative size.</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_a5f7139eb147c8c02ead7dc8d90bbc333"><div class="ttname"><a href="classgf_1_1_coordinates.html#a5f7139eb147c8c02ead7dc8d90bbc333">gf::Coordinates::getAbsolutePoint</a></div><div class="ttdeci">Vector2f getAbsolutePoint(Vector2f distance, Anchor anchor) const</div><div class="ttdoc">Compute an absolute point.</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_a6b54ff683ec6304504ec1a2768b06306"><div class="ttname"><a href="classgf_1_1_coordinates.html#a6b54ff683ec6304504ec1a2768b06306">gf::Coordinates::Coordinates</a></div><div class="ttdeci">Coordinates(RenderTarget &target)</div><div class="ttdoc">Constructor with render target.</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_ada9f2993eaf3bd1b4a747e6b075ac552"><div class="ttname"><a href="classgf_1_1_coordinates.html#ada9f2993eaf3bd1b4a747e6b075ac552">gf::Coordinates::getCenter</a></div><div class="ttdeci">Vector2f getCenter() const</div><div class="ttdoc">Get the center of the window.</div></div>
<div class="ttc" id="aclassgf_1_1_coordinates_html_af855c3d9c45789f8aac4bcaf05cc887f"><div class="ttname"><a href="classgf_1_1_coordinates.html#af855c3d9c45789f8aac4bcaf05cc887f">gf::Coordinates::getRelativePoint</a></div><div class="ttdeci">Vector2f getRelativePoint(Vector2f percent) const</div><div class="ttdoc">Compute a relative point.</div></div>
<div class="ttc" id="aclassgf_1_1_render_target_html"><div class="ttname"><a href="classgf_1_1_render_target.html">gf::RenderTarget</a></div><div class="ttdoc">Base class for all render targets (window, texture, ...)</div><div class="ttdef"><b>Definition:</b> RenderTarget.h:102</div></div>
<div class="ttc" id="agroup__graphics__drawables_html_gadeb9cdf9d7e8eec2eb8cc638c54b5066"><div class="ttname"><a href="group__graphics__drawables.html#gadeb9cdf9d7e8eec2eb8cc638c54b5066">gf::Anchor</a></div><div class="ttdeci">Anchor</div><div class="ttdoc">An anchor of a box.</div><div class="ttdef"><b>Definition:</b> Anchor.h:38</div></div>
<div class="ttc" id="anamespacegf_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="astructgf_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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3
</small></address>
</body>
</html>