<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdeclarative_attenuationmodel_p.cpp -->
<title>AttenuationModelInverse QML Type | Qt Multimedia 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtmultimedia-index.html">Qt Multimedia</a></td><td ><a href="qtmultimedia-qmlmodule.html">QML Types</a></td><td >AttenuationModelInverse QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">AttenuationModelInverse QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AttenuationModelInverse-brief -->
<p>Defines a non-linear attenuation curve for a <a href="qml-qtaudioengine-sound.html">Sound</a>. <a href="#details">More...</a></p>
<!-- @@@AttenuationModelInverse -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtAudioEngine 1.1</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.0</td></tr></table></div><ul>
<li><a href="qml-qtaudioengine-attenuationmodelinverse-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtaudioengine-attenuationmodelinverse.html#end-prop">end</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-attenuationmodelinverse.html#name-prop">name</a></b></b> : string</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-attenuationmodelinverse.html#rolloff-prop">rolloff</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtaudioengine-attenuationmodelinverse.html#start-prop">start</a></b></b> : real</li>
</ul>
<!-- $$$AttenuationModelInverse-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qtaudioengine-attenuationmodelinverse.html">AttenuationModelInverse</a> must be defined inside <a href="qml-qtaudioengine-audioengine.html">AudioEngine</a> or be added to it using <a href="qml-qtaudioengine-audioengine.html#addAttenuationModel-method">AudioEngine.addAttenuationModel()</a> if <a href="qml-qtaudioengine-attenuationmodelinverse.html">AttenuationModelInverse</a> is created dynamically.</p>
<pre class="qml">
<span class="type">Rectangle</span> {
<span class="name">color</span>:<span class="string">"white"</span>
<span class="name">width</span>: <span class="number">300</span>
<span class="name">height</span>: <span class="number">500</span>
<span class="type"><a href="qml-qtaudioengine-audioengine.html">AudioEngine</a></span> {
<span class="name">id</span>:<span class="name">audioengine</span>
<span class="type"><a href="qml-qtaudioengine-attenuationmodelinverse.html">AttenuationModelInverse</a></span> {
<span class="name">name</span>:<span class="string">"linear"</span>
<span class="name">start</span>: <span class="number">20</span>
<span class="name">end</span>: <span class="number">500</span>
<span class="name">rolloff</span>: <span class="number">1.5</span>
}
<span class="type"><a href="qml-qtaudioengine-audiosample.html">AudioSample</a></span> {
<span class="name">name</span>:<span class="string">"explosion"</span>
<span class="name">source</span>: <span class="string">"explosion-02.wav"</span>
}
<span class="type"><a href="qml-qtaudioengine-sound.html">Sound</a></span> {
<span class="name">name</span>:<span class="string">"explosion"</span>
<span class="name">attenuationModel</span>: <span class="string">"linear"</span>
<span class="type"><a href="qml-qtaudioengine-playvariation.html">PlayVariation</a></span> {
<span class="name">sample</span>:<span class="string">"explosion"</span>
}
}
}
}
</pre>
<p>Attenuation factor is calculated as below:</p>
<p>distance: distance from sound to listener d = min(max(distance, start), end); attenuation = start / (start + (d - start) * rolloff);</p>
<!-- @@@AttenuationModelInverse -->
<h2>Property Documentation</h2>
<!-- $$$end -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="end-prop">
<td class="tblQmlPropNode"><p>
<a name="end-prop"></a><span class="name">end</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the end distance. There will be no further attenuation if the distance from sound to listener is larger than this. The default value is 1000.</p>
</div></div><!-- @@@end -->
<br/>
<!-- $$$name -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="name-prop">
<td class="tblQmlPropNode"><p>
<a name="name-prop"></a><span class="name">name</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the name of <a href="qml-qtaudioengine-attenuationmodelinverse.html">AttenuationModelInverse</a>, must be unique among all attenuation models and only defined once.</p>
</div></div><!-- @@@name -->
<br/>
<!-- $$$rolloff -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="rolloff-prop">
<td class="tblQmlPropNode"><p>
<a name="rolloff-prop"></a><span class="name">rolloff</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the rolloff factor. The bigger the value is, the faster the sound attenuates. The default value is 1.</p>
</div></div><!-- @@@rolloff -->
<br/>
<!-- $$$start -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="start-prop">
<td class="tblQmlPropNode"><p>
<a name="start-prop"></a><span class="name">start</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the start distance. There will be no attenuation if the distance from sound to listener is within this range. The default value is 1.</p>
</div></div><!-- @@@start -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
