-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_orientation_8h_source.html
86 lines (86 loc) · 19.6 KB
/
_orientation_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
<!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): Orientation.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">Orientation.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_ORIENTATION_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_ORIENTATION_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 "Portability.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "Vector.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13"> 42</a></span>  <span class="keyword">enum class</span> <a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> : int {</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="group__graphics.html#gga5229ccbffec1016d760ddfe296fd2edfa4f1f6016fc9f3f2353c0cc7c67b292bd">Center</a> = -1, </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a601560b94fbb188919dd1d36c8ab70a4">North</a> = 0, </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a7254edb19370d28e3466c971d2f8a03e">NorthEast</a> = 1, </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13aa99dc62d017d04cf67266593f9c3761e">East</a> = 2, </div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a865a51dff69223f0cf5ad630e5ada190">SouthEast</a> = 3, </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a263d7b2cf53802c9ed127b718c0bf9fd">South</a> = 4, </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13ae8eaf797b01fdb4246ed54904368b592">SouthWest</a> = 5, </div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13abf495fc048d8d44b7f32536df5cf3930">West</a> = 6, </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a142cbe82227bdec147eff3a629dd366b">NorthWest</a> = 7, </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  };</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> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  GF_API <a class="code" href="structgf_1_1_vector.html">Vector2f</a> <a class="code" href="group__core.html#ga06acc8afaf45bf8111735f1e5124e265">unit</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  GF_API <a class="code" href="structgf_1_1_vector.html">Vector2i</a> <a class="code" href="group__core.html#ga762fb8ffb213b0ca19f6997153821827">displacement</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  GF_API <span class="keywordtype">float</span> <a class="code" href="group__core.html#ga96c554e4534b63fd34ac457d563e7c32">angle</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  GF_API <a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> <a class="code" href="group__core.html#ga9214206036fe1ff2e32f8eb5dd6ddd8c">opposite</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  GF_API <a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> <a class="code" href="group__core.html#gaba311399ff14745ba9bd4727d20558ce">orthogonalCW</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  GF_API <a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> <a class="code" href="group__core.html#gace83a6f16cc97de2213348a25da047ab">orthogonalCCW</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  GF_API <a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> <a class="code" href="group__core.html#gaf772c7af2f2feee7aa295ce0bbbf0d44">nextCW</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  GF_API <a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> <a class="code" href="group__core.html#gada85a63380e5957266d3e6c9ea4bb470">nextCCW</a>(<a class="code" href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">Orientation</a> orientation);</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> }</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="preprocessor">#endif</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="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="preprocessor">#endif // GF_ORIENTATION_H</span></div><div class="ttc" id="group__core_html_gace83a6f16cc97de2213348a25da047ab"><div class="ttname"><a href="group__core.html#gace83a6f16cc97de2213348a25da047ab">gf::orthogonalCCW</a></div><div class="ttdeci">Direction orthogonalCCW(Direction direction)</div><div class="ttdoc">Get the orthogonal direction counter-clockwise. </div></div>
<div class="ttc" id="group__core_html_ga762fb8ffb213b0ca19f6997153821827"><div class="ttname"><a href="group__core.html#ga762fb8ffb213b0ca19f6997153821827">gf::displacement</a></div><div class="ttdeci">Vector2i displacement(Direction direction)</div><div class="ttdoc">Get a vector from a direction. </div></div>
<div class="ttc" id="group__core_html_gaba311399ff14745ba9bd4727d20558ce"><div class="ttname"><a href="group__core.html#gaba311399ff14745ba9bd4727d20558ce">gf::orthogonalCW</a></div><div class="ttdeci">Direction orthogonalCW(Direction direction)</div><div class="ttdoc">Get the orthogonal direction clockwise. </div></div>
<div class="ttc" id="group__core_html_gada85a63380e5957266d3e6c9ea4bb470"><div class="ttname"><a href="group__core.html#gada85a63380e5957266d3e6c9ea4bb470">gf::nextCCW</a></div><div class="ttdeci">Direction nextCCW(Direction direction)</div><div class="ttdoc">Get the next direction counter-clockwise. </div></div>
<div class="ttc" id="group__core_html_ga9214206036fe1ff2e32f8eb5dd6ddd8c"><div class="ttname"><a href="group__core.html#ga9214206036fe1ff2e32f8eb5dd6ddd8c">gf::opposite</a></div><div class="ttdeci">Direction opposite(Direction direction)</div><div class="ttdoc">Get the opposite direction. </div></div>
<div class="ttc" id="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13a263d7b2cf53802c9ed127b718c0bf9fd"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a263d7b2cf53802c9ed127b718c0bf9fd">gf::Orientation::South</a></div><div class="ttdoc">The south orientation. </div></div>
<div class="ttc" id="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13ae8eaf797b01fdb4246ed54904368b592"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13ae8eaf797b01fdb4246ed54904368b592">gf::Orientation::SouthWest</a></div><div class="ttdoc">The south-west orientation. </div></div>
<div class="ttc" id="group__core_html_gaf772c7af2f2feee7aa295ce0bbbf0d44"><div class="ttname"><a href="group__core.html#gaf772c7af2f2feee7aa295ce0bbbf0d44">gf::nextCW</a></div><div class="ttdeci">Direction nextCW(Direction direction)</div><div class="ttdoc">Get the next direction clockwise. </div></div>
<div class="ttc" id="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13a7254edb19370d28e3466c971d2f8a03e"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a7254edb19370d28e3466c971d2f8a03e">gf::Orientation::NorthEast</a></div><div class="ttdoc">The north-east orientation. </div></div>
<div class="ttc" id="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13a865a51dff69223f0cf5ad630e5ada190"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a865a51dff69223f0cf5ad630e5ada190">gf::Orientation::SouthEast</a></div><div class="ttdoc">The south-east orientation. </div></div>
<div class="ttc" id="group__core_html_ga06acc8afaf45bf8111735f1e5124e265"><div class="ttname"><a href="group__core.html#ga06acc8afaf45bf8111735f1e5124e265">gf::unit</a></div><div class="ttdeci">Vector2f unit(Direction direction)</div><div class="ttdoc">Get a unit vector from a direction. </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="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13aa99dc62d017d04cf67266593f9c3761e"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13aa99dc62d017d04cf67266593f9c3761e">gf::Orientation::East</a></div><div class="ttdoc">The east orientation. </div></div>
<div class="ttc" id="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13abf495fc048d8d44b7f32536df5cf3930"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13abf495fc048d8d44b7f32536df5cf3930">gf::Orientation::West</a></div><div class="ttdoc">The west orientation. </div></div>
<div class="ttc" id="group__core_html_ga96c554e4534b63fd34ac457d563e7c32"><div class="ttname"><a href="group__core.html#ga96c554e4534b63fd34ac457d563e7c32">gf::angle</a></div><div class="ttdeci">float angle(Direction direction)</div><div class="ttdoc">Get an angle from a direction. </div></div>
<div class="ttc" id="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13a601560b94fbb188919dd1d36c8ab70a4"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a601560b94fbb188919dd1d36c8ab70a4">gf::Orientation::North</a></div><div class="ttdoc">The north orientation. </div></div>
<div class="ttc" id="group__core_html_gaa82adefc3ea3cca7e98d7cb4c85e9b13"><div class="ttname"><a href="group__core.html#gaa82adefc3ea3cca7e98d7cb4c85e9b13">gf::Orientation</a></div><div class="ttdeci">Orientation</div><div class="ttdoc">Cardinal and ordinal orientation. </div><div class="ttdef"><b>Definition:</b> Orientation.h:42</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 class="ttc" id="group__graphics_html_gga5229ccbffec1016d760ddfe296fd2edfa4f1f6016fc9f3f2353c0cc7c67b292bd"><div class="ttname"><a href="group__graphics.html#gga5229ccbffec1016d760ddfe296fd2edfa4f1f6016fc9f3f2353c0cc7c67b292bd">gf::Alignment::Center</a></div><div class="ttdoc">Centered alignment. </div></div>
<div class="ttc" id="group__core_html_ggaa82adefc3ea3cca7e98d7cb4c85e9b13a142cbe82227bdec147eff3a629dd366b"><div class="ttname"><a href="group__core.html#ggaa82adefc3ea3cca7e98d7cb4c85e9b13a142cbe82227bdec147eff3a629dd366b">gf::Orientation::NorthWest</a></div><div class="ttdoc">The north-west orientation. </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>