Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathan Laha committed Mar 28, 2022
1 parent 2b3beed commit 3f79625
Show file tree
Hide file tree
Showing 72 changed files with 2,937 additions and 225 deletions.
117 changes: 60 additions & 57 deletions docs/html/_character_controller_8h_source.html
View file

Large diffs are not rendered by default.

132 changes: 132 additions & 0 deletions docs/html/_input_manager_8h_source.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!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>Platform Data Engine: PlatformDataEngine/InputManager.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>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.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="projectalign">
<div id="projectname">Platform Data Engine<span id="projectnumber">&#160;0.0.1</span>
</div>
<div id="projectbrief">A data-driven game engine for platformers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.3 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('_input_manager_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle"><div class="title">InputManager.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="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span>PlatformDataEngine {</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"><a class="line" href="class_platform_data_engine_1_1_input_manager.html"> 6</a></span> <span class="keyword">class </span><a class="code hl_class" href="class_platform_data_engine_1_1_input_manager.html">InputManager</a></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="class_platform_data_engine_1_1_input_manager_1_1_axis.html"> 10</a></span> <span class="keyword">class </span><a class="code hl_class" href="class_platform_data_engine_1_1_input_manager_1_1_axis.html">Axis</a> {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">virtual</span> <span class="keywordtype">float</span> getValue() = 0;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isPositive() = 0;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isNegative() = 0;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> };</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="class_platform_data_engine_1_1_input_manager_1_1_button.html"> 19</a></span> <span class="keyword">class </span><a class="code hl_class" href="class_platform_data_engine_1_1_input_manager_1_1_button.html">Button</a> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getValue() = 0;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> };</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_platform_data_engine_1_1_input_manager_1_1_axis.html">Axis</a>&amp; getAxis(std::string axisName) = 0;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">virtual</span> <a class="code hl_class" href="class_platform_data_engine_1_1_input_manager_1_1_button.html">Button</a>&amp; getButton(std::string button) = 0;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> };</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>}</div>
<div class="ttc" id="aclass_platform_data_engine_1_1_input_manager_1_1_axis_html"><div class="ttname"><a href="class_platform_data_engine_1_1_input_manager_1_1_axis.html">PlatformDataEngine::InputManager::Axis</a></div><div class="ttdef"><b>Definition:</b> InputManager.h:10</div></div>
<div class="ttc" id="aclass_platform_data_engine_1_1_input_manager_1_1_button_html"><div class="ttname"><a href="class_platform_data_engine_1_1_input_manager_1_1_button.html">PlatformDataEngine::InputManager::Button</a></div><div class="ttdef"><b>Definition:</b> InputManager.h:19</div></div>
<div class="ttc" id="aclass_platform_data_engine_1_1_input_manager_html"><div class="ttname"><a href="class_platform_data_engine_1_1_input_manager.html">PlatformDataEngine::InputManager</a></div><div class="ttdef"><b>Definition:</b> InputManager.h:7</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_09a98f4fd83691b835e7062ce9b88446.html">PlatformDataEngine</a></li><li class="navelem"><b>InputManager.h</b></li>
<li class="footer">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 </li>
</ul>
</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/html/_platform_data_engine_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
<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> </div>
<div class="ttc" id="aclass_platform_data_engine_1_1_platform_data_engine_wrapper_html"><div class="ttname"><a href="class_platform_data_engine_1_1_platform_data_engine_wrapper.html">PlatformDataEngine::PlatformDataEngineWrapper</a></div><div class="ttdoc">Game Wrapper</div><div class="ttdef"><b>Definition:</b> PlatformDataEngine.h:16</div></div>
<div class="ttc" id="aclass_platform_data_engine_1_1_platform_data_engine_wrapper_html_ab477f5679a02576b2d90ef1814710bd9"><div class="ttname"><a href="class_platform_data_engine_1_1_platform_data_engine_wrapper.html#ab477f5679a02576b2d90ef1814710bd9">PlatformDataEngine::PlatformDataEngineWrapper::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">Runs the game (makes window and starts systems)</div><div class="ttdef"><b>Definition:</b> PlatformDataEngineWrapper.cpp:20</div></div>
<div class="ttc" id="aclass_platform_data_engine_1_1_platform_data_engine_wrapper_html_ab477f5679a02576b2d90ef1814710bd9"><div class="ttname"><a href="class_platform_data_engine_1_1_platform_data_engine_wrapper.html#ab477f5679a02576b2d90ef1814710bd9">PlatformDataEngine::PlatformDataEngineWrapper::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">Runs the game (makes window and starts systems)</div><div class="ttdef"><b>Definition:</b> PlatformDataEngineWrapper.cpp:21</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
53 changes: 29 additions & 24 deletions docs/html/_platform_data_engine_wrapper_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,32 +98,37 @@
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;Utility.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;GameWorld.h&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span>PlatformDataEngine {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">class </span>PlatformDataEngineWrapper</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> {</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> PlatformDataEngineWrapper();</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> ~PlatformDataEngineWrapper();</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="keyword">static</span> std::shared_ptr&lt;GameWorld&gt; mp_mainWorld;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_platform_data_engine_1_1_platform_data_engine_wrapper.html#ab477f5679a02576b2d90ef1814710bd9">run</a>();</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;PlayerInputManager.h&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span>PlatformDataEngine {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">class </span>PlatformDataEngineWrapper</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> PlatformDataEngineWrapper();</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> ~PlatformDataEngineWrapper();</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">static</span> std::shared_ptr&lt;GameWorld&gt; mp_mainWorld;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">static</span> std::shared_ptr&lt;PlayerInputManager&gt; mp_playerInputManager;</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">static</span> <span class="keyword">inline</span> <span class="keywordtype">float</span> m_fps{ 0.0 };</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">static</span> <span class="keyword">inline</span> sf::Vector2f m_windowZero{ 0.0, 0.0 };</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;GameWorld&gt; getWorld() {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">return</span> PlatformDataEngineWrapper::mp_mainWorld;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> }</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> };</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>}</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span> <a class="code hl_function" href="class_platform_data_engine_1_1_platform_data_engine_wrapper.html#ab477f5679a02576b2d90ef1814710bd9">run</a>();</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">float</span> m_fps{ 0.0 };</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">static</span> <span class="keyword">inline</span> sf::Vector2f m_windowZero{ 0.0, 0.0 };</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">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;PlayerInputManager&gt; getPlayerInputManager() {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">return</span> PlatformDataEngineWrapper::mp_playerInputManager;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">static</span> <span class="keyword">inline</span> std::shared_ptr&lt;GameWorld&gt; getWorld() {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">return</span> PlatformDataEngineWrapper::mp_mainWorld;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="ttc" id="aclass_platform_data_engine_1_1_platform_data_engine_wrapper_html_ab477f5679a02576b2d90ef1814710bd9"><div class="ttname"><a href="class_platform_data_engine_1_1_platform_data_engine_wrapper.html#ab477f5679a02576b2d90ef1814710bd9">PlatformDataEngine::PlatformDataEngineWrapper::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">Runs the game (makes window and starts systems)</div><div class="ttdef"><b>Definition:</b> PlatformDataEngineWrapper.cpp:20</div></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> };</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>}</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="ttc" id="aclass_platform_data_engine_1_1_platform_data_engine_wrapper_html_ab477f5679a02576b2d90ef1814710bd9"><div class="ttname"><a href="class_platform_data_engine_1_1_platform_data_engine_wrapper.html#ab477f5679a02576b2d90ef1814710bd9">PlatformDataEngine::PlatformDataEngineWrapper::run</a></div><div class="ttdeci">void run()</div><div class="ttdoc">Runs the game (makes window and starts systems)</div><div class="ttdef"><b>Definition:</b> PlatformDataEngineWrapper.cpp:21</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit 3f79625

Please sign in to comment.