diff options
Diffstat (limited to 'Doc/doxygen/html/_keyboard_8h_source.html')
| -rw-r--r-- | Doc/doxygen/html/_keyboard_8h_source.html | 191 |
1 files changed, 191 insertions, 0 deletions
diff --git a/Doc/doxygen/html/_keyboard_8h_source.html b/Doc/doxygen/html/_keyboard_8h_source.html new file mode 100644 index 0000000..ad542ef --- /dev/null +++ b/Doc/doxygen/html/_keyboard_8h_source.html @@ -0,0 +1,191 @@ +<!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"/> +<title>Starshatter_Open: D:/SRC/StarshatterSVN/nGenEx/Keyboard.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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.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 style="padding-left: 0.5em;"> + <div id="projectname">Starshatter_Open + </div> + <div id="projectbrief">Open source Starshatter engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.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 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 List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('_keyboard_8h.html','');}); +</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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</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> + +<div class="header"> + <div class="headertitle"> +<div class="title">Keyboard.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_keyboard_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Project nGenEx</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Destroyer Studios LLC</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright © 1997-2004. All Rights Reserved.</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"> SUBSYSTEM: nGenEx.lib</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> FILE: Keyboard.h</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> AUTHOR: John DiCamillo</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"></span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> OVERVIEW</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ========</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> Keyboard Input class</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef Keyboard_h</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#define Keyboard_h</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="_motion_controller_8h.html">MotionController.h</a>"</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</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> </div> +<div class="line"><a name="l00022"></a><span class="lineno"><a class="code" href="class_keyboard.html"> 22</a></span> <span class="keyword">class </span><a class="code" href="class_keyboard.html">Keyboard</a> : <span class="keyword">public</span> <a class="code" href="class_motion_controller.html">MotionController</a></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="keyword">public</span>:</div> +<div class="line"><a name="l00025"></a><span class="lineno"><a class="code" href="class_keyboard.html#ac645aaca513eb193c5d1002056f8e293"> 25</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_keyboard.html#ac645aaca513eb193c5d1002056f8e293">TYPENAME</a>() { <span class="keywordflow">return</span> <span class="stringliteral">"Keyboard"</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>  <a class="code" href="class_keyboard.html#ad6b0bb849d6bb7cdf63091e40b5f5f7f">Keyboard</a>();</div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">virtual</span> <a class="code" href="class_keyboard.html#af6a99ec66c8c722a45b967bf79167038">~Keyboard</a>();</div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="comment">// setup</span></div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_keyboard.html#afe6abe197390b6dfdf33f0f45403ad28">MapKeys</a>(<a class="code" href="struct_key_map_entry.html">KeyMapEntry</a>* mapping, <span class="keywordtype">int</span> nkeys);</div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> +<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// sample the physical device</span></div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_keyboard.html#a9b62e373809685efbd20b01af7851d50">Acquire</a>();</div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// translations</span></div> +<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="class_keyboard.html#ae0234dd8601eeffdb3ed87ffe8a23322"> 37</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#ae0234dd8601eeffdb3ed87ffe8a23322">X</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#a618c47ca1d346ba619131bf20673b26f">x</a>; }</div> +<div class="line"><a name="l00038"></a><span class="lineno"><a class="code" href="class_keyboard.html#aeced4dde58ce90a6a5359c1414b67c7b"> 38</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#aeced4dde58ce90a6a5359c1414b67c7b">Y</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#afe57d2cfc285614208b12c7941d70cac">y</a>; }</div> +<div class="line"><a name="l00039"></a><span class="lineno"><a class="code" href="class_keyboard.html#a865ed54e8e75ff04c5b3c97037ce1d77"> 39</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#a865ed54e8e75ff04c5b3c97037ce1d77">Z</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#a9fb55af9a6b60932a216caed4c4f1643">z</a>; }</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// rotations</span></div> +<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="class_keyboard.html#acada53f83d195541d95d15489b96f4b5"> 42</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#acada53f83d195541d95d15489b96f4b5">Pitch</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#ac4bdc69dc7914bbd0497a72a7526182d">p</a>; }</div> +<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="class_keyboard.html#af7060c3f66267d168889efd9c4487e7a"> 43</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#af7060c3f66267d168889efd9c4487e7a">Roll</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#a7369c04c09af3dc5849e2cef280cf9f4">r</a>; }</div> +<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="class_keyboard.html#a57eb494a8f56aeb4a3f6670175a3a01a"> 44</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#a57eb494a8f56aeb4a3f6670175a3a01a">Yaw</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#a322791f32ada386e64f6878588f040a8">w</a>; }</div> +<div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="class_keyboard.html#a7847b6c2d0e9bef5b1a7c9183b50a1ae"> 45</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard.html#a7847b6c2d0e9bef5b1a7c9183b50a1ae">Center</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#ab1a30b83333ac908d984e23f13c1e783">c</a>; }</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="comment">// throttle</span></div> +<div class="line"><a name="l00048"></a><span class="lineno"><a class="code" href="class_keyboard.html#a2b0e24ec9f29ee1ea197755c3ce9be27"> 48</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#a2b0e24ec9f29ee1ea197755c3ce9be27">Throttle</a>() { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#a619a23e4cda074503db1fb0b4eda0b8f">t</a>; }</div> +<div class="line"><a name="l00049"></a><span class="lineno"><a class="code" href="class_keyboard.html#a56f79379447bb8f21f3ae140892f0835"> 49</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_keyboard.html#a56f79379447bb8f21f3ae140892f0835">SetThrottle</a>(<span class="keywordtype">double</span> <a class="code" href="class_motion_controller.html#a6bb083eb54549055d2fd3b9b3645c185">throttle</a>) { <a class="code" href="class_keyboard.html#a619a23e4cda074503db1fb0b4eda0b8f">t</a> = <a class="code" href="class_motion_controller.html#a6bb083eb54549055d2fd3b9b3645c185">throttle</a>; }</div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// actions</span></div> +<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="class_keyboard.html#a22851cc57ea47bc3b8b64d92abf0e7e0"> 52</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard.html#a22851cc57ea47bc3b8b64d92abf0e7e0">Action</a>(<span class="keywordtype">int</span> n) { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#a5313e67278c2784cae2077f6fd04bace">action</a>[n]; }</div> +<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="class_keyboard.html#a34614353a55b90aa51946c51c97afe92"> 53</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard.html#a34614353a55b90aa51946c51c97afe92">ActionMap</a>(<span class="keywordtype">int</span> n) { <span class="keywordflow">return</span> <a class="code" href="class_keyboard.html#ac5cc9ac02ef2d7738a8eee77d570288c">KeyDownMap</a>(n); }</div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_keyboard.html#add5b560d7714705a93a118ecffd7fb01">KeyDown</a>(<span class="keywordtype">int</span> key);</div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_keyboard.html#ac5cc9ac02ef2d7738a8eee77d570288c">KeyDownMap</a>(<span class="keywordtype">int</span> key);</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_keyboard.html#aec27f1dada27b07cfa822ccab0cb65df">FlushKeys</a>();</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">static</span> <a class="code" href="class_keyboard.html">Keyboard</a>* <a class="code" href="class_keyboard.html#a16ec3608289caa6eaeebfa1a69599a65">GetInstance</a>();</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="class_keyboard.html#a9fb55af9a6b60932a216caed4c4f1643"> 62</a></span>  <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#a618c47ca1d346ba619131bf20673b26f">x</a>,<a class="code" href="class_keyboard.html#afe57d2cfc285614208b12c7941d70cac">y</a>,<a class="code" href="class_keyboard.html#a9fb55af9a6b60932a216caed4c4f1643">z</a>,<a class="code" href="class_keyboard.html#ac4bdc69dc7914bbd0497a72a7526182d">p</a>,<a class="code" href="class_keyboard.html#a7369c04c09af3dc5849e2cef280cf9f4">r</a>,<a class="code" href="class_keyboard.html#a322791f32ada386e64f6878588f040a8">w</a>,<a class="code" href="class_keyboard.html#a619a23e4cda074503db1fb0b4eda0b8f">t</a>;</div> +<div class="line"><a name="l00063"></a><span class="lineno"><a class="code" href="class_keyboard.html#a03f4829bb563853923d445d7d83f9247"> 63</a></span>  <span class="keywordtype">double</span> <a class="code" href="class_keyboard.html#a5b3dc16eb80109dc18e835744460ceaa">p1</a>, <a class="code" href="class_keyboard.html#adfa54b35c1e0c13ae121ef15230824ef">r1</a>, <a class="code" href="class_keyboard.html#a03f4829bb563853923d445d7d83f9247">w1</a>;</div> +<div class="line"><a name="l00064"></a><span class="lineno"><a class="code" href="class_keyboard.html#ab1a30b83333ac908d984e23f13c1e783"> 64</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_keyboard.html#ab1a30b83333ac908d984e23f13c1e783">c</a>;</div> +<div class="line"><a name="l00065"></a><span class="lineno"><a class="code" href="class_keyboard.html#a5313e67278c2784cae2077f6fd04bace"> 65</a></span>  <span class="keywordtype">int</span> <a class="code" href="class_keyboard.html#a5313e67278c2784cae2077f6fd04bace">action</a>[<a class="code" href="class_motion_controller.html#af9f6e12962c832c1873388eb85a54215a35914ef6a74f6cfecf4acc800e2af347">MotionController::MaxActions</a>];</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> +<div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="class_keyboard.html#a717c9a9b92011b106254ab961e34caef"> 67</a></span>  <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard.html#a717c9a9b92011b106254ab961e34caef">map</a>[<a class="code" href="_motion_controller_8h.html#a29b377edf77dba3631f8bbc58cc3157f">KEY_MAP_SIZE</a>];</div> +<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="class_keyboard.html#ab8c00cc75ab1562dd0a6ab25bec0934f"> 68</a></span>  <span class="keyword">static</span> <span class="keywordtype">int</span> <a class="code" href="class_keyboard.html#ab8c00cc75ab1562dd0a6ab25bec0934f">alt</a>[<a class="code" href="_motion_controller_8h.html#a29b377edf77dba3631f8bbc58cc3157f">KEY_MAP_SIZE</a>];</div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif Keyboard_h</span></div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor"></span></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_d6625d0f3efd9eb70ff961583505095b.html">nGenEx</a></li><li class="navelem"><a class="el" href="_keyboard_8h.html">Keyboard.h</a></li> + <li class="footer">Generated on Tue Jun 5 2012 20:46:23 for Starshatter_Open by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> + </ul> +</div> +</body> +</html> |