<!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: I3DHandle Interface 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="classI3DHandle-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">I3DHandle Interface Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classI3DHandle.html" title="The I3DHandle interface represents a playback handle for 3D sources.">I3DHandle</a> interface represents a playback handle for 3D sources.
<a href="classI3DHandle.html#details">More...</a></p>
<p><code>#include <<a class="el" href="I3DHandle_8h_source.html">I3DHandle.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for I3DHandle:</div>
<div class="dyncontent">
<div class="center"><img src="classI3DHandle__inherit__graph.png" border="0" usemap="#I3DHandle_inherit__map" alt="Inheritance graph"/></div>
<map name="I3DHandle_inherit__map" id="I3DHandle_inherit__map">
<area shape="rect" title="The I3DHandle interface represents a playback handle for 3D sources." alt="" coords="51,5,139,32"/>
<area shape="rect" href="classSoftwareDevice_1_1SoftwareHandle.html" title="Saves the data for playback." alt="" coords="5,80,184,121"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a46b731c14a3dce70536eca93b91fa754"><td class="memItemLeft" align="right" valign="top"><a id="a46b731c14a3dce70536eca93b91fa754"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a46b731c14a3dce70536eca93b91fa754">~I3DHandle</a> ()</td></tr>
<tr class="memdesc:a46b731c14a3dce70536eca93b91fa754"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the handle. <br /></td></tr>
<tr class="separator:a46b731c14a3dce70536eca93b91fa754"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81f9b783e07e9a72b40d4b9b88480682"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVector3.html">Vector3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a81f9b783e07e9a72b40d4b9b88480682">getLocation</a> ()=0</td></tr>
<tr class="memdesc:a81f9b783e07e9a72b40d4b9b88480682"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the location of the source. <a href="#a81f9b783e07e9a72b40d4b9b88480682">More...</a><br /></td></tr>
<tr class="separator:a81f9b783e07e9a72b40d4b9b88480682"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5edc8bc2c64f8c867c90e9b76e1f8491"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a5edc8bc2c64f8c867c90e9b76e1f8491">setLocation</a> (const <a class="el" href="classVector3.html">Vector3</a> &location)=0</td></tr>
<tr class="memdesc:a5edc8bc2c64f8c867c90e9b76e1f8491"><td class="mdescLeft"> </td><td class="mdescRight">Sets the location of the source. <a href="#a5edc8bc2c64f8c867c90e9b76e1f8491">More...</a><br /></td></tr>
<tr class="separator:a5edc8bc2c64f8c867c90e9b76e1f8491"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e5068227872fe465de3ac38f1547f69"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVector3.html">Vector3</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a1e5068227872fe465de3ac38f1547f69">getVelocity</a> ()=0</td></tr>
<tr class="memdesc:a1e5068227872fe465de3ac38f1547f69"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the velocity of the source. <a href="#a1e5068227872fe465de3ac38f1547f69">More...</a><br /></td></tr>
<tr class="separator:a1e5068227872fe465de3ac38f1547f69"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7a472f61f3f945fa004fef58eb5a5e9"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#ae7a472f61f3f945fa004fef58eb5a5e9">setVelocity</a> (const <a class="el" href="classVector3.html">Vector3</a> &velocity)=0</td></tr>
<tr class="memdesc:ae7a472f61f3f945fa004fef58eb5a5e9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the velocity of the source. <a href="#ae7a472f61f3f945fa004fef58eb5a5e9">More...</a><br /></td></tr>
<tr class="separator:ae7a472f61f3f945fa004fef58eb5a5e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9485f7d76a55806fe8c80f1d21e163bb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classQuaternion.html">Quaternion</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a9485f7d76a55806fe8c80f1d21e163bb">getOrientation</a> ()=0</td></tr>
<tr class="memdesc:a9485f7d76a55806fe8c80f1d21e163bb"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the orientation of the source. <a href="#a9485f7d76a55806fe8c80f1d21e163bb">More...</a><br /></td></tr>
<tr class="separator:a9485f7d76a55806fe8c80f1d21e163bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5a259026e9959fb0bd2ddda701711365"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a5a259026e9959fb0bd2ddda701711365">setOrientation</a> (const <a class="el" href="classQuaternion.html">Quaternion</a> &orientation)=0</td></tr>
<tr class="memdesc:a5a259026e9959fb0bd2ddda701711365"><td class="mdescLeft"> </td><td class="mdescRight">Sets the orientation of the source. <a href="#a5a259026e9959fb0bd2ddda701711365">More...</a><br /></td></tr>
<tr class="separator:a5a259026e9959fb0bd2ddda701711365"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a16d8b359497163c3a539c200f62391e3"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a16d8b359497163c3a539c200f62391e3">isRelative</a> ()=0</td></tr>
<tr class="memdesc:a16d8b359497163c3a539c200f62391e3"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the source location, velocity and orientation are relative to the listener. <a href="#a16d8b359497163c3a539c200f62391e3">More...</a><br /></td></tr>
<tr class="separator:a16d8b359497163c3a539c200f62391e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6636735a3e7e365322bba67760d8793a"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a6636735a3e7e365322bba67760d8793a">setRelative</a> (bool relative)=0</td></tr>
<tr class="memdesc:a6636735a3e7e365322bba67760d8793a"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the source location, velocity and orientation are relative to the listener. <a href="#a6636735a3e7e365322bba67760d8793a">More...</a><br /></td></tr>
<tr class="separator:a6636735a3e7e365322bba67760d8793a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f19f9e6ca489f80548ff137825dab3c"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a8f19f9e6ca489f80548ff137825dab3c">getVolumeMaximum</a> ()=0</td></tr>
<tr class="memdesc:a8f19f9e6ca489f80548ff137825dab3c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the maximum volume of a source. <a href="#a8f19f9e6ca489f80548ff137825dab3c">More...</a><br /></td></tr>
<tr class="separator:a8f19f9e6ca489f80548ff137825dab3c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c80f5b082be3a71c48260e1eeac8d24"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a3c80f5b082be3a71c48260e1eeac8d24">setVolumeMaximum</a> (float volume)=0</td></tr>
<tr class="memdesc:a3c80f5b082be3a71c48260e1eeac8d24"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum volume of a source. <a href="#a3c80f5b082be3a71c48260e1eeac8d24">More...</a><br /></td></tr>
<tr class="separator:a3c80f5b082be3a71c48260e1eeac8d24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76c9219f7bd58f309c5bfe4f0ee31cb3"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a76c9219f7bd58f309c5bfe4f0ee31cb3">getVolumeMinimum</a> ()=0</td></tr>
<tr class="memdesc:a76c9219f7bd58f309c5bfe4f0ee31cb3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the minimum volume of a source. <a href="#a76c9219f7bd58f309c5bfe4f0ee31cb3">More...</a><br /></td></tr>
<tr class="separator:a76c9219f7bd58f309c5bfe4f0ee31cb3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a255b5eff3d6a1da10108c5126f6f13ab"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a255b5eff3d6a1da10108c5126f6f13ab">setVolumeMinimum</a> (float volume)=0</td></tr>
<tr class="memdesc:a255b5eff3d6a1da10108c5126f6f13ab"><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum volume of a source. <a href="#a255b5eff3d6a1da10108c5126f6f13ab">More...</a><br /></td></tr>
<tr class="separator:a255b5eff3d6a1da10108c5126f6f13ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acef6b54740731fb278aa787d2665a7a2"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#acef6b54740731fb278aa787d2665a7a2">getDistanceMaximum</a> ()=0</td></tr>
<tr class="memdesc:acef6b54740731fb278aa787d2665a7a2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the maximum distance of a source. <a href="#acef6b54740731fb278aa787d2665a7a2">More...</a><br /></td></tr>
<tr class="separator:acef6b54740731fb278aa787d2665a7a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f6052f088453b89b78e66dc434a1bed"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a5f6052f088453b89b78e66dc434a1bed">setDistanceMaximum</a> (float distance)=0</td></tr>
<tr class="memdesc:a5f6052f088453b89b78e66dc434a1bed"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum distance of a source. <a href="#a5f6052f088453b89b78e66dc434a1bed">More...</a><br /></td></tr>
<tr class="separator:a5f6052f088453b89b78e66dc434a1bed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb34a56d349f172cd9727eaa8b24571c"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#acb34a56d349f172cd9727eaa8b24571c">getDistanceReference</a> ()=0</td></tr>
<tr class="memdesc:acb34a56d349f172cd9727eaa8b24571c"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reference distance of a source. <a href="#acb34a56d349f172cd9727eaa8b24571c">More...</a><br /></td></tr>
<tr class="separator:acb34a56d349f172cd9727eaa8b24571c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d0873d1a9c8906886d47118e818050e"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a8d0873d1a9c8906886d47118e818050e">setDistanceReference</a> (float distance)=0</td></tr>
<tr class="memdesc:a8d0873d1a9c8906886d47118e818050e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the reference distance of a source. <a href="#a8d0873d1a9c8906886d47118e818050e">More...</a><br /></td></tr>
<tr class="separator:a8d0873d1a9c8906886d47118e818050e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad9a234df224260d9b88021304d0a768a"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#ad9a234df224260d9b88021304d0a768a">getAttenuation</a> ()=0</td></tr>
<tr class="memdesc:ad9a234df224260d9b88021304d0a768a"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the attenuation of a source. <a href="#ad9a234df224260d9b88021304d0a768a">More...</a><br /></td></tr>
<tr class="separator:ad9a234df224260d9b88021304d0a768a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39b003fda524169c1748b06c880980db"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a39b003fda524169c1748b06c880980db">setAttenuation</a> (float factor)=0</td></tr>
<tr class="memdesc:a39b003fda524169c1748b06c880980db"><td class="mdescLeft"> </td><td class="mdescRight">Sets the attenuation of a source. <a href="#a39b003fda524169c1748b06c880980db">More...</a><br /></td></tr>
<tr class="separator:a39b003fda524169c1748b06c880980db"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa3b3d0809e79392ffb9708581f6661d3"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#aa3b3d0809e79392ffb9708581f6661d3">getConeAngleOuter</a> ()=0</td></tr>
<tr class="memdesc:aa3b3d0809e79392ffb9708581f6661d3"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the outer opening angle of the cone of a source. <a href="#aa3b3d0809e79392ffb9708581f6661d3">More...</a><br /></td></tr>
<tr class="separator:aa3b3d0809e79392ffb9708581f6661d3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8fc726e7c169975c6e3e9e8f8d5a2d7b"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a8fc726e7c169975c6e3e9e8f8d5a2d7b">setConeAngleOuter</a> (float angle)=0</td></tr>
<tr class="memdesc:a8fc726e7c169975c6e3e9e8f8d5a2d7b"><td class="mdescLeft"> </td><td class="mdescRight">Sets the outer opening angle of the cone of a source. <a href="#a8fc726e7c169975c6e3e9e8f8d5a2d7b">More...</a><br /></td></tr>
<tr class="separator:a8fc726e7c169975c6e3e9e8f8d5a2d7b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4aefb97f667fd50d96c5ceb4f7826b97"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a4aefb97f667fd50d96c5ceb4f7826b97">getConeAngleInner</a> ()=0</td></tr>
<tr class="memdesc:a4aefb97f667fd50d96c5ceb4f7826b97"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the inner opening angle of the cone of a source. <a href="#a4aefb97f667fd50d96c5ceb4f7826b97">More...</a><br /></td></tr>
<tr class="separator:a4aefb97f667fd50d96c5ceb4f7826b97"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afef104a4745424c7640d355750470e41"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#afef104a4745424c7640d355750470e41">setConeAngleInner</a> (float angle)=0</td></tr>
<tr class="memdesc:afef104a4745424c7640d355750470e41"><td class="mdescLeft"> </td><td class="mdescRight">Sets the inner opening angle of the cone of a source. <a href="#afef104a4745424c7640d355750470e41">More...</a><br /></td></tr>
<tr class="separator:afef104a4745424c7640d355750470e41"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa9a28ab1d5aa35aea17bedfa601c5e4b"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#aa9a28ab1d5aa35aea17bedfa601c5e4b">getConeVolumeOuter</a> ()=0</td></tr>
<tr class="memdesc:aa9a28ab1d5aa35aea17bedfa601c5e4b"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the outer volume of the cone of a source. <a href="#aa9a28ab1d5aa35aea17bedfa601c5e4b">More...</a><br /></td></tr>
<tr class="separator:aa9a28ab1d5aa35aea17bedfa601c5e4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8abaaaf6fb9cb57b34f27bd3b36e8fac"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classI3DHandle.html#a8abaaaf6fb9cb57b34f27bd3b36e8fac">setConeVolumeOuter</a> (float volume)=0</td></tr>
<tr class="memdesc:a8abaaaf6fb9cb57b34f27bd3b36e8fac"><td class="mdescLeft"> </td><td class="mdescRight">Sets the outer volume of the cone of a source. <a href="#a8abaaaf6fb9cb57b34f27bd3b36e8fac">More...</a><br /></td></tr>
<tr class="separator:a8abaaaf6fb9cb57b34f27bd3b36e8fac"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classI3DHandle.html" title="The I3DHandle interface represents a playback handle for 3D sources.">I3DHandle</a> interface represents a playback handle for 3D sources. </p>
<p>If the playback <a class="el" href="classIDevice.html" title="The IDevice interface represents an output device for sound sources.">IDevice</a> class also implements the <a class="el" href="classI3DDevice.html" title="The I3DDevice interface represents an output device for 3D sound.">I3DDevice</a> interface then all playback <a class="el" href="classIHandle.html" title="The IHandle interface represents a playback handles of a specific device.">IHandle</a> instances also implement this interface.</p>
<p>The interface has been modelled after the OpenAL 1.1 API, see the <a href="http://openal.org/">OpenAL Specification</a> for lots of details. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad9a234df224260d9b88021304d0a768a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad9a234df224260d9b88021304d0a768a">◆ </a></span>getAttenuation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getAttenuation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the attenuation of a source. </p>
<dl class="section return"><dt>Returns</dt><dd>The attenuation. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#ab6bc10cb26de9bb6df47f86a44697310">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a4aefb97f667fd50d96c5ceb4f7826b97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aefb97f667fd50d96c5ceb4f7826b97">◆ </a></span>getConeAngleInner()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getConeAngleInner </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the inner opening angle of the cone of a source. </p>
<p>The volume inside this cone is unaltered. </p><dl class="section return"><dt>Returns</dt><dd>The inner angle of the cone. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This angle is defined in degrees. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#afe101e28e0dbb171d0b5aa714852fad1">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="aa3b3d0809e79392ffb9708581f6661d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3b3d0809e79392ffb9708581f6661d3">◆ </a></span>getConeAngleOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getConeAngleOuter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the outer opening angle of the cone of a source. </p>
<dl class="section return"><dt>Returns</dt><dd>The outer angle of the cone. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This angle is defined in degrees. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#aeb55f5e3c7584abd0ab1b3333fad728c">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="aa9a28ab1d5aa35aea17bedfa601c5e4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9a28ab1d5aa35aea17bedfa601c5e4b">◆ </a></span>getConeVolumeOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getConeVolumeOuter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the outer volume of the cone of a source. </p>
<p>The volume between inner and outer angle is interpolated between inner volume and this value. </p><dl class="section return"><dt>Returns</dt><dd>The outer volume of the cone. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The general volume of the handle still applies on top of this. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#aa4b5e1219fe7b84e1a28a8f823abb636">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="acef6b54740731fb278aa787d2665a7a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acef6b54740731fb278aa787d2665a7a2">◆ </a></span>getDistanceMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getDistanceMaximum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the maximum distance of a source. </p>
<p>If a source is further away from the reader than this distance, the volume will automatically be set to 0. </p><dl class="section return"><dt>Returns</dt><dd>The maximum distance. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#acf8ce100ce66dc788c51f08924f5225b">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="acb34a56d349f172cd9727eaa8b24571c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb34a56d349f172cd9727eaa8b24571c">◆ </a></span>getDistanceReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getDistanceReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the reference distance of a source. </p>
<dl class="section return"><dt>Returns</dt><dd>The reference distance. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#af6250192d21077ff4025d897681c8e00">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a81f9b783e07e9a72b40d4b9b88480682"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81f9b783e07e9a72b40d4b9b88480682">◆ </a></span>getLocation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classVector3.html">Vector3</a> I3DHandle::getLocation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the location of the source. </p>
<dl class="section return"><dt>Returns</dt><dd>The location. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a9100e645a6443a0834e7beb1009a076f">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a9485f7d76a55806fe8c80f1d21e163bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9485f7d76a55806fe8c80f1d21e163bb">◆ </a></span>getOrientation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classQuaternion.html">Quaternion</a> I3DHandle::getOrientation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the orientation of the source. </p>
<dl class="section return"><dt>Returns</dt><dd>The orientation as quaternion. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#aa2b856e109460c8b011514d3a460d71c">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a1e5068227872fe465de3ac38f1547f69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e5068227872fe465de3ac38f1547f69">◆ </a></span>getVelocity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classVector3.html">Vector3</a> I3DHandle::getVelocity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the velocity of the source. </p>
<dl class="section return"><dt>Returns</dt><dd>The velocity. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#acfae64c076cebe8c0c94c8918768e2c1">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a8f19f9e6ca489f80548ff137825dab3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f19f9e6ca489f80548ff137825dab3c">◆ </a></span>getVolumeMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getVolumeMaximum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the maximum volume of a source. </p>
<dl class="section return"><dt>Returns</dt><dd>The maximum volume. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a6ccedcfdce0cda78c18f18fae7ac278a">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a76c9219f7bd58f309c5bfe4f0ee31cb3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76c9219f7bd58f309c5bfe4f0ee31cb3">◆ </a></span>getVolumeMinimum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual float I3DHandle::getVolumeMinimum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the minimum volume of a source. </p>
<dl class="section return"><dt>Returns</dt><dd>The minimum volume. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a1acab1e6bf180dd2704880b73752a964">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a16d8b359497163c3a539c200f62391e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16d8b359497163c3a539c200f62391e3">◆ </a></span>isRelative()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::isRelative </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether the source location, velocity and orientation are relative to the listener. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the source is relative. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a057cb8546ccdf1941f7aa52938b6633d">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a39b003fda524169c1748b06c880980db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39b003fda524169c1748b06c880980db">◆ </a></span>setAttenuation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setAttenuation </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the attenuation of a source. </p>
<p>This value is used for distance calculation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">factor</td><td>The new attenuation. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a958a043210712b9a12c0bd5bda534e5d">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="afef104a4745424c7640d355750470e41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afef104a4745424c7640d355750470e41">◆ </a></span>setConeAngleInner()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setConeAngleInner </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the inner opening angle of the cone of a source. </p>
<p>The volume inside this cone is unaltered. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">angle</td><td>The new inner angle of the cone. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This angle is defined in degrees. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a700325d51b84a4240c283d77f8487276">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a8fc726e7c169975c6e3e9e8f8d5a2d7b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fc726e7c169975c6e3e9e8f8d5a2d7b">◆ </a></span>setConeAngleOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setConeAngleOuter </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the outer opening angle of the cone of a source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">angle</td><td>The new outer angle of the cone. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This angle is defined in degrees. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a6b4b7aa1cfb5b335fe109a251742c898">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a8abaaaf6fb9cb57b34f27bd3b36e8fac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8abaaaf6fb9cb57b34f27bd3b36e8fac">◆ </a></span>setConeVolumeOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setConeVolumeOuter </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the outer volume of the cone of a source. </p>
<p>The volume between inner and outer angle is interpolated between inner volume and this value. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">volume</td><td>The new outer volume of the cone. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The general volume of the handle still applies on top of this. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#acc54b026c7a557e7698a6a1a591588bb">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a5f6052f088453b89b78e66dc434a1bed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f6052f088453b89b78e66dc434a1bed">◆ </a></span>setDistanceMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setDistanceMaximum </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>distance</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the maximum distance of a source. </p>
<p>If a source is further away from the reader than this distance, the volume will automatically be set to 0. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">distance</td><td>The new maximum distance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a8c4c94c4d36c4dfbd92a46c0c949acd0">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a8d0873d1a9c8906886d47118e818050e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d0873d1a9c8906886d47118e818050e">◆ </a></span>setDistanceReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setDistanceReference </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>distance</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the reference distance of a source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">distance</td><td>The new reference distance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a92d3c5b5b92975c2f7b62ab27ef6a217">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a5edc8bc2c64f8c867c90e9b76e1f8491"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5edc8bc2c64f8c867c90e9b76e1f8491">◆ </a></span>setLocation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setLocation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classVector3.html">Vector3</a> & </td>
<td class="paramname"><em>location</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the location of the source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">location</td><td>The new location. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The location is not updated with the velocity and remains constant until the next call of this method. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a1a360896458cbc00cc5e4e9e6fd0a5ce">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a5a259026e9959fb0bd2ddda701711365"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a259026e9959fb0bd2ddda701711365">◆ </a></span>setOrientation()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setOrientation </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classQuaternion.html">Quaternion</a> & </td>
<td class="paramname"><em>orientation</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the orientation of the source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">orientation</td><td>The new orientation as quaternion. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The coordinate system used is right handed and the source by default is oriented looking in the negative z direction with the positive y axis as up direction. </dd>
<dd>
This setting currently only affects sounds with non-default cone settings. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a981613fc07c5eb503f9d257f8ec157b1">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a6636735a3e7e365322bba67760d8793a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6636735a3e7e365322bba67760d8793a">◆ </a></span>setRelative()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setRelative </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>relative</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets whether the source location, velocity and orientation are relative to the listener. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">relative</td><td>Whether the source is relative. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>The default value is true as this setting is used to play sounds ordinarily without 3D. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a96ca029e91cb73b7026aed8e74abbfa9">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="ae7a472f61f3f945fa004fef58eb5a5e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7a472f61f3f945fa004fef58eb5a5e9">◆ </a></span>setVelocity()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setVelocity </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classVector3.html">Vector3</a> & </td>
<td class="paramname"><em>velocity</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the velocity of the source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">velocity</td><td>The new velocity. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This velocity does not change the position of the listener over time, it is simply used for the calculation of the doppler effect. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a8969d13ef4a0fdc6aee98467ca3a7944">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a3c80f5b082be3a71c48260e1eeac8d24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c80f5b082be3a71c48260e1eeac8d24">◆ </a></span>setVolumeMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setVolumeMaximum </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the maximum volume of a source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">volume</td><td>The new maximum volume. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#a0e78f15a935c0c1464a63dcd4daae383">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<a id="a255b5eff3d6a1da10108c5126f6f13ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a255b5eff3d6a1da10108c5126f6f13ab">◆ </a></span>setVolumeMinimum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool I3DHandle::setVolumeMinimum </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the minimum volume of a source. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">volume</td><td>The new minimum volume. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
<p>Implemented in <a class="el" href="classSoftwareDevice_1_1SoftwareHandle.html#aa83cf1d1c60492228dd9f70b01fb92a9">SoftwareDevice::SoftwareHandle</a>.</p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>devices/<a class="el" href="I3DHandle_8h_source.html">I3DHandle.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
>
1030
