-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_action_8h_source.html
79 lines (79 loc) · 22.8 KB
/
_action_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
<!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): Action.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">Action.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_ACTION_H</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define GF_ACTION_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 <memory></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "Control.h"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#include "Gamepad.h"</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "Keyboard.h"</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "Mouse.h"</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "Portability.h"</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "Ref.h"</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="namespacegf.html"> 35</a></span> <span class="keyword">namespace </span><a class="code" href="namespacegf.html">gf</a> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">inline</span> <span class="keyword">namespace </span>v1 {</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">struct </span><a class="code" href="structgf_1_1_event.html">Event</a>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classgf_1_1_action.html"> 53</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_action.html">Action</a> {</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">explicit</span> <a class="code" href="classgf_1_1_action.html">Action</a>(std::string name);</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="classgf_1_1_action.html">Action</a>(<span class="keyword">const</span> <a class="code" href="classgf_1_1_action.html">Action</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classgf_1_1_action.html">Action</a>& operator=(<span class="keyword">const</span> <a class="code" href="classgf_1_1_action.html">Action</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classgf_1_1_action.html#af46c6661d743c88535bb9b256426a7cd"> 77</a></span>  <span class="keyword">const</span> std::string& <a class="code" href="classgf_1_1_action.html#af46c6661d743c88535bb9b256426a7cd">getName</a>()<span class="keyword"> const </span>{</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keywordflow">return</span> m_name;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> setContinuous();</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">bool</span> isContinuous() <span class="keyword">const</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keywordtype">void</span> setInstantaneous();</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordtype">bool</span> isInstantaneous() <span class="keyword">const</span>;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">void</span> addKeycodeKeyControl(<a class="code" href="group__window.html#gac7037fec22d5d5215cffce98fc7dca64">Keycode</a> code);</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordtype">void</span> addScancodeKeyControl(<a class="code" href="group__window.html#ga795d7d5e2f2a4f38b16b95e0e78cb626">Scancode</a> code);</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">void</span> addMouseButtonControl(<a class="code" href="group__window.html#ga5af782cd2d72913508f6b31f01acc03e">MouseButton</a> button);</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  <span class="keywordtype">void</span> addGamepadButtonControl(<a class="code" href="group__window.html#ga11c9d24ca72015b03cec48ec595bafb3">GamepadId</a> <span class="keywordtype">id</span>, <a class="code" href="group__window.html#ga66e2d144e71b76a0499edc3d0a68529f">GamepadButton</a> button);</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> </div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  <span class="keywordtype">void</span> addGamepadAxisControl(<a class="code" href="group__window.html#ga11c9d24ca72015b03cec48ec595bafb3">GamepadId</a> <span class="keywordtype">id</span>, <a class="code" href="group__window.html#ga40276d90e4e5efa68433fd9040c08b86">GamepadAxis</a> axis, <a class="code" href="group__window.html#gac51b68f03b85350446f51a932fc20de3">GamepadAxisDirection</a> dir);</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keywordtype">void</span> addCloseControl();</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> </div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">void</span> addControl(<a class="code" href="classgf_1_1_control.html">Control</a>& control);</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordtype">void</span> processEvent(<span class="keyword">const</span> <a class="code" href="structgf_1_1_event.html">Event</a>& event);</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keywordtype">bool</span> isActive() <span class="keyword">const</span>;</div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> </div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">void</span> reset();</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  <span class="keyword">enum class</span> Type {</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  Instantaneous,</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  Continuous,</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="l00229"></a><span class="lineno"> 229</span>  std::string m_name;</div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  Type m_type;</div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span>  std::vector<std::unique_ptr<Control>> m_ownedControls;</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  std::vector<Ref<Control>> m_controls;</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  };</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span> </div><div class="line"><a name="l00240"></a><span class="lineno"><a class="line" href="classgf_1_1_action_container.html"> 240</a></span>  <span class="keyword">class </span>GF_API <a class="code" href="classgf_1_1_action_container.html">ActionContainer</a> {</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  <span class="keywordtype">void</span> addAction(<a class="code" href="classgf_1_1_action.html">Action</a>& action);</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span> </div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  <span class="keywordtype">bool</span> hasAction(<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>;</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <a class="code" href="classgf_1_1_action.html">Action</a>& getAction(<span class="keyword">const</span> std::string& name);</div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span> </div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span>  <span class="keyword">const</span> <a class="code" href="classgf_1_1_action.html">Action</a>& getAction(<span class="keyword">const</span> std::string& name) <span class="keyword">const</span>;</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  <span class="keywordtype">void</span> processEvent(<span class="keyword">const</span> <a class="code" href="structgf_1_1_event.html">Event</a>& event);</div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> </div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span>  <span class="keywordtype">void</span> reset();</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span> </div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  std::vector<Ref<Action>> m_actions;</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  };</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span> </div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span> <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span></div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> }</div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span> }</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> <span class="preprocessor">#endif // GF_ACTION_H</span></div><div class="ttc" id="group__window_html_gac51b68f03b85350446f51a932fc20de3"><div class="ttname"><a href="group__window.html#gac51b68f03b85350446f51a932fc20de3">gf::GamepadAxisDirection</a></div><div class="ttdeci">GamepadAxisDirection</div><div class="ttdoc">A gamepad axis direction. </div><div class="ttdef"><b>Definition:</b> Gamepad.h:89</div></div>
<div class="ttc" id="group__window_html_ga66e2d144e71b76a0499edc3d0a68529f"><div class="ttname"><a href="group__window.html#ga66e2d144e71b76a0499edc3d0a68529f">gf::GamepadButton</a></div><div class="ttdeci">GamepadButton</div><div class="ttdoc">The gamepad buttons. </div><div class="ttdef"><b>Definition:</b> Gamepad.h:43</div></div>
<div class="ttc" id="classgf_1_1_action_container_html"><div class="ttname"><a href="classgf_1_1_action_container.html">gf::ActionContainer</a></div><div class="ttdoc">A set of actions. </div><div class="ttdef"><b>Definition:</b> Action.h:240</div></div>
<div class="ttc" id="group__window_html_ga795d7d5e2f2a4f38b16b95e0e78cb626"><div class="ttname"><a href="group__window.html#ga795d7d5e2f2a4f38b16b95e0e78cb626">gf::Scancode</a></div><div class="ttdeci">Scancode</div><div class="ttdoc">Scancodes. </div><div class="ttdef"><b>Definition:</b> Keyboard.h:59</div></div>
<div class="ttc" id="classgf_1_1_control_html"><div class="ttname"><a href="classgf_1_1_control.html">gf::Control</a></div><div class="ttdoc">A physical control. </div><div class="ttdef"><b>Definition:</b> Control.h:38</div></div>
<div class="ttc" id="classgf_1_1_action_html_af46c6661d743c88535bb9b256426a7cd"><div class="ttname"><a href="classgf_1_1_action.html#af46c6661d743c88535bb9b256426a7cd">gf::Action::getName</a></div><div class="ttdeci">const std::string & getName() const</div><div class="ttdoc">Get the name of the action. </div><div class="ttdef"><b>Definition:</b> Action.h:77</div></div>
<div class="ttc" id="group__window_html_ga40276d90e4e5efa68433fd9040c08b86"><div class="ttname"><a href="group__window.html#ga40276d90e4e5efa68433fd9040c08b86">gf::GamepadAxis</a></div><div class="ttdeci">GamepadAxis</div><div class="ttdoc">The gamepad axis. </div><div class="ttdef"><b>Definition:</b> Gamepad.h:71</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__window_html_ga11c9d24ca72015b03cec48ec595bafb3"><div class="ttname"><a href="group__window.html#ga11c9d24ca72015b03cec48ec595bafb3">gf::GamepadId</a></div><div class="ttdeci">GamepadId</div><div class="ttdoc">A gamepad identifier. </div><div class="ttdef"><b>Definition:</b> Gamepad.h:121</div></div>
<div class="ttc" id="classgf_1_1_action_html"><div class="ttname"><a href="classgf_1_1_action.html">gf::Action</a></div><div class="ttdoc">An action that can be triggered by different controls. </div><div class="ttdef"><b>Definition:</b> Action.h:53</div></div>
<div class="ttc" id="group__window_html_ga5af782cd2d72913508f6b31f01acc03e"><div class="ttname"><a href="group__window.html#ga5af782cd2d72913508f6b31f01acc03e">gf::MouseButton</a></div><div class="ttdeci">MouseButton</div><div class="ttdoc">Mouse buttons. </div><div class="ttdef"><b>Definition:</b> Mouse.h:36</div></div>
<div class="ttc" id="structgf_1_1_event_html"><div class="ttname"><a href="structgf_1_1_event.html">gf::Event</a></div><div class="ttdoc">Defines a system event and its parameters. </div><div class="ttdef"><b>Definition:</b> Event.h:97</div></div>
<div class="ttc" id="group__window_html_gac7037fec22d5d5215cffce98fc7dca64"><div class="ttname"><a href="group__window.html#gac7037fec22d5d5215cffce98fc7dca64">gf::Keycode</a></div><div class="ttdeci">Keycode</div><div class="ttdoc">Keycodes. </div><div class="ttdef"><b>Definition:</b> Keyboard.h:288</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>