summaryrefslogtreecommitdiff
path: root/docs/html/_keyboard_handler_8h_source.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/html/_keyboard_handler_8h_source.html')
-rw-r--r--docs/html/_keyboard_handler_8h_source.html148
1 files changed, 148 insertions, 0 deletions
diff --git a/docs/html/_keyboard_handler_8h_source.html b/docs/html/_keyboard_handler_8h_source.html
new file mode 100644
index 0000000..1764633
--- /dev/null
+++ b/docs/html/_keyboard_handler_8h_source.html
@@ -0,0 +1,148 @@
+<!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"/>
+<title>Rally X: source/presentation/KeyboardHandler.h Source File</title>
+
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+
+</head>
+<body>
+<div id="top"><!-- do not remove this div! -->
+
+
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+
+ <td id="projectlogo"><img alt="Logo" src="car.PNG"/></td>
+
+
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">Rally X
+
+ </div>
+ <div id="projectbrief">ELEN3009 Project by Justin Wernick and David Schneider</div>
+ </td>
+
+
+
+ </tr>
+ </tbody>
+</table>
+</div>
+
+<!-- Generated by Doxygen 1.7.5.1 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+ <li><a href="annotated.html"><span>Classes</span></a></li>
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+ <div id="navrow2" class="tabs2">
+ <ul class="tablist">
+ <li><a href="files.html"><span>File&#160;List</span></a></li>
+ <li><a href="globals.html"><span>File&#160;Members</span></a></li>
+ </ul>
+ </div>
+<div class="header">
+ <div class="headertitle">
+<div class="title">source/presentation/KeyboardHandler.h</div> </div>
+</div>
+<div class="contents">
+<a href="_keyboard_handler_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef KEYBOARDHANDLER_H</span>
+<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define KEYBOARDHANDLER_H</span>
+<a name="l00003"></a>00003 <span class="preprocessor"></span>
+<a name="l00004"></a>00004 <span class="preprocessor">#include &lt;allegro5/allegro.h&gt;</span>
+<a name="l00005"></a>00005
+<a name="l00006"></a>00006 <span class="preprocessor">#include &quot;../logic/Maze.h&quot;</span>
+<a name="l00007"></a>00007 <span class="preprocessor">#include &quot;../logic/AllegroWrappers.h&quot;</span>
+<a name="l00008"></a>00008
+<a name="l00019"></a><a class="code" href="class_keyboard_handler.html">00019</a> <span class="keyword">class </span><a class="code" href="class_keyboard_handler.html" title="Class for handling keyboard related game inputs from the player.">KeyboardHandler</a>
+<a name="l00020"></a>00020 {
+<a name="l00021"></a>00021 <span class="keyword">public</span>:
+<a name="l00027"></a>00027 <a class="code" href="class_keyboard_handler.html#acd0d5781016f792207464bb720d2f994" title="Creates a KeyboardHandler with a given initial state.">KeyboardHandler</a>(<a class="code" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f" title="Defines the directions in which movement can happen in the maze.">Maze::Direction</a> currentFacing);
+<a name="l00031"></a>00031 <a class="code" href="class_keyboard_handler.html#acd0d5781016f792207464bb720d2f994" title="Creates a KeyboardHandler with a given initial state.">KeyboardHandler</a>(<span class="keyword">const</span> <a class="code" href="class_keyboard_handler.html" title="Class for handling keyboard related game inputs from the player.">KeyboardHandler</a>&amp; ref);
+<a name="l00035"></a>00035 <a class="code" href="class_keyboard_handler.html" title="Class for handling keyboard related game inputs from the player.">KeyboardHandler</a>&amp; <a class="code" href="class_keyboard_handler.html#a5135c450b82394496457a0a51d5240f5" title="Assignment operator that ensures that an assigned KeyboardHandler will have its own event queue...">operator=</a>(<span class="keyword">const</span> <a class="code" href="class_keyboard_handler.html" title="Class for handling keyboard related game inputs from the player.">KeyboardHandler</a>&amp; rhs);
+<a name="l00039"></a>00039 <a class="code" href="class_keyboard_handler.html#ab090fe5afdee856604b0aa0d9eb918a4" title="Cleans up the keyboard event queue.">~KeyboardHandler</a>();
+<a name="l00040"></a>00040
+<a name="l00051"></a>00051 <a class="code" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f" title="Defines the directions in which movement can happen in the maze.">Maze::Direction</a> <a class="code" href="class_keyboard_handler.html#ae17ed4bf0abae7d95f9b772a6d704a70" title="Gives the last direction that the player entered on the keyboard.">getFacing</a>();
+<a name="l00052"></a>00052
+<a name="l00058"></a>00058 <span class="keywordtype">bool</span> <a class="code" href="class_keyboard_handler.html#ab66797a37a1c54a630187519870d9a5b" title="Gives whether or not the key for creating a Smokescreen is currently pressed.">getSmokescreen</a>();
+<a name="l00059"></a>00059
+<a name="l00060"></a>00060 <span class="keyword">private</span>:
+<a name="l00061"></a><a class="code" href="class_keyboard_handler.html#a0ec33ec0de48e563e9137294fb7577da">00061</a> <a class="code" href="class_allegro_keyboard_init.html" title="Class ensures that Allegro&#39;s keyboard is installed and uninstalled when appropriate.">AllegroKeyboardInit</a> <a class="code" href="class_keyboard_handler.html#a0ec33ec0de48e563e9137294fb7577da" title="Ensures that dependencies on the Allegro keyboard library are installed.">_keyboard</a>;
+<a name="l00062"></a>00062
+<a name="l00066"></a>00066 <span class="keywordtype">void</span> <a class="code" href="class_keyboard_handler.html#a9f53a546420f3d02363c9e1e4e346420" title="Processes all pending keyboard inputs, and updates flags as appropriate.">updateFlags</a>();
+<a name="l00067"></a>00067
+<a name="l00068"></a><a class="code" href="class_keyboard_handler.html#ad323844aad47f1bc263ec2fd4a19ac3a">00068</a> <span class="keywordtype">bool</span> <a class="code" href="class_keyboard_handler.html#ad323844aad47f1bc263ec2fd4a19ac3a" title="True if the up arrow key is depressed.">_up</a>;
+<a name="l00069"></a><a class="code" href="class_keyboard_handler.html#aa6d1c75e1a98d4aae96d8ac1c8aaa539">00069</a> <span class="keywordtype">bool</span> <a class="code" href="class_keyboard_handler.html#aa6d1c75e1a98d4aae96d8ac1c8aaa539" title="True if the down arrow key is depressed.">_down</a>;
+<a name="l00070"></a><a class="code" href="class_keyboard_handler.html#a3bc780470d7cbaf9f4ea239e0613ce3c">00070</a> <span class="keywordtype">bool</span> <a class="code" href="class_keyboard_handler.html#a3bc780470d7cbaf9f4ea239e0613ce3c" title="True if the left arrow key is depressed.">_left</a>;
+<a name="l00071"></a><a class="code" href="class_keyboard_handler.html#a81d37831d958ff21c2ce08cfa97ca420">00071</a> <span class="keywordtype">bool</span> <a class="code" href="class_keyboard_handler.html#a81d37831d958ff21c2ce08cfa97ca420" title="True if the right arrow key is depressed.">_right</a>;
+<a name="l00072"></a><a class="code" href="class_keyboard_handler.html#a7769dc815c493fb5962d52c3d5bc7b16">00072</a> <span class="keywordtype">bool</span> <a class="code" href="class_keyboard_handler.html#a7769dc815c493fb5962d52c3d5bc7b16" title="True if the smokescreen key is depressed.">_smokescreen</a>;
+<a name="l00073"></a><a class="code" href="class_keyboard_handler.html#a90120a85c62481b3a2c0330511cffbac">00073</a> <a class="code" href="class_maze.html#ad12c28d50f4d7457160a70a94acfe28f" title="Defines the directions in which movement can happen in the maze.">Maze::Direction</a> <a class="code" href="class_keyboard_handler.html#a90120a85c62481b3a2c0330511cffbac" title="The direction that was returned on the last call of getFacing.">_previousFacing</a>;
+<a name="l00074"></a><a class="code" href="class_keyboard_handler.html#a44116ed8745f3a3360e1d7c29ea86d56">00074</a> ALLEGRO_EVENT_QUEUE* <a class="code" href="class_keyboard_handler.html#a44116ed8745f3a3360e1d7c29ea86d56" title="Queue for all keyboard events.">_keyboardEvents</a>;
+<a name="l00075"></a>00075
+<a name="l00076"></a><a class="code" href="class_keyboard_handler.html#a3ed342ff89f15b752a9957fd435e9094">00076</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard_handler.html#a3ed342ff89f15b752a9957fd435e9094" title="Key that must be pressed to turn up.">UP_KEY</a> = ALLEGRO_KEY_UP;
+<a name="l00077"></a><a class="code" href="class_keyboard_handler.html#a3d8d985fdc3c3ac543e84647967f78e4">00077</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard_handler.html#a3d8d985fdc3c3ac543e84647967f78e4" title="Key that must be pressed to turn down.">DOWN_KEY</a> = ALLEGRO_KEY_DOWN;
+<a name="l00078"></a><a class="code" href="class_keyboard_handler.html#ab285a229f4f5c7c1be5504fdb629e10a">00078</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard_handler.html#ab285a229f4f5c7c1be5504fdb629e10a" title="Key that must be pressed to turn left.">LEFT_KEY</a> = ALLEGRO_KEY_LEFT;
+<a name="l00079"></a><a class="code" href="class_keyboard_handler.html#a0822e8b6338b01cb09d08589d778af86">00079</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard_handler.html#a0822e8b6338b01cb09d08589d778af86" title="Key that must be pressed to turn right.">RIGHT_KEY</a> = ALLEGRO_KEY_RIGHT;
+<a name="l00080"></a><a class="code" href="class_keyboard_handler.html#a2de5780311975180c0b78e7b0457eae1">00080</a> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard_handler.html#a2de5780311975180c0b78e7b0457eae1" title="Key that must be pressed to create a smokescreen.">SMOKESCREEN_KEY</a> = ALLEGRO_KEY_SPACE;
+<a name="l00081"></a>00081 };
+<a name="l00082"></a>00082
+<a name="l00083"></a>00083 <span class="preprocessor">#endif // KEYBOARDHANDLER_H</span>
+</pre></div></div>
+</div>
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a></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>
+
+
+
+<hr class="footer"/><address class="footer"><small>
+Generated on Wed Oct 5 2011 20:08:31 for Rally X by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.7.5.1
+</small></address>
+
+</body>
+</html>