kai/assaultcube-
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
44ef9c1cf8565ff95f11e36adfa6e9bf3dca8c6c
assaultcube-/source/doxygen/html/classlocation.html
T
driAn 44ef9c1cf8 added doxygen source code docs 
git-svn-id: svn://svn.code.sf.net/p/actiongame/code/trunk/ac@3951 e016b1c5-ed68-44aa-a2f7-31cac88cffde
2008-12-08 21:10:24 +00:00

434 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>AssaultCube: location Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>location Class Reference</h1><!-- doxytag: class="location" --><!-- doxytag: inherits="sourceowner" --><code>#include &lt;sound.h&gt;</code>
<p>
Inherits <a class="el" href="classsourceowner.html">sourceowner</a>.
<p>
<div class="dynheader">
Collaboration diagram for location:</div>
<div class="dynsection">
<p><center><img src="classlocation__coll__graph.png" border="0" usemap="#location__coll__map" alt="Collaboration graph"></center>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classlocation-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#17e85a4605cddde434898c46ae3500a2">location</a> (int sound, const <a class="el" href="classworldobjreference.html">worldobjreference</a> &amp;r, int priority=SP_NORMAL)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#605fd5e73a36e22b59f4e9af160eae9c">~location</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#64390ba971a857ea89d48b25307f45d9">attachworldobjreference</a> (const <a class="el" href="classworldobjreference.html">worldobjreference</a> &amp;r)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#92f753ff768d15c9c05ffc746abe3a6b">evaluateworldobjref</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#ec4e014aec37159210d99ae7adc93e73">onsourcereassign</a> (<a class="el" href="classsource.html">source</a> *<a class="el" href="worldrender_8cpp.html#8feeb8812290964a8e453e58dae6f3c3">s</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#b7c9da188d5c2ed3e5839c73f046c947">updatepos</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#14f238bdb0f9e3dfcfe603ed20022582">update</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#8e89fcb4135c0575b9a5d7019c307b27">play</a> (bool loop=false)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#31a4a50487648aef1feedb2cce7c36af">pitch</a> (float p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#dc765d3e3e84934424caa844c9aea676">setvolume</a> (float <a class="el" href="worldrender_8cpp.html#ad6f72c6f88c7d9ce219ce318298da20">v</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#afef0d324151a267af2a246e56ab1e3b">offset</a> (float secs)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#684cc6fb5377ba86ecdf4f99ebca3975">offset</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#b3d1988ada6a390da74fbd94be6dea23">drop</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsoundconfig.html">soundconfig</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#43b25e7a5a4b2688185b95a412281109">cfg</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classsource.html">source</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#3c87263566a92c88c144e90f5cc9a47c">src</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classworldobjreference.html">worldobjreference</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#a3189dbf0a3967a3fe1a0d08bbfe9036">ref</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#f524be2e892882a885dd97050e69a287">stale</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlocation.html#7209ab0fdee6cee2fb3da602a9cc1a23">playmillis</a></td></tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="17e85a4605cddde434898c46ae3500a2"></a><!-- doxytag: member="location::location" ref="17e85a4605cddde434898c46ae3500a2" args="(int sound, const worldobjreference &amp;r, int priority=SP_NORMAL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">location::location </td>
<td>(</td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>sound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classworldobjreference.html">worldobjreference</a> &amp;&nbsp;</td>
<td class="paramname"> <em>r</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"> <em>priority</em> = <code>SP_NORMAL</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="605fd5e73a36e22b59f4e9af160eae9c"></a><!-- doxytag: member="location::~location" ref="605fd5e73a36e22b59f4e9af160eae9c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">location::~location </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="64390ba971a857ea89d48b25307f45d9"></a><!-- doxytag: member="location::attachworldobjreference" ref="64390ba971a857ea89d48b25307f45d9" args="(const worldobjreference &amp;r)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::attachworldobjreference </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classworldobjreference.html">worldobjreference</a> &amp;&nbsp;</td>
<td class="paramname"> <em>r</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b3d1988ada6a390da74fbd94be6dea23"></a><!-- doxytag: member="location::drop" ref="b3d1988ada6a390da74fbd94be6dea23" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::drop </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="92f753ff768d15c9c05ffc746abe3a6b"></a><!-- doxytag: member="location::evaluateworldobjref" ref="92f753ff768d15c9c05ffc746abe3a6b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::evaluateworldobjref </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="684cc6fb5377ba86ecdf4f99ebca3975"></a><!-- doxytag: member="location::offset" ref="684cc6fb5377ba86ecdf4f99ebca3975" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float location::offset </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="afef0d324151a267af2a246e56ab1e3b"></a><!-- doxytag: member="location::offset" ref="afef0d324151a267af2a246e56ab1e3b" args="(float secs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::offset </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>secs</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ec4e014aec37159210d99ae7adc93e73"></a><!-- doxytag: member="location::onsourcereassign" ref="ec4e014aec37159210d99ae7adc93e73" args="(source *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::onsourcereassign </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classsource.html">source</a> *&nbsp;</td>
<td class="paramname"> <em>s</em> </td>
<td>&nbsp;)&nbsp;</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Implements <a class="el" href="classsourceowner.html#fd46293e16cfc1c3f1cce228b882cc50">sourceowner</a>.</p>
</div>
</div><p>
<a class="anchor" name="31a4a50487648aef1feedb2cce7c36af"></a><!-- doxytag: member="location::pitch" ref="31a4a50487648aef1feedb2cce7c36af" args="(float p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::pitch </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>p</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="8e89fcb4135c0575b9a5d7019c307b27"></a><!-- doxytag: member="location::play" ref="8e89fcb4135c0575b9a5d7019c307b27" args="(bool loop=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::play </td>
<td>(</td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"> <em>loop</em> = <code>false</code> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="dc765d3e3e84934424caa844c9aea676"></a><!-- doxytag: member="location::setvolume" ref="dc765d3e3e84934424caa844c9aea676" args="(float v)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool location::setvolume </td>
<td>(</td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"> <em>v</em> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="14f238bdb0f9e3dfcfe603ed20022582"></a><!-- doxytag: member="location::update" ref="14f238bdb0f9e3dfcfe603ed20022582" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::update </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b7c9da188d5c2ed3e5839c73f046c947"></a><!-- doxytag: member="location::updatepos" ref="b7c9da188d5c2ed3e5839c73f046c947" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void location::updatepos </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="43b25e7a5a4b2688185b95a412281109"></a><!-- doxytag: member="location::cfg" ref="43b25e7a5a4b2688185b95a412281109" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsoundconfig.html">soundconfig</a>* <a class="el" href="classlocation.html#43b25e7a5a4b2688185b95a412281109">location::cfg</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7209ab0fdee6cee2fb3da602a9cc1a23"></a><!-- doxytag: member="location::playmillis" ref="7209ab0fdee6cee2fb3da602a9cc1a23" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classlocation.html#7209ab0fdee6cee2fb3da602a9cc1a23">location::playmillis</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a3189dbf0a3967a3fe1a0d08bbfe9036"></a><!-- doxytag: member="location::ref" ref="a3189dbf0a3967a3fe1a0d08bbfe9036" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classworldobjreference.html">worldobjreference</a>* <a class="el" href="classlocation.html#a3189dbf0a3967a3fe1a0d08bbfe9036">location::ref</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="3c87263566a92c88c144e90f5cc9a47c"></a><!-- doxytag: member="location::src" ref="3c87263566a92c88c144e90f5cc9a47c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsource.html">source</a>* <a class="el" href="classlocation.html#3c87263566a92c88c144e90f5cc9a47c">location::src</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="f524be2e892882a885dd97050e69a287"></a><!-- doxytag: member="location::stale" ref="f524be2e892882a885dd97050e69a287" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classlocation.html#f524be2e892882a885dd97050e69a287">location::stale</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>R:/projects/actioncube/_svn/trunk/ac/source/src/<a class="el" href="sound_8h.html">sound.h</a><li>R:/projects/actioncube/_svn/trunk/ac/source/src/<a class="el" href="soundlocation_8cpp.html">soundlocation.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 21:41:35 2008 for AssaultCube by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink