<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iSndSysListener Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iSndSysListener Struct Reference<br>
<small>
[<a class="el" href="group__sndsys.html">Sound system</a>]</small>
</h1><!-- doxytag: class="iSndSysListener" --><!-- doxytag: inherits="iBase" -->The sound listener is a unique object created by the sound renderer.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ss__listener_8h-source.html">isndsys/ss_listener.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iSndSysListener:</div>
<div class="dynsection">
<p><center><img src="structiSndSysListener__inherit__graph.png" border="0" usemap="#iSndSysListener__inherit__map" alt="Inheritance graph"></center>
<map name="iSndSysListener__inherit__map">
<area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="40,7,96,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiSndSysListener-members.html">List of all members.</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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#327e0daef96a31ccce146e851bfe946f">GetDirection</a> (<a class="el" href="classcsVector3.html">csVector3</a> &Front, <a class="el" href="classcsVector3.html">csVector3</a> &Top)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set type of environment where 'live' listener <a href="#327e0daef96a31ccce146e851bfe946f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#b78eb738cb9008f1d1b7d63a7c198dae">GetDistanceFactor</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a distance attenuator. <a href="#b78eb738cb9008f1d1b7d63a7c198dae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const <a class="el" href="classcsVector3.html">csVector3</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#840efb5223b04101efb8f3d491b35c9d">GetPosition</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get position of listener. <a href="#840efb5223b04101efb8f3d491b35c9d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#df2f7535137fe72edadbc98c840e5ed6">GetRollOffFactor</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a RollOff factor. <a href="#df2f7535137fe72edadbc98c840e5ed6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#a7b438341651f41bc9f377149eddf28f">SCF_INTERFACE</a> (<a class="el" href="structiSndSysListener.html">iSndSysListener</a>, 0, 0, 2)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">SCF2006 - See <a href="http://www.crystalspace3d.org/cseps/csep-0010.html.">http://www.crystalspace3d.org/cseps/csep-0010.html.</a> <a href="#a7b438341651f41bc9f377149eddf28f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#e73df874e205fac1bc085b9efbcba181">SetDirection</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &Front, const <a class="el" href="classcsVector3.html">csVector3</a> &Top)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set direction of listener (front and top 3d vectors). <a href="#e73df874e205fac1bc085b9efbcba181"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#205cbe65086c59021fb23f9fe9b5e540">SetDistanceFactor</a> (float factor)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a distance attenuator. <a href="#205cbe65086c59021fb23f9fe9b5e540"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#3af592926139981a8950e46f05bbd66f">SetPosition</a> (const <a class="el" href="classcsVector3.html">csVector3</a> &pos)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set position of listener. <a href="#3af592926139981a8950e46f05bbd66f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiSndSysListener.html#1d237cc44ddd04ef5fddaa15fc8f5bea">SetRollOffFactor</a> (float factor)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a RollOff factor. <a href="#1d237cc44ddd04ef5fddaa15fc8f5bea"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The sound listener is a unique object created by the sound renderer.
<p>
It can be used to setup 'yourself' (the player) for 3d sound: position, orientation, speed and environment effects.
<p>Definition at line <a class="el" href="ss__listener_8h-source.html#l00037">37</a> of file <a class="el" href="ss__listener_8h-source.html">ss_listener.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="327e0daef96a31ccce146e851bfe946f"></a><!-- doxytag: member="iSndSysListener::GetDirection" ref="327e0daef96a31ccce146e851bfe946f" args="(csVector3 &Front, csVector3 &Top)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSndSysListener::GetDirection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> & </td>
<td class="paramname"> <em>Front</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsVector3.html">csVector3</a> & </td>
<td class="paramname"> <em>Top</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
set type of environment where 'live' listener
<p>
Get direction of listener (front and top 3d vectors)
</div>
</div><p>
<a class="anchor" name="b78eb738cb9008f1d1b7d63a7c198dae"></a><!-- doxytag: member="iSndSysListener::GetDistanceFactor" ref="b78eb738cb9008f1d1b7d63a7c198dae" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iSndSysListener::GetDistanceFactor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a distance attenuator.
<p>
</div>
</div><p>
<a class="anchor" name="840efb5223b04101efb8f3d491b35c9d"></a><!-- doxytag: member="iSndSysListener::GetPosition" ref="840efb5223b04101efb8f3d491b35c9d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classcsVector3.html">csVector3</a>& iSndSysListener::GetPosition </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get position of listener.
<p>
</div>
</div><p>
<a class="anchor" name="df2f7535137fe72edadbc98c840e5ed6"></a><!-- doxytag: member="iSndSysListener::GetRollOffFactor" ref="df2f7535137fe72edadbc98c840e5ed6" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float iSndSysListener::GetRollOffFactor </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a RollOff factor.
<p>
</div>
</div><p>
<a class="anchor" name="a7b438341651f41bc9f377149eddf28f"></a><!-- doxytag: member="iSndSysListener::SCF_INTERFACE" ref="a7b438341651f41bc9f377149eddf28f" args="(iSndSysListener, 0, 0, 2)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">iSndSysListener::SCF_INTERFACE </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiSndSysListener.html">iSndSysListener</a> </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">0 </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">0 </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">2 </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
SCF2006 - See <a href="http://www.crystalspace3d.org/cseps/csep-0010.html.">http://www.crystalspace3d.org/cseps/csep-0010.html.</a>
<p>
</div>
</div><p>
<a class="anchor" name="e73df874e205fac1bc085b9efbcba181"></a><!-- doxytag: member="iSndSysListener::SetDirection" ref="e73df874e205fac1bc085b9efbcba181" args="(const csVector3 &Front, const csVector3 &Top)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSndSysListener::SetDirection </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td>
<td class="paramname"> <em>Front</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td>
<td class="paramname"> <em>Top</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set direction of listener (front and top 3d vectors).
<p>
</div>
</div><p>
<a class="anchor" name="205cbe65086c59021fb23f9fe9b5e540"></a><!-- doxytag: member="iSndSysListener::SetDistanceFactor" ref="205cbe65086c59021fb23f9fe9b5e540" args="(float factor)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSndSysListener::SetDistanceFactor </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>factor</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a distance attenuator.
<p>
</div>
</div><p>
<a class="anchor" name="3af592926139981a8950e46f05bbd66f"></a><!-- doxytag: member="iSndSysListener::SetPosition" ref="3af592926139981a8950e46f05bbd66f" args="(const csVector3 &pos)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSndSysListener::SetPosition </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcsVector3.html">csVector3</a> & </td>
<td class="paramname"> <em>pos</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set position of listener.
<p>
</div>
</div><p>
<a class="anchor" name="1d237cc44ddd04ef5fddaa15fc8f5bea"></a><!-- doxytag: member="iSndSysListener::SetRollOffFactor" ref="1d237cc44ddd04ef5fddaa15fc8f5bea" args="(float factor)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iSndSysListener::SetRollOffFactor </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>factor</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set a RollOff factor.
<p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>isndsys/<a class="el" href="ss__listener_8h-source.html">ss_listener.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3721
