<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Audaspace: Source Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Audaspace
 <span id="projectnumber">1.3.0</span>
</div>
<div id="projectbrief">A high level audio library.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classSource-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Source Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class stores the azimuth and elevation angles of a sound and allows to change them dynamically.
<a href="classSource.html#details">More...</a></p>
<p><code>#include <<a class="el" href="Source_8h_source.html">Source.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a483068594909b2be243b5247046a2e14"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#a483068594909b2be243b5247046a2e14">Source</a> (float azimuth, float elevation, float distance=0.0)</td></tr>
<tr class="memdesc:a483068594909b2be243b5247046a2e14"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classSource.html" title="This class stores the azimuth and elevation angles of a sound and allows to change them dynamically.">Source</a> instance with an initial value. <a href="#a483068594909b2be243b5247046a2e14">More...</a><br /></td></tr>
<tr class="separator:a483068594909b2be243b5247046a2e14"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa97636b4622d441cd4fc00b4908a5c16"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#aa97636b4622d441cd4fc00b4908a5c16">getAzimuth</a> ()</td></tr>
<tr class="memdesc:aa97636b4622d441cd4fc00b4908a5c16"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current azimuth value. <a href="#aa97636b4622d441cd4fc00b4908a5c16">More...</a><br /></td></tr>
<tr class="separator:aa97636b4622d441cd4fc00b4908a5c16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a47e0ef8e6d88faee468d72fb20c8ff08"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#a47e0ef8e6d88faee468d72fb20c8ff08">getElevation</a> ()</td></tr>
<tr class="memdesc:a47e0ef8e6d88faee468d72fb20c8ff08"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current elevation value. <a href="#a47e0ef8e6d88faee468d72fb20c8ff08">More...</a><br /></td></tr>
<tr class="separator:a47e0ef8e6d88faee468d72fb20c8ff08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15ce6b5f7108cabca743ef1d1f52da3b"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#a15ce6b5f7108cabca743ef1d1f52da3b">getDistance</a> ()</td></tr>
<tr class="memdesc:a15ce6b5f7108cabca743ef1d1f52da3b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current distance value. <a href="#a15ce6b5f7108cabca743ef1d1f52da3b">More...</a><br /></td></tr>
<tr class="separator:a15ce6b5f7108cabca743ef1d1f52da3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a06b2b93c8f2c5a0eac0a8a2411944dd2"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#a06b2b93c8f2c5a0eac0a8a2411944dd2">getVolume</a> ()</td></tr>
<tr class="memdesc:a06b2b93c8f2c5a0eac0a8a2411944dd2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current volume value based on the distance. <a href="#a06b2b93c8f2c5a0eac0a8a2411944dd2">More...</a><br /></td></tr>
<tr class="separator:a06b2b93c8f2c5a0eac0a8a2411944dd2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a19bc20c45c6d76aeeee520bfb2492616"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#a19bc20c45c6d76aeeee520bfb2492616">setAzimuth</a> (float azimuth)</td></tr>
<tr class="memdesc:a19bc20c45c6d76aeeee520bfb2492616"><td class="mdescLeft"> </td><td class="mdescRight">Changes the azimuth value. <a href="#a19bc20c45c6d76aeeee520bfb2492616">More...</a><br /></td></tr>
<tr class="separator:a19bc20c45c6d76aeeee520bfb2492616"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1017f4bc2640c5f5ed2c8a13308584de"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#a1017f4bc2640c5f5ed2c8a13308584de">setElevation</a> (float elevation)</td></tr>
<tr class="memdesc:a1017f4bc2640c5f5ed2c8a13308584de"><td class="mdescLeft"> </td><td class="mdescRight">Changes the elevation value. <a href="#a1017f4bc2640c5f5ed2c8a13308584de">More...</a><br /></td></tr>
<tr class="separator:a1017f4bc2640c5f5ed2c8a13308584de"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58ddbee91bc1af52d22d08664bd936d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSource.html#a58ddbee91bc1af52d22d08664bd936d9">setDistance</a> (float distance)</td></tr>
<tr class="memdesc:a58ddbee91bc1af52d22d08664bd936d9"><td class="mdescLeft"> </td><td class="mdescRight">Changes the distance value. <a href="#a58ddbee91bc1af52d22d08664bd936d9">More...</a><br /></td></tr>
<tr class="separator:a58ddbee91bc1af52d22d08664bd936d9"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class stores the azimuth and elevation angles of a sound and allows to change them dynamically. </p>
<p>The azimuth angle goes clockwise. For a sound source situated at the right of the listener the azimuth angle is 90. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a483068594909b2be243b5247046a2e14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a483068594909b2be243b5247046a2e14">◆ </a></span>Source()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Source::Source </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>azimuth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>elevation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>distance</em> = <code>0.0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classSource.html" title="This class stores the azimuth and elevation angles of a sound and allows to change them dynamically.">Source</a> instance with an initial value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">azimuth</td><td>The value of the azimuth. </td></tr>
<tr><td class="paramname">elevation</td><td>The value of the elevation. </td></tr>
<tr><td class="paramname">distance</td><td>The distance from the listener. Max distance is 1, min distance is 0. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa97636b4622d441cd4fc00b4908a5c16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa97636b4622d441cd4fc00b4908a5c16">◆ </a></span>getAzimuth()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Source::getAzimuth </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the current azimuth value. </p>
<dl class="section return"><dt>Returns</dt><dd>The current azimuth. </dd></dl>
</div>
</div>
<a id="a15ce6b5f7108cabca743ef1d1f52da3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15ce6b5f7108cabca743ef1d1f52da3b">◆ </a></span>getDistance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Source::getDistance </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the current distance value. </p>
<dl class="section return"><dt>Returns</dt><dd>The current distance. </dd></dl>
</div>
</div>
<a id="a47e0ef8e6d88faee468d72fb20c8ff08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47e0ef8e6d88faee468d72fb20c8ff08">◆ </a></span>getElevation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Source::getElevation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the current elevation value. </p>
<dl class="section return"><dt>Returns</dt><dd>The current elevation. </dd></dl>
</div>
</div>
<a id="a06b2b93c8f2c5a0eac0a8a2411944dd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06b2b93c8f2c5a0eac0a8a2411944dd2">◆ </a></span>getVolume()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Source::getVolume </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the current volume value based on the distance. </p>
<dl class="section return"><dt>Returns</dt><dd>The current volume based on the Distance. </dd></dl>
</div>
</div>
<a id="a19bc20c45c6d76aeeee520bfb2492616"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19bc20c45c6d76aeeee520bfb2492616">◆ </a></span>setAzimuth()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Source::setAzimuth </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>azimuth</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the azimuth value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">azimuth</td><td>The new value for the azimuth. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a58ddbee91bc1af52d22d08664bd936d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58ddbee91bc1af52d22d08664bd936d9">◆ </a></span>setDistance()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Source::setDistance </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>distance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the distance value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">distance</td><td>The new value for the distance. Max distance is 1, min distance is 0. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1017f4bc2640c5f5ed2c8a13308584de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1017f4bc2640c5f5ed2c8a13308584de">◆ </a></span>setElevation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Source::setElevation </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>elevation</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the elevation value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">elevation</td><td>The new value for the elevation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fx/<a class="el" href="Source_8h_source.html">Source.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
4f48f620eaa1d8b8f904a92a0540d40f
>
files
>
1314
