diff options
Diffstat (limited to 'docs/doxygen/nel/classNLSOUND_1_1CListenerAL.html')
| -rw-r--r-- | docs/doxygen/nel/classNLSOUND_1_1CListenerAL.html | 780 |
1 files changed, 780 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLSOUND_1_1CListenerAL.html b/docs/doxygen/nel/classNLSOUND_1_1CListenerAL.html new file mode 100644 index 00000000..0870d444 --- /dev/null +++ b/docs/doxygen/nel/classNLSOUND_1_1CListenerAL.html @@ -0,0 +1,780 @@ +<!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>NLSOUND::CListenerAL Class Reference</h1>OpenAL sound listener. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="listener__al_8h-source.html">listener_al.h</a>></code> +<p> +<p>Inheritance diagram for NLSOUND::CListenerAL: +<p><center><img src="classNLSOUND_1_1CListenerAL.gif" usemap="#NLSOUND::CListenerAL_map" border="0"></center> +<map name="NLSOUND::CListenerAL_map"> +<area href="classNLSOUND_1_1IListener.html" alt="NLSOUND::IListener" shape="rect" coords="0,0,148,24"> +</map> +<a href="classNLSOUND_1_1CListenerAL-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#a0">CListenerAL</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#a1">~CListenerAL</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Destructor.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Listener properties</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_0">setPos</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &pos)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the position vector (default: (0,0,0)) (3D mode only).</em> <a href="#z973_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_1">getPos</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the position vector.</em> <a href="#z973_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_2">setVelocity</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the velocity vector (3D mode only) (default: (0,0,0)).</em> <a href="#z973_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_3">getVelocity</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &vel) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the velocity vector.</em> <a href="#z973_3">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_4">setOrientation</a> (const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &front, const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &up)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the orientation vectors (3D mode only) (default: (0,1,0), (0,0,1)).</em> <a href="#z973_4">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_5">getOrientation</a> (<a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &front, <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> &up) const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the orientation vectors.</em> <a href="#z973_5">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_6">setGain</a> (float gain)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the gain (volume value inside [0 , 1]).</em> <a href="#z973_6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_7">getGain</a> () const</td></tr> +<tr><td> </td><td><font size=-1><em>Get the gain.</em> <a href="#z973_7">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan="2"><div class="groupHeader">Global properties</div></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z974_0">setDopplerFactor</a> (float f)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the doppler factor (default: 1) to exaggerate or not the doppler effect.</em> <a href="#z974_0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z974_1">setRolloffFactor</a> (float f)</td></tr> +<tr><td> </td><td><font size=-1><em>Set the rolloff factor (default: 1) to scale the distance attenuation effect.</em> <a href="#z974_1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z974_2">setEnvironment</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> env, float <a class="el" href="cf__lexical_8cpp.html#a94">size</a>=7.5f)</td></tr> +<tr><td> </td><td><font size=-1><em>Set DSPROPERTY_EAXLISTENER_ENVIRONMENT and DSPROPERTY_EAXLISTENER_ENVIRONMENTSIZE if EAX available (see EAX listener properties).</em> <a href="#z974_2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#z974_3">setEAXProperty</a> (<a class="el" href="memory__common_8h.html#a15">uint</a> prop, void *<a class="el" href="driver__opengl__extension__def_8h.html#a415">value</a>, <a class="el" href="memory__common_8h.html#a15">uint</a> valuesize)</td></tr> +<tr><td> </td><td><font size=-1><em>Set any EAX listener property if EAX available.</em> <a href="#z974_3">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top>CListenerAL * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#d0">instance</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>Return the instance of the singleton.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#o0">_Pos</a></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td nowrap align=right valign=top>CListenerAL * </td><td valign=bottom><a class="el" href="classNLSOUND_1_1CListenerAL.html#r0">_Instance</a> = NULL</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +OpenAL sound listener. +<p> +For arguments as 3D vectors, use the NeL vector coordinate system (not OpenAL/OpenGL's one). +<p> +<dl compact><dt><b> +Author: </b><dd> +Olivier Cado , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2001 </dl> +<p> + +<p> +Definition at line <a class="el" href="listener__al_8h-source.html#l00046">46</a> of file <a class="el" href="listener__al_8h-source.html">listener_al.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="NLSOUND::CListenerAL::CListenerAL"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CListenerAL::CListenerAL </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></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="listener__al_8cpp-source.html#l00044">44</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="listener__al_8cpp-source.html#l00038">_Instance</a>, and <a class="el" href="debug_8h-source.html#l00133">nlerror</a>. +<p> +Referenced by <a class="el" href="listener__al_8h-source.html#l00054">instance</a>. </td> + </tr> +</table> +<a name="a1" doxytag="NLSOUND::CListenerAL::~CListenerAL"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> virtual NLSOUND::CListenerAL::~CListenerAL </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="listener__al_8h-source.html#l00096">96</a> of file <a class="el" href="listener__al_8h-source.html">listener_al.h</a>. +<p> +References <a class="el" href="listener__al_8cpp-source.html#l00038">_Instance</a>. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="z973_7" doxytag="NLSOUND::CListenerAL::getGain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> float NLSOUND::CListenerAL::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> [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> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_7">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00176">176</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z973_5" doxytag="NLSOUND::CListenerAL::getOrientation"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::getOrientation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>front</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="classNLMISC_1_1CVector.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> [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> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_5">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00148">148</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="vector__inline_8h-source.html#l00136">NLMISC::CVector::set</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00234">v</a>. </td> + </tr> +</table> +<a name="z973_1" doxytag="NLSOUND::CListenerAL::getPos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & NLSOUND::CListenerAL::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> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Get the position vector. +<p> +See <a class="el" href="classNLSOUND_1_1CListenerAL.html#z973_0">setPos</a>() for details. +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_1">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00072">72</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="listener__al_8h-source.html#l00103">_Pos</a>. </td> + </tr> +</table> +<a name="z973_3" doxytag="NLSOUND::CListenerAL::getVelocity"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::getVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="classNLMISC_1_1CVector.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> [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> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_3">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00109">109</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="vector__inline_8h-source.html#l00136">NLMISC::CVector::set</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::x</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::y</a>, and <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::z</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLSOUND::CListenerAL::instance"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> CListenerAL* NLSOUND::CListenerAL::instance </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, static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Return the instance of the singleton. +<p> + +<p> +Definition at line <a class="el" href="listener__al_8h-source.html#l00054">54</a> of file <a class="el" href="listener__al_8h-source.html">listener_al.h</a>. +<p> +References <a class="el" href="listener__al_8cpp-source.html#l00038">_Instance</a>, and <a class="el" href="listener__al_8cpp-source.html#l00044">CListenerAL</a>. </td> + </tr> +</table> +<a name="z974_0" doxytag="NLSOUND::CListenerAL::setDopplerFactor"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::setDopplerFactor </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>f</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the doppler factor (default: 1) to exaggerate or not the doppler effect. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z972_0">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00192">192</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z974_3" doxytag="NLSOUND::CListenerAL::setEAXProperty"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::setEAXProperty </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>prop</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>void * </td> + <td class="mdname" nowrap> <em>value</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>valuesize</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set any EAX listener property if EAX available. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z972_3">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00227">227</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="driver__opengl__extension__def_8h-source.html#l00828">value</a>. </td> + </tr> +</table> +<a name="z974_2" doxytag="NLSOUND::CListenerAL::setEnvironment"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::setEnvironment </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="memory__common_8h.html#a15">uint</a> </td> + <td class="mdname" nowrap> <em>env</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>float </td> + <td class="mdname" nowrap> <em>size</em> = 7.5f</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set DSPROPERTY_EAXLISTENER_ENVIRONMENT and DSPROPERTY_EAXLISTENER_ENVIRONMENTSIZE if EAX available (see EAX listener properties). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z972_2">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00212">212</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. </td> + </tr> +</table> +<a name="z973_6" doxytag="NLSOUND::CListenerAL::setGain"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::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> [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]). +<p> +(default: 1) 0.0 -> silence 0.5 -> -6dB 1.0 -> no attenuation values > 1 (amplification) not supported by most drivers +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_6">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00166">166</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>. </td> + </tr> +</table> +<a name="z973_4" doxytag="NLSOUND::CListenerAL::setOrientation"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::setOrientation </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> & </td> + <td class="mdname" nowrap> <em>front</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>const <a class="el" href="classNLMISC_1_1CVector.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> [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) (default: (0,1,0), (0,0,1)). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_4">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00129">129</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, <a class="el" href="driver__opengl__extension__def_8h-source.html#l00234">v</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::x</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::y</a>, and <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::z</a>. </td> + </tr> +</table> +<a name="z973_0" doxytag="NLSOUND::CListenerAL::setPos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::setPos </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.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> [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> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_0">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00060">60</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="listener__al_8h-source.html#l00103">_Pos</a>, <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::x</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::y</a>, and <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::z</a>. </td> + </tr> +</table> +<a name="z974_1" doxytag="NLSOUND::CListenerAL::setRolloffFactor"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::setRolloffFactor </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">float </td> + <td class="mdname1" valign="top" nowrap> <em>f</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap><code> [virtual]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Set the rolloff factor (default: 1) to scale the distance attenuation effect. +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z972_1">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00202">202</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="debug_8h-source.html#l00254">nlassert</a>. </td> + </tr> +</table> +<a name="z973_2" doxytag="NLSOUND::CListenerAL::setVelocity"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CListenerAL::setVelocity </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="classNLMISC_1_1CVector.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> [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) (default: (0,0,0)). +<p> + +<p> +Implements <a class="el" href="classNLSOUND_1_1IListener.html#z971_2">NLSOUND::IListener</a>. +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00098">98</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +References <a class="el" href="sound__driver__al_8h-source.html#l00070">TestALError</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::x</a>, <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::y</a>, and <a class="el" href="vector_8h-source.html#l00051">NLMISC::CVector::z</a>. </td> + </tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a name="r0" doxytag="NLSOUND::CListenerAL::_Instance"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> CListenerAL * NLSOUND::CListenerAL::_Instance = NULL<code> [static, private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="listener__al_8cpp-source.html#l00038">38</a> of file <a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a>. +<p> +Referenced by <a class="el" href="listener__al_8cpp-source.html#l00044">CListenerAL</a>, <a class="el" href="listener__al_8h-source.html#l00054">instance</a>, and <a class="el" href="listener__al_8h-source.html#l00096">~CListenerAL</a>. </td> + </tr> +</table> +<a name="o0" doxytag="NLSOUND::CListenerAL::_Pos"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="classNLMISC_1_1CVector.html">NLMISC::CVector</a> NLSOUND::CListenerAL::_Pos<code> [private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="listener__al_8h-source.html#l00103">103</a> of file <a class="el" href="listener__al_8h-source.html">listener_al.h</a>. +<p> +Referenced by <a class="el" href="listener__al_8cpp-source.html#l00072">getPos</a>, and <a class="el" href="listener__al_8cpp-source.html#l00060">setPos</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="listener__al_8h-source.html">listener_al.h</a><li><a class="el" href="listener__al_8cpp-source.html">listener_al.cpp</a></ul> + + +<!-- 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> |