<!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: SequenceData 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="classSequenceData-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SequenceData Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class represents sequenced entries to play a sound scene.
<a href="classSequenceData.html#details">More...</a></p>
<p><code>#include <<a class="el" href="SequenceData_8h_source.html">SequenceData.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for SequenceData:</div>
<div class="dyncontent">
<div class="center"><img src="classSequenceData__inherit__graph.png" border="0" usemap="#SequenceData_inherit__map" alt="Inheritance graph"/></div>
<map name="SequenceData_inherit__map" id="SequenceData_inherit__map">
<area shape="rect" title="This class represents sequenced entries to play a sound scene." alt="" coords="5,80,115,107"/>
<area shape="rect" href="classILockable.html" title="This class provides an interface for lockable objects." alt="" coords="20,5,100,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:aa7c4038195b722f0ed7d896a8c5d4c2c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#aa7c4038195b722f0ed7d896a8c5d4c2c">SequenceData</a> (<a class="el" href="structSpecs.html">Specs</a> specs, float fps, bool muted)</td></tr>
<tr class="memdesc:aa7c4038195b722f0ed7d896a8c5d4c2c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new sound scene. <a href="#aa7c4038195b722f0ed7d896a8c5d4c2c">More...</a><br /></td></tr>
<tr class="separator:aa7c4038195b722f0ed7d896a8c5d4c2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a081d781a9f57c01da28b77841f98aa11"><td class="memItemLeft" align="right" valign="top"><a id="a081d781a9f57c01da28b77841f98aa11"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a081d781a9f57c01da28b77841f98aa11">lock</a> ()</td></tr>
<tr class="memdesc:a081d781a9f57c01da28b77841f98aa11"><td class="mdescLeft"> </td><td class="mdescRight">Locks the sequence. <br /></td></tr>
<tr class="separator:a081d781a9f57c01da28b77841f98aa11"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba73ed525cb849f4b8ac5c0c99ea3a15"><td class="memItemLeft" align="right" valign="top"><a id="aba73ed525cb849f4b8ac5c0c99ea3a15"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#aba73ed525cb849f4b8ac5c0c99ea3a15">unlock</a> ()</td></tr>
<tr class="memdesc:aba73ed525cb849f4b8ac5c0c99ea3a15"><td class="mdescLeft"> </td><td class="mdescRight">Unlocks the previously locked sequence. <br /></td></tr>
<tr class="separator:aba73ed525cb849f4b8ac5c0c99ea3a15"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9145d2960cdef19212dcb744d05ae967"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structSpecs.html">Specs</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a9145d2960cdef19212dcb744d05ae967">getSpecs</a> ()</td></tr>
<tr class="memdesc:a9145d2960cdef19212dcb744d05ae967"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the audio output specification. <a href="#a9145d2960cdef19212dcb744d05ae967">More...</a><br /></td></tr>
<tr class="separator:a9145d2960cdef19212dcb744d05ae967"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7323f1a6ea0f919fbd43d410f803d061"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a7323f1a6ea0f919fbd43d410f803d061">setSpecs</a> (<a class="el" href="structSpecs.html">Specs</a> specs)</td></tr>
<tr class="memdesc:a7323f1a6ea0f919fbd43d410f803d061"><td class="mdescLeft"> </td><td class="mdescRight">Sets the audio output specification. <a href="#a7323f1a6ea0f919fbd43d410f803d061">More...</a><br /></td></tr>
<tr class="separator:a7323f1a6ea0f919fbd43d410f803d061"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43a0a415a51ca73125d43d51da239ee5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a43a0a415a51ca73125d43d51da239ee5">getFPS</a> () const</td></tr>
<tr class="memdesc:a43a0a415a51ca73125d43d51da239ee5"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the scene's FPS. <a href="#a43a0a415a51ca73125d43d51da239ee5">More...</a><br /></td></tr>
<tr class="separator:a43a0a415a51ca73125d43d51da239ee5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44b6c68d358b4b8cdaed45559d543880"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a44b6c68d358b4b8cdaed45559d543880">setFPS</a> (float fps)</td></tr>
<tr class="memdesc:a44b6c68d358b4b8cdaed45559d543880"><td class="mdescLeft"> </td><td class="mdescRight">Sets the scene's FPS. <a href="#a44b6c68d358b4b8cdaed45559d543880">More...</a><br /></td></tr>
<tr class="separator:a44b6c68d358b4b8cdaed45559d543880"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abae83c00fca709581e0f92517b7a1ef5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#abae83c00fca709581e0f92517b7a1ef5">mute</a> (bool muted)</td></tr>
<tr class="memdesc:abae83c00fca709581e0f92517b7a1ef5"><td class="mdescLeft"> </td><td class="mdescRight">Sets the muting state of the scene. <a href="#abae83c00fca709581e0f92517b7a1ef5">More...</a><br /></td></tr>
<tr class="separator:abae83c00fca709581e0f92517b7a1ef5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b0c0874bca4aad0695ac8e916842a59"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a7b0c0874bca4aad0695ac8e916842a59">isMuted</a> () const</td></tr>
<tr class="memdesc:a7b0c0874bca4aad0695ac8e916842a59"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the muting state of the scene. <a href="#a7b0c0874bca4aad0695ac8e916842a59">More...</a><br /></td></tr>
<tr class="separator:a7b0c0874bca4aad0695ac8e916842a59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa7dc123b9fe1369a2de98732b07e8caa"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#aa7dc123b9fe1369a2de98732b07e8caa">getSpeedOfSound</a> () const</td></tr>
<tr class="memdesc:aa7dc123b9fe1369a2de98732b07e8caa"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the speed of sound. <a href="#aa7dc123b9fe1369a2de98732b07e8caa">More...</a><br /></td></tr>
<tr class="separator:aa7dc123b9fe1369a2de98732b07e8caa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae28eff327bbb98dea155a1f34626089d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#ae28eff327bbb98dea155a1f34626089d">setSpeedOfSound</a> (float speed)</td></tr>
<tr class="memdesc:ae28eff327bbb98dea155a1f34626089d"><td class="mdescLeft"> </td><td class="mdescRight">Sets the speed of sound. <a href="#ae28eff327bbb98dea155a1f34626089d">More...</a><br /></td></tr>
<tr class="separator:ae28eff327bbb98dea155a1f34626089d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad820c858304aa60eafd5c586d62ea03"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#aad820c858304aa60eafd5c586d62ea03">getDopplerFactor</a> () const</td></tr>
<tr class="memdesc:aad820c858304aa60eafd5c586d62ea03"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the doppler factor. <a href="#aad820c858304aa60eafd5c586d62ea03">More...</a><br /></td></tr>
<tr class="separator:aad820c858304aa60eafd5c586d62ea03"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c126f29637eae0a6cc91751a55de52c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a7c126f29637eae0a6cc91751a55de52c">setDopplerFactor</a> (float factor)</td></tr>
<tr class="memdesc:a7c126f29637eae0a6cc91751a55de52c"><td class="mdescLeft"> </td><td class="mdescRight">Sets the doppler factor. <a href="#a7c126f29637eae0a6cc91751a55de52c">More...</a><br /></td></tr>
<tr class="separator:a7c126f29637eae0a6cc91751a55de52c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0c94cb3b8d35fa40646535135fc4b9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#aa0c94cb3b8d35fa40646535135fc4b9f">getDistanceModel</a> () const</td></tr>
<tr class="memdesc:aa0c94cb3b8d35fa40646535135fc4b9f"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the distance model. <a href="#aa0c94cb3b8d35fa40646535135fc4b9f">More...</a><br /></td></tr>
<tr class="separator:aa0c94cb3b8d35fa40646535135fc4b9f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b6092d2750b35c6d173382cd3ccb4b7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a7b6092d2750b35c6d173382cd3ccb4b7">setDistanceModel</a> (<a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> model)</td></tr>
<tr class="memdesc:a7b6092d2750b35c6d173382cd3ccb4b7"><td class="mdescLeft"> </td><td class="mdescRight">Sets the distance model. <a href="#a7b6092d2750b35c6d173382cd3ccb4b7">More...</a><br /></td></tr>
<tr class="separator:a7b6092d2750b35c6d173382cd3ccb4b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af83e88494d33e50d56449b4e1f342aa2"><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="classSequenceData.html#af83e88494d33e50d56449b4e1f342aa2">getAnimProperty</a> (<a class="el" href="AnimateableProperty_8h.html#a88fcbc9d6d48a9832cc327f0b39cbec9">AnimateablePropertyType</a> type)</td></tr>
<tr class="memdesc:af83e88494d33e50d56449b4e1f342aa2"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves one of the animated properties of the sequence. <a href="#af83e88494d33e50d56449b4e1f342aa2">More...</a><br /></td></tr>
<tr class="separator:af83e88494d33e50d56449b4e1f342aa2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44213492b84c18213d996ef1a650100f"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classSequenceEntry.html">SequenceEntry</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#a44213492b84c18213d996ef1a650100f">add</a> (std::shared_ptr< <a class="el" href="classISound.html">ISound</a> > sound, float begin, float end, float skip)</td></tr>
<tr class="memdesc:a44213492b84c18213d996ef1a650100f"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new entry to the scene. <a href="#a44213492b84c18213d996ef1a650100f">More...</a><br /></td></tr>
<tr class="separator:a44213492b84c18213d996ef1a650100f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5f88f1f920cf79f3a363af4ced0377a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSequenceData.html#ae5f88f1f920cf79f3a363af4ced0377a">remove</a> (std::shared_ptr< <a class="el" href="classSequenceEntry.html">SequenceEntry</a> > entry)</td></tr>
<tr class="memdesc:ae5f88f1f920cf79f3a363af4ced0377a"><td class="mdescLeft"> </td><td class="mdescRight">Removes an entry from the scene. <a href="#ae5f88f1f920cf79f3a363af4ced0377a">More...</a><br /></td></tr>
<tr class="separator:ae5f88f1f920cf79f3a363af4ced0377a"><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:a9ba250b007d621254938add642d8d790"><td class="memItemLeft" align="right" valign="top"><a id="a9ba250b007d621254938add642d8d790"></a>
class </td><td class="memItemRight" valign="bottom"><b>SequenceReader</b></td></tr>
<tr class="separator:a9ba250b007d621254938add642d8d790"><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 sequenced entries to play a sound scene. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="aa7c4038195b722f0ed7d896a8c5d4c2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7c4038195b722f0ed7d896a8c5d4c2c">◆ </a></span>SequenceData()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SequenceData::SequenceData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSpecs.html">Specs</a> </td>
<td class="paramname"><em>specs</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>fps</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>muted</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new sound scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">specs</td><td>The output audio data specification. </td></tr>
<tr><td class="paramname">fps</td><td>The FPS of the scene. </td></tr>
<tr><td class="paramname">muted</td><td>Whether the whole scene is muted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a44213492b84c18213d996ef1a650100f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44213492b84c18213d996ef1a650100f">◆ </a></span>add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::shared_ptr<<a class="el" href="classSequenceEntry.html">SequenceEntry</a>> SequenceData::add </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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new entry to the scene. </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>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The entry added. </dd></dl>
</div>
</div>
<a id="af83e88494d33e50d56449b4e1f342aa2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af83e88494d33e50d56449b4e1f342aa2">◆ </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>* SequenceData::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 sequence. </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 sequence is. </dd></dl>
</div>
</div>
<a id="aa0c94cb3b8d35fa40646535135fc4b9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0c94cb3b8d35fa40646535135fc4b9f">◆ </a></span>getDistanceModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> SequenceData::getDistanceModel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the distance model. </p>
<dl class="section return"><dt>Returns</dt><dd>The distance model. </dd></dl>
</div>
</div>
<a id="aad820c858304aa60eafd5c586d62ea03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad820c858304aa60eafd5c586d62ea03">◆ </a></span>getDopplerFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceData::getDopplerFactor </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the doppler factor. </p>
<p>This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect. </p><dl class="section return"><dt>Returns</dt><dd>The doppler factor. </dd></dl>
</div>
</div>
<a id="a43a0a415a51ca73125d43d51da239ee5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43a0a415a51ca73125d43d51da239ee5">◆ </a></span>getFPS()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceData::getFPS </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the scene's FPS. </p>
<dl class="section return"><dt>Returns</dt><dd>The scene's FPS. </dd></dl>
</div>
</div>
<a id="a9145d2960cdef19212dcb744d05ae967"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9145d2960cdef19212dcb744d05ae967">◆ </a></span>getSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structSpecs.html">Specs</a> SequenceData::getSpecs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the audio output specification. </p>
<dl class="section return"><dt>Returns</dt><dd>The specification. </dd></dl>
</div>
</div>
<a id="aa7dc123b9fe1369a2de98732b07e8caa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7dc123b9fe1369a2de98732b07e8caa">◆ </a></span>getSpeedOfSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float SequenceData::getSpeedOfSound </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the speed of sound. </p>
<p>This value is needed for doppler effect calculation. </p><dl class="section return"><dt>Returns</dt><dd>The speed of sound. </dd></dl>
</div>
</div>
<a id="a7b0c0874bca4aad0695ac8e916842a59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b0c0874bca4aad0695ac8e916842a59">◆ </a></span>isMuted()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool SequenceData::isMuted </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the muting state of the scene. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the scene is muted. </dd></dl>
</div>
</div>
<a id="abae83c00fca709581e0f92517b7a1ef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abae83c00fca709581e0f92517b7a1ef5">◆ </a></span>mute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceData::mute </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>muted</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the muting state of the scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">muted</td><td>Whether the scene is muted. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae5f88f1f920cf79f3a363af4ced0377a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5f88f1f920cf79f3a363af4ced0377a">◆ </a></span>remove()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceData::remove </td>
<td>(</td>
<td class="paramtype">std::shared_ptr< <a class="el" href="classSequenceEntry.html">SequenceEntry</a> > </td>
<td class="paramname"><em>entry</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Removes an entry from the scene. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">entry</td><td>The entry to remove. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7b6092d2750b35c6d173382cd3ccb4b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7b6092d2750b35c6d173382cd3ccb4b7">◆ </a></span>setDistanceModel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceData::setDistanceModel </td>
<td>(</td>
<td class="paramtype"><a class="el" href="I3DDevice_8h.html#a5e42e9a2b2a31997de7556c983d15ffd">DistanceModel</a> </td>
<td class="paramname"><em>model</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the distance model. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">model</td><td>distance model. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7c126f29637eae0a6cc91751a55de52c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c126f29637eae0a6cc91751a55de52c">◆ </a></span>setDopplerFactor()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceData::setDopplerFactor </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 doppler factor. </p>
<p>This value is a scaling factor for the velocity vectors of sources and listener which is used while calculating the doppler effect. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">factor</td><td>The new doppler factor. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a44b6c68d358b4b8cdaed45559d543880"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44b6c68d358b4b8cdaed45559d543880">◆ </a></span>setFPS()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceData::setFPS </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>fps</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the scene's FPS. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fps</td><td>The new FPS. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a7323f1a6ea0f919fbd43d410f803d061"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7323f1a6ea0f919fbd43d410f803d061">◆ </a></span>setSpecs()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceData::setSpecs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structSpecs.html">Specs</a> </td>
<td class="paramname"><em>specs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the audio output specification. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">specs</td><td>The new specification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae28eff327bbb98dea155a1f34626089d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae28eff327bbb98dea155a1f34626089d">◆ </a></span>setSpeedOfSound()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SequenceData::setSpeedOfSound </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>speed</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the speed of sound. </p>
<p>This value is needed for doppler effect calculation. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">speed</td><td>The new speed of sound. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>sequence/<a class="el" href="SequenceData_8h_source.html">SequenceData.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
>
1246
