<!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: SequenceEntry 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="#friends">Friends</a> |
<a href="classSequenceEntry-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SequenceEntry Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class represents a sequenced entry in a sequencer sound.
<a href="classSequenceEntry.html#details">More...</a></p>
<p><code>#include <<a class="el" href="SequenceEntry_8h_source.html">SequenceEntry.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for SequenceEntry:</div>
<div class="dyncontent">
<div class="center"><img src="classSequenceEntry__inherit__graph.png" border="0" usemap="#SequenceEntry_inherit__map" alt="Inheritance graph"/></div>
<map name="SequenceEntry_inherit__map" id="SequenceEntry_inherit__map">
<area shape="rect" title="This class represents a sequenced entry in a sequencer sound." alt="" coords="5,80,117,107"/>
<area shape="rect" href="classILockable.html" title="This class provides an interface for lockable objects." alt="" coords="21,5,101,32"/>
</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:a8cd69efe2ada2a0dc64ba74b76600fed"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a8cd69efe2ada2a0dc64ba74b76600fed">SequenceEntry</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, float begin, float end, float skip, int id)</td></tr>
<tr class="memdesc:a8cd69efe2ada2a0dc64ba74b76600fed"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new sequenced entry. <a href="#a8cd69efe2ada2a0dc64ba74b76600fed">More...</a><br /></td></tr>
<tr class="separator:a8cd69efe2ada2a0dc64ba74b76600fed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7ef27bc841dccac2833afaa3b1f15bca"><td class="memItemLeft" align="right" valign="top"><a id="a7ef27bc841dccac2833afaa3b1f15bca"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a7ef27bc841dccac2833afaa3b1f15bca">lock</a> ()</td></tr>
<tr class="memdesc:a7ef27bc841dccac2833afaa3b1f15bca"><td class="mdescLeft"> </td><td class="mdescRight">Locks the entry. <br /></td></tr>
<tr class="separator:a7ef27bc841dccac2833afaa3b1f15bca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afe06fbf7ee50c6b960c9308c2732f48d"><td class="memItemLeft" align="right" valign="top"><a id="afe06fbf7ee50c6b960c9308c2732f48d"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#afe06fbf7ee50c6b960c9308c2732f48d">unlock</a> ()</td></tr>
<tr class="memdesc:afe06fbf7ee50c6b960c9308c2732f48d"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the previously locked entry. <br /></td></tr>
<tr class="separator:afe06fbf7ee50c6b960c9308c2732f48d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22d453190582daeaa143b90ad3c5e4b6"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a22d453190582daeaa143b90ad3c5e4b6">getSound</a> ()</td></tr>
<tr class="memdesc:a22d453190582daeaa143b90ad3c5e4b6"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the sound of the entry. <a href="#a22d453190582daeaa143b90ad3c5e4b6">More...</a><br /></td></tr>
<tr class="separator:a22d453190582daeaa143b90ad3c5e4b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6bbd9d712f64554af3b63c97841ffe71"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a6bbd9d712f64554af3b63c97841ffe71">setSound</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound)</td></tr>
<tr class="memdesc:a6bbd9d712f64554af3b63c97841ffe71"><td class="mdescLeft"> </td><td class="mdescRight">Sets the sound of the entry. <a href="#a6bbd9d712f64554af3b63c97841ffe71">More...</a><br /></td></tr>
<tr class="separator:a6bbd9d712f64554af3b63c97841ffe71"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e34ea5ff5bd21f0db868737456e51a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a0e34ea5ff5bd21f0db868737456e51a8">move</a> (float begin, float end, float skip)</td></tr>
<tr class="memdesc:a0e34ea5ff5bd21f0db868737456e51a8"><td class="mdescLeft"> </td><td class="mdescRight">Moves the entry. <a href="#a0e34ea5ff5bd21f0db868737456e51a8">More...</a><br /></td></tr>
<tr class="separator:a0e34ea5ff5bd21f0db868737456e51a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb9b2fe434b17f45875ed732d4d8f093"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#acb9b2fe434b17f45875ed732d4d8f093">isMuted</a> ()</td></tr>
<tr class="memdesc:acb9b2fe434b17f45875ed732d4d8f093"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the muting state of the entry. <a href="#acb9b2fe434b17f45875ed732d4d8f093">More...</a><br /></td></tr>
<tr class="separator:acb9b2fe434b17f45875ed732d4d8f093"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadefb4274c327a0d576cd0c6d55ad56d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#aadefb4274c327a0d576cd0c6d55ad56d">mute</a> (bool mute)</td></tr>
<tr class="memdesc:aadefb4274c327a0d576cd0c6d55ad56d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the muting state of the entry. <a href="#aadefb4274c327a0d576cd0c6d55ad56d">More...</a><br /></td></tr>
<tr class="separator:aadefb4274c327a0d576cd0c6d55ad56d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a14ab28477b45c8974d4e620a73cbacce"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a14ab28477b45c8974d4e620a73cbacce">getID</a> () const</td></tr>
<tr class="memdesc:a14ab28477b45c8974d4e620a73cbacce"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the ID of the entry. <a href="#a14ab28477b45c8974d4e620a73cbacce">More...</a><br /></td></tr>
<tr class="separator:a14ab28477b45c8974d4e620a73cbacce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0632c2e441c2c63ae6418f33175a8119"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAnimateableProperty.html">AnimateableProperty</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a0632c2e441c2c63ae6418f33175a8119">getAnimProperty</a> (<a class="el" href="AnimateableProperty_8h.html#a88fcbc9d6d48a9832cc327f0b39cbec9">AnimateablePropertyType</a> type)</td></tr>
<tr class="memdesc:a0632c2e441c2c63ae6418f33175a8119"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves one of the animated properties of the entry. <a href="#a0632c2e441c2c63ae6418f33175a8119">More...</a><br /></td></tr>
<tr class="separator:a0632c2e441c2c63ae6418f33175a8119"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52352c73330f3aca274cbd9321edd27d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a52352c73330f3aca274cbd9321edd27d">isRelative</a> ()</td></tr>
<tr class="memdesc:a52352c73330f3aca274cbd9321edd27d"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether the source location, velocity and orientation are relative to the listener. <a href="#a52352c73330f3aca274cbd9321edd27d">More...</a><br /></td></tr>
<tr class="separator:a52352c73330f3aca274cbd9321edd27d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add3c78ba9d9065c627596d1f142e326b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#add3c78ba9d9065c627596d1f142e326b">setRelative</a> (bool relative)</td></tr>
<tr class="memdesc:add3c78ba9d9065c627596d1f142e326b"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the source location, velocity and orientation are relative to the listener. <a href="#add3c78ba9d9065c627596d1f142e326b">More...</a><br /></td></tr>
<tr class="separator:add3c78ba9d9065c627596d1f142e326b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15fe8f58549facf1ff6d611ade960d9f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a15fe8f58549facf1ff6d611ade960d9f">getVolumeMaximum</a> ()</td></tr>
<tr class="memdesc:a15fe8f58549facf1ff6d611ade960d9f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the maximum volume of a source. <a href="#a15fe8f58549facf1ff6d611ade960d9f">More...</a><br /></td></tr>
<tr class="separator:a15fe8f58549facf1ff6d611ade960d9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8aaa5e88aa98da71cf4298c16bac76f4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a8aaa5e88aa98da71cf4298c16bac76f4">setVolumeMaximum</a> (float volume)</td></tr>
<tr class="memdesc:a8aaa5e88aa98da71cf4298c16bac76f4"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum volume of a source. <a href="#a8aaa5e88aa98da71cf4298c16bac76f4">More...</a><br /></td></tr>
<tr class="separator:a8aaa5e88aa98da71cf4298c16bac76f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b74e769d28a593a42434fed1a5804bd"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a5b74e769d28a593a42434fed1a5804bd">getVolumeMinimum</a> ()</td></tr>
<tr class="memdesc:a5b74e769d28a593a42434fed1a5804bd"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the minimum volume of a source. <a href="#a5b74e769d28a593a42434fed1a5804bd">More...</a><br /></td></tr>
<tr class="separator:a5b74e769d28a593a42434fed1a5804bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a192bc273eef96617aa37c250d42ca52f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a192bc273eef96617aa37c250d42ca52f">setVolumeMinimum</a> (float volume)</td></tr>
<tr class="memdesc:a192bc273eef96617aa37c250d42ca52f"><td class="mdescLeft"> </td><td class="mdescRight">Sets the minimum volume of a source. <a href="#a192bc273eef96617aa37c250d42ca52f">More...</a><br /></td></tr>
<tr class="separator:a192bc273eef96617aa37c250d42ca52f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0764411c22c61dc335a40c51410cb446"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a0764411c22c61dc335a40c51410cb446">getDistanceMaximum</a> ()</td></tr>
<tr class="memdesc:a0764411c22c61dc335a40c51410cb446"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the maximum distance of a source. <a href="#a0764411c22c61dc335a40c51410cb446">More...</a><br /></td></tr>
<tr class="separator:a0764411c22c61dc335a40c51410cb446"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af683b6db01650d8a60a6980e1e933e05"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#af683b6db01650d8a60a6980e1e933e05">setDistanceMaximum</a> (float distance)</td></tr>
<tr class="memdesc:af683b6db01650d8a60a6980e1e933e05"><td class="mdescLeft"> </td><td class="mdescRight">Sets the maximum distance of a source. <a href="#af683b6db01650d8a60a6980e1e933e05">More...</a><br /></td></tr>
<tr class="separator:af683b6db01650d8a60a6980e1e933e05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ba33ce17f9317973521698fb5bc3071"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a5ba33ce17f9317973521698fb5bc3071">getDistanceReference</a> ()</td></tr>
<tr class="memdesc:a5ba33ce17f9317973521698fb5bc3071"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the reference distance of a source. <a href="#a5ba33ce17f9317973521698fb5bc3071">More...</a><br /></td></tr>
<tr class="separator:a5ba33ce17f9317973521698fb5bc3071"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a20cdbdf3573d10ecd661169e41e4d600"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a20cdbdf3573d10ecd661169e41e4d600">setDistanceReference</a> (float distance)</td></tr>
<tr class="memdesc:a20cdbdf3573d10ecd661169e41e4d600"><td class="mdescLeft"> </td><td class="mdescRight">Sets the reference distance of a source. <a href="#a20cdbdf3573d10ecd661169e41e4d600">More...</a><br /></td></tr>
<tr class="separator:a20cdbdf3573d10ecd661169e41e4d600"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac2c7de58fa88bb752a1dc8768d635e30"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#ac2c7de58fa88bb752a1dc8768d635e30">getAttenuation</a> ()</td></tr>
<tr class="memdesc:ac2c7de58fa88bb752a1dc8768d635e30"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the attenuation of a source. <a href="#ac2c7de58fa88bb752a1dc8768d635e30">More...</a><br /></td></tr>
<tr class="separator:ac2c7de58fa88bb752a1dc8768d635e30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84645431d5f905f4fdfd852304b5bbd0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a84645431d5f905f4fdfd852304b5bbd0">setAttenuation</a> (float factor)</td></tr>
<tr class="memdesc:a84645431d5f905f4fdfd852304b5bbd0"><td class="mdescLeft"> </td><td class="mdescRight">Sets the attenuation of a source. <a href="#a84645431d5f905f4fdfd852304b5bbd0">More...</a><br /></td></tr>
<tr class="separator:a84645431d5f905f4fdfd852304b5bbd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8180f5d204e4a0917eab50910553f974"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a8180f5d204e4a0917eab50910553f974">getConeAngleOuter</a> ()</td></tr>
<tr class="memdesc:a8180f5d204e4a0917eab50910553f974"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the outer angle of the cone of a source. <a href="#a8180f5d204e4a0917eab50910553f974">More...</a><br /></td></tr>
<tr class="separator:a8180f5d204e4a0917eab50910553f974"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7b19f29124939153cd574d48384986a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#af7b19f29124939153cd574d48384986a">setConeAngleOuter</a> (float angle)</td></tr>
<tr class="memdesc:af7b19f29124939153cd574d48384986a"><td class="mdescLeft"> </td><td class="mdescRight">Sets the outer angle of the cone of a source. <a href="#af7b19f29124939153cd574d48384986a">More...</a><br /></td></tr>
<tr class="separator:af7b19f29124939153cd574d48384986a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a22b615f06a6ce2930b23d70f2aea2ff7"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a22b615f06a6ce2930b23d70f2aea2ff7">getConeAngleInner</a> ()</td></tr>
<tr class="memdesc:a22b615f06a6ce2930b23d70f2aea2ff7"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the inner angle of the cone of a source. <a href="#a22b615f06a6ce2930b23d70f2aea2ff7">More...</a><br /></td></tr>
<tr class="separator:a22b615f06a6ce2930b23d70f2aea2ff7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91f4e337cbff28ea32e6be22784aab06"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a91f4e337cbff28ea32e6be22784aab06">setConeAngleInner</a> (float angle)</td></tr>
<tr class="memdesc:a91f4e337cbff28ea32e6be22784aab06"><td class="mdescLeft"> </td><td class="mdescRight">Sets the inner angle of the cone of a source. <a href="#a91f4e337cbff28ea32e6be22784aab06">More...</a><br /></td></tr>
<tr class="separator:a91f4e337cbff28ea32e6be22784aab06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c0bb19864d0ca04c7bb04ae49d1cc1e"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a4c0bb19864d0ca04c7bb04ae49d1cc1e">getConeVolumeOuter</a> ()</td></tr>
<tr class="memdesc:a4c0bb19864d0ca04c7bb04ae49d1cc1e"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the outer volume of the cone of a source. <a href="#a4c0bb19864d0ca04c7bb04ae49d1cc1e">More...</a><br /></td></tr>
<tr class="separator:a4c0bb19864d0ca04c7bb04ae49d1cc1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8af83e4e1a6fb997481a881b9e2160be"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceEntry.html#a8af83e4e1a6fb997481a881b9e2160be">setConeVolumeOuter</a> (float volume)</td></tr>
<tr class="memdesc:a8af83e4e1a6fb997481a881b9e2160be"><td class="mdescLeft"> </td><td class="mdescRight">Sets the outer volume of the cone of a source. <a href="#a8af83e4e1a6fb997481a881b9e2160be">More...</a><br /></td></tr>
<tr class="separator:a8af83e4e1a6fb997481a881b9e2160be"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a6f21fc3413d3a5ccc41c3eba4dff576d"><td class="memItemLeft" align="right" valign="top"><a id="a6f21fc3413d3a5ccc41c3eba4dff576d"></a>
class </td><td class="memItemRight" valign="bottom"><b>SequenceHandle</b></td></tr>
<tr class="separator:a6f21fc3413d3a5ccc41c3eba4dff576d"><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 represents a sequenced entry in a sequencer sound. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a8cd69efe2ada2a0dc64ba74b76600fed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cd69efe2ada2a0dc64ba74b76600fed">◆ </a></span>SequenceEntry()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SequenceEntry::SequenceEntry </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td>
<td class="paramname"><em>sound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>skip</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new sequenced entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The sound this entry should play. </td></tr>
<tr><td class="paramname">begin</td><td>The start time. </td></tr>
<tr><td class="paramname">end</td><td>The end time or a negative value if determined by the sound. </td></tr>
<tr><td class="paramname">skip</td><td>How much seconds should be skipped at the beginning. </td></tr>
<tr><td class="paramname">id</td><td>The ID of the entry. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0632c2e441c2c63ae6418f33175a8119"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0632c2e441c2c63ae6418f33175a8119">◆ </a></span>getAnimProperty()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAnimateableProperty.html">AnimateableProperty</a>* SequenceEntry::getAnimProperty </td>
<td>(</td>
<td class="paramtype"><a class="el" href="AnimateableProperty_8h.html#a88fcbc9d6d48a9832cc327f0b39cbec9">AnimateablePropertyType</a> </td>
<td class="paramname"><em>type</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves one of the animated properties of the entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">type</td><td>Which animated property to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the animated property, valid as long as the entry is. </dd></dl>
</div>
</div>
<a id="ac2c7de58fa88bb752a1dc8768d635e30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac2c7de58fa88bb752a1dc8768d635e30">◆ </a></span>getAttenuation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getAttenuation </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a22b615f06a6ce2930b23d70f2aea2ff7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22b615f06a6ce2930b23d70f2aea2ff7">◆ </a></span>getConeAngleInner()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getConeAngleInner </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the inner angle of the cone of a source. </p>
<dl class="section return"><dt>Returns</dt><dd>The inner angle of the cone. </dd></dl>
</div>
</div>
<a id="a8180f5d204e4a0917eab50910553f974"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8180f5d204e4a0917eab50910553f974">◆ </a></span>getConeAngleOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getConeAngleOuter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the outer angle of the cone of a source. </p>
<dl class="section return"><dt>Returns</dt><dd>The outer angle of the cone. </dd></dl>
</div>
</div>
<a id="a4c0bb19864d0ca04c7bb04ae49d1cc1e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c0bb19864d0ca04c7bb04ae49d1cc1e">◆ </a></span>getConeVolumeOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getConeVolumeOuter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a0764411c22c61dc335a40c51410cb446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0764411c22c61dc335a40c51410cb446">◆ </a></span>getDistanceMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getDistanceMaximum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a5ba33ce17f9317973521698fb5bc3071"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5ba33ce17f9317973521698fb5bc3071">◆ </a></span>getDistanceReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getDistanceReference </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a14ab28477b45c8974d4e620a73cbacce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a14ab28477b45c8974d4e620a73cbacce">◆ </a></span>getID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int SequenceEntry::getID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the ID of the entry. </p>
<dl class="section return"><dt>Returns</dt><dd>The ID of the entry. </dd></dl>
</div>
</div>
<a id="a22d453190582daeaa143b90ad3c5e4b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a22d453190582daeaa143b90ad3c5e4b6">◆ </a></span>getSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classISound.html">ISound</a>> SequenceEntry::getSound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the sound of the entry. </p>
<dl class="section return"><dt>Returns</dt><dd>The sound. </dd></dl>
</div>
</div>
<a id="a15fe8f58549facf1ff6d611ade960d9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15fe8f58549facf1ff6d611ade960d9f">◆ </a></span>getVolumeMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getVolumeMaximum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a5b74e769d28a593a42434fed1a5804bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b74e769d28a593a42434fed1a5804bd">◆ </a></span>getVolumeMinimum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceEntry::getVolumeMinimum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="acb9b2fe434b17f45875ed732d4d8f093"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb9b2fe434b17f45875ed732d4d8f093">◆ </a></span>isMuted()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SequenceEntry::isMuted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the muting state of the entry. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the entry should is muted or not. </dd></dl>
</div>
</div>
<a id="a52352c73330f3aca274cbd9321edd27d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52352c73330f3aca274cbd9321edd27d">◆ </a></span>isRelative()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SequenceEntry::isRelative </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>
</div>
</div>
<a id="a0e34ea5ff5bd21f0db868737456e51a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e34ea5ff5bd21f0db868737456e51a8">◆ </a></span>move()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::move </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>begin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>end</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>skip</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Moves the entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">begin</td><td>The new start time. </td></tr>
<tr><td class="paramname">end</td><td>The new end time or a negative value if unknown. </td></tr>
<tr><td class="paramname">skip</td><td>How many seconds to skip at the beginning. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aadefb4274c327a0d576cd0c6d55ad56d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadefb4274c327a0d576cd0c6d55ad56d">◆ </a></span>mute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::mute </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>mute</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the muting state of the entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">mute</td><td>Whether the entry should be muted or not. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a84645431d5f905f4fdfd852304b5bbd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84645431d5f905f4fdfd852304b5bbd0">◆ </a></span>setAttenuation()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setAttenuation </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>factor</em></td><td>)</td>
<td></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>
</div>
</div>
<a id="a91f4e337cbff28ea32e6be22784aab06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91f4e337cbff28ea32e6be22784aab06">◆ </a></span>setConeAngleInner()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setConeAngleInner </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the inner 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 inner angle of the cone. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Whether the action succeeded. </dd></dl>
</div>
</div>
<a id="af7b19f29124939153cd574d48384986a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7b19f29124939153cd574d48384986a">◆ </a></span>setConeAngleOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setConeAngleOuter </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the outer 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>
</div>
</div>
<a id="a8af83e4e1a6fb997481a881b9e2160be"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8af83e4e1a6fb997481a881b9e2160be">◆ </a></span>setConeVolumeOuter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setConeVolumeOuter </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></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>
</div>
</div>
<a id="af683b6db01650d8a60a6980e1e933e05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af683b6db01650d8a60a6980e1e933e05">◆ </a></span>setDistanceMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setDistanceMaximum </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>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>
</div>
</div>
<a id="a20cdbdf3573d10ecd661169e41e4d600"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20cdbdf3573d10ecd661169e41e4d600">◆ </a></span>setDistanceReference()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setDistanceReference </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>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>
</div>
</div>
<a id="add3c78ba9d9065c627596d1f142e326b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add3c78ba9d9065c627596d1f142e326b">◆ </a></span>setRelative()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setRelative </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>relative</em></td><td>)</td>
<td></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>
</div>
</div>
<a id="a6bbd9d712f64554af3b63c97841ffe71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6bbd9d712f64554af3b63c97841ffe71">◆ </a></span>setSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setSound </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > </td>
<td class="paramname"><em>sound</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the sound of the entry. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sound</td><td>The new sound. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8aaa5e88aa98da71cf4298c16bac76f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8aaa5e88aa98da71cf4298c16bac76f4">◆ </a></span>setVolumeMaximum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setVolumeMaximum </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></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>
</div>
</div>
<a id="a192bc273eef96617aa37c250d42ca52f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a192bc273eef96617aa37c250d42ca52f">◆ </a></span>setVolumeMinimum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceEntry::setVolumeMinimum </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>volume</em></td><td>)</td>
<td></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>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sequence/<a class="el" href="SequenceEntry_8h_source.html">SequenceEntry.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
>
1251
