diff options
Diffstat (limited to 'docs/doxygen/nel/game__device_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/game__device_8h-source.html | 174 |
1 files changed, 174 insertions, 0 deletions
diff --git a/docs/doxygen/nel/game__device_8h-source.html b/docs/doxygen/nel/game__device_8h-source.html new file mode 100644 index 00000000..e9edbe17 --- /dev/null +++ b/docs/doxygen/nel/game__device_8h-source.html @@ -0,0 +1,174 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>game_device.h</h1><a href="game__device_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2000-2002 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#ifndef NL_GAME_DEVICE_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_GAME_DEVICE_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00030 <font class="preprocessor">#include "<a class="code" href="input__device_8h.html">nel/misc/input_device.h</a>"</font> +00031 <font class="preprocessor">#include <string></font> +00032 <font class="preprocessor">#include <vector></font> +00033 +00034 +00035 <font class="keyword">namespace </font>NLMISC +00036 { +00037 +<a name="l00039"></a><a class="code" href="structNLMISC_1_1CGameDeviceDesc.html">00039</a> <font class="keyword">struct </font>CGameDeviceDesc +00040 { +00041 <font class="comment">// type of the device</font> +<a name="l00042"></a><a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#s4">00042</a> <font class="keyword">enum</font> <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#s4">TDevType</a> { <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#s4s0">GamePad</a>, <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#s4s1">Joystick</a>, <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#s4s2">DontKnow</a>, <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#s4s3">DevTypeLast</a> } <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#m0">DevType</a>; +00043 <font class="comment">// Friendly name for the instance. For example, "Joystick 1." </font> +<a name="l00044"></a><a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#m1">00044</a> std::string <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#m1">InstanceName</a>; +00045 <font class="comment">// Friendly name for the product</font> +<a name="l00046"></a><a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#m2">00046</a> std::string <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#m2">ProductName</a>; +00047 <font class="comment">// Tells wether this device is connected</font> +<a name="l00048"></a><a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#m3">00048</a> <font class="keywordtype">bool</font> <a class="code" href="structNLMISC_1_1CGameDeviceDesc.html#m3">Connected</a>; +00049 }; +00050 +00051 <font class="comment">// a list of game device description</font> +00052 <font class="keyword">typedef</font> std::vector<CGameDeviceDesc> <a class="code" href="namespaceNLMISC.html#a167">TDeviceDescVect</a>; +00053 +00055 <font class="keyword">inline</font> <font class="keywordtype">bool</font> <a class="code" href="namespaceNLMISC.html#a263">operator == </a>(<font class="keyword">const</font> CGameDeviceDesc &lhs, <font class="keyword">const</font> CGameDeviceDesc &rhs) +00056 { +00057 <font class="keywordflow">return</font> lhs.InstanceName == rhs.InstanceName && lhs.ProductName == rhs.ProductName; +00058 } +00059 <font class="comment">//</font> +00060 <font class="keyword">inline</font> <font class="keywordtype">bool</font> <a class="code" href="namespaceNLMISC.html#a264">operator != </a>(<font class="keyword">const</font> CGameDeviceDesc &lhs, <font class="keyword">const</font> CGameDeviceDesc &rhs) +00061 { +00062 <font class="keywordflow">return</font> !(lhs == rhs); +00063 } +00064 +00065 +<a name="l00072"></a><a class="code" href="structNLMISC_1_1IGameDevice.html">00072</a> <font class="keyword">struct </font>IGameDevice : <font class="keyword">public</font> IInputDevice +00073 { +<a name="l00074"></a><a class="code" href="structNLMISC_1_1IGameDevice.html#s7">00074</a> <font class="keyword">enum</font> <a class="code" href="structNLMISC_1_1IGameDevice.html#s7">TAxis</a> { <a class="code" href="structNLMISC_1_1IGameDevice.html#s7s0">XAxis</a> = 0, <a class="code" href="structNLMISC_1_1IGameDevice.html#s7s1">YAxis</a>, <a class="code" href="structNLMISC_1_1IGameDevice.html#s7s2">ZAxis</a>, <font class="comment">/* translation */</font> +00075 <a class="code" href="structNLMISC_1_1IGameDevice.html#s7s3">RXAxis</a>, <a class="code" href="structNLMISC_1_1IGameDevice.html#s7s4">RYAxis</a>, <a class="code" href="structNLMISC_1_1IGameDevice.html#s7s5">RZAxis</a>, <font class="comment">/* rotations */</font> +00076 <a class="code" href="structNLMISC_1_1IGameDevice.html#s7s6">MaxNumAxis</a> +00077 }; +00078 +00080 <font class="keyword">virtual</font> <font class="keyword">const</font> CGameDeviceDesc &<a class="code" href="structNLMISC_1_1IGameDevice.html#a0">getDescription</a>() <font class="keyword">const</font> = 0; +00081 +00083 +00084 <font class="comment">// returns the number of buttons available on this game device</font> +00085 <font class="keyword">virtual</font> uint <a class="code" href="structNLMISC_1_1IGameDevice.html#z285_0">getNumButtons</a>() <font class="keyword">const</font> = 0; +00089 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="structNLMISC_1_1IGameDevice.html#z285_1">hasAxis</a>(<a class="code" href="structNLMISC_1_1IGameDevice.html#s7">TAxis</a> axis) <font class="keyword">const</font> = 0; +00090 <font class="comment">// Check the number of sliders presents on this game device</font> +00091 <font class="keyword">virtual</font> uint <a class="code" href="structNLMISC_1_1IGameDevice.html#z285_2">getNumSliders</a>() <font class="keyword">const</font> = 0; +00092 <font class="comment">// Check the number of point of views controls present on this game device</font> +00093 <font class="keyword">virtual</font> uint <a class="code" href="structNLMISC_1_1IGameDevice.html#z285_3">getNumPOV</a>() <font class="keyword">const</font> = 0; +00095 +00097 +00098 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="structNLMISC_1_1IGameDevice.html#z286_0">getButtonName</a>(uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>) <font class="keyword">const</font> = 0; +00099 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="structNLMISC_1_1IGameDevice.html#z286_1">getAxisName</a>(<a class="code" href="structNLMISC_1_1IGameDevice.html#s7">TAxis</a> axis) <font class="keyword">const</font> = 0; +00100 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="structNLMISC_1_1IGameDevice.html#z286_2">getSliderName</a>(uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>) <font class="keyword">const</font> = 0; +00101 <font class="keyword">virtual</font> <font class="keyword">const</font> <font class="keywordtype">char</font> *<a class="code" href="structNLMISC_1_1IGameDevice.html#z286_3">getPOVName</a>(uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>) <font class="keyword">const</font> = 0; +00103 +00105 +00106 <font class="comment">// Return true if the given button is pushed.</font> +00107 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="structNLMISC_1_1IGameDevice.html#z287_0">getButtonState</a>(uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>) <font class="keyword">const</font> = 0; +00108 <font class="comment">// Return a value in [-1, 1] for a translation axis, or an orientation.</font> +00109 <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="structNLMISC_1_1IGameDevice.html#z287_1">getAxisValue</a>(<a class="code" href="structNLMISC_1_1IGameDevice.html#s7">TAxis</a> axis) <font class="keyword">const</font> = 0; +00110 <font class="comment">// Return a value in [0, 1]</font> +00111 <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="structNLMISC_1_1IGameDevice.html#z287_2">getSliderPos</a>(uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>) <font class="keyword">const</font> = 0; +00112 <font class="comment">// Return a CCW angle in degrees</font> +00113 <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="structNLMISC_1_1IGameDevice.html#z287_3">getPOVAngle</a>(uint <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>) <font class="keyword">const</font> = 0; +00115 }; +00116 +00117 +00118 } <font class="comment">// NLMISC</font> +00119 +00120 +00121 <font class="preprocessor">#endif // NL_GAME_DEVICE_H</font> +00122 <font class="preprocessor"></font> +00123 <font class="comment">/* End of GAME_device.h */</font> +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |