diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/doxygen/nel/a03933.html | 420 |
1 files changed, 420 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03933.html b/docs/doxygen/nel/a03933.html new file mode 100644 index 00000000..c28b91b0 --- /dev/null +++ b/docs/doxygen/nel/a03933.html @@ -0,0 +1,420 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLSOUND::UListener class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLSOUND::UListener Class Reference</h1><code>#include <<a class="el" href="a06612.html">u_listener.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::UListener: +<p><center><img src="a03933.png" usemap="#NLSOUND::UListener_map" border="0" alt=""></center> +<map name="NLSOUND::UListener_map"> +<area href="a02768.html" alt="NLSOUND::CListenerUser" shape="rect" coords="0,56,158,80"> +</map> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Game interface for listener control.<p> +For arguments as 3D vectors, use the NeL vector coordinate system: <pre class="fragment"><div> + * (top) + * z + * | y (front) + * | / + * -----x (right) + * </div></pre><dl compact><dt><b>Author:</b></dt><dd>Olivier Cado <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a06612.html#l00055">55</a> of file <a class="el" href="a06612.html">u_listener.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenera0">~UListener</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#NLSOUND_1_1UListenera0"></a><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Listener properties</div></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual float </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_0">getGain</a> () const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the gain. <a href="#NLSOUND_1_1UListenerz2135_0"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_1">getOrientation</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &front, <a class="el" href="a03128.html">NLMISC::CVector</a> &up) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the orientation vectors. <a href="#NLSOUND_1_1UListenerz2135_1"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_2">getPos</a> () const=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_3">getVelocity</a> (<a class="el" href="a03128.html">NLMISC::CVector</a> &vel) const=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the velocity vector. <a href="#NLSOUND_1_1UListenerz2135_3"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_4">setGain</a> (float gain)=0</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_5">setOrientation</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &front, const <a class="el" href="a03128.html">NLMISC::CVector</a> &up)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the orientation vectors (3D mode only, ignored in stereo mode) (default: (0,1,0), (0,0,1)). <a href="#NLSOUND_1_1UListenerz2135_5"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_6">setPos</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &pos)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the position vector (default: (0,0,0)) (3D mode only). <a href="#NLSOUND_1_1UListenerz2135_6"></a><br><br></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_7">setVelocity</a> (const <a class="el" href="a03128.html">NLMISC::CVector</a> &vel)=0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). <a href="#NLSOUND_1_1UListenerz2135_7"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a03933.html#NLSOUND_1_1UListenerb0">UListener</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1UListenerb0"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1UListenera0" doxytag="NLSOUND::UListener::~UListener" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NLSOUND::UListener::~<a class="el" href="a03933.html">UListener</a> </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destructor. +<p> + +<p> +Definition at line <a class="el" href="a06612.html#l00087">87</a> of file <a class="el" href="a06612.html">u_listener.h</a>. +<p> +<div class="fragment"><pre>00087 {} +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerb0" doxytag="NLSOUND::UListener::UListener" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::UListener::UListener </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, protected]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="a06612.html#l00092">92</a> of file <a class="el" href="a06612.html">u_listener.h</a>. +<p> +<div class="fragment"><pre>00092 {} +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_0" doxytag="NLSOUND::UListener::getGain" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual float NLSOUND::UListener::getGain </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the gain. +<p> + +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_0">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_1" doxytag="NLSOUND::UListener::getOrientation" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UListener::getOrientation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>front</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>up</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the orientation vectors. +<p> + +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_1">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_2" doxytag="NLSOUND::UListener::getPos" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual const <a class="el" href="a03128.html">NLMISC::CVector</a>& NLSOUND::UListener::getPos </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the position vector. See <a class="el" href="a03933.html#NLSOUND_1_1UListenerz2135_6">setPos()</a> for details. +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_2">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_3" doxytag="NLSOUND::UListener::getVelocity" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UListener::getVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>vel</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap> const<code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the velocity vector. +<p> + +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_3">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_4" doxytag="NLSOUND::UListener::setGain" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UListener::setGain </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>gain</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the gain (volume value inside [0 , 1]). (default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_4">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_5" doxytag="NLSOUND::UListener::setOrientation" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UListener::setOrientation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>front</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>up</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the orientation vectors (3D mode only, ignored in stereo mode) (default: (0,1,0), (0,0,1)). +<p> + +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_5">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_6" doxytag="NLSOUND::UListener::setPos" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UListener::setPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the position vector (default: (0,0,0)) (3D mode only). +<p> + +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_6">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1UListenerz2135_7" doxytag="NLSOUND::UListener::setVelocity" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual void NLSOUND::UListener::setVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">NLMISC::CVector</a> & </td> + <td class="mdname1" valign="top" nowrap> <em>vel</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [pure virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the velocity vector (3D mode only, ignored in stereo mode) (default: (0,0,0)). +<p> + +<p> +Implemented in <a class="el" href="a02768.html#NLSOUND_1_1CListenerUserz1336_7">NLSOUND::CListenerUser</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="a06612.html">u_listener.h</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:53:36 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |