<!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: AnimateableProperty 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="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classAnimateableProperty-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AnimateableProperty Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class saves animation data for float properties.
<a href="classAnimateableProperty.html#details">More...</a></p>
<p><code>#include <<a class="el" href="AnimateableProperty_8h_source.html">AnimateableProperty.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for AnimateableProperty:</div>
<div class="dyncontent">
<div class="center"><img src="classAnimateableProperty__inherit__graph.png" border="0" usemap="#AnimateableProperty_inherit__map" alt="Inheritance graph"/></div>
<map name="AnimateableProperty_inherit__map" id="AnimateableProperty_inherit__map">
<area shape="rect" title="This class saves animation data for float properties." alt="" coords="5,80,156,107"/>
<area shape="rect" href="classBuffer.html" title="This class is a simple buffer in RAM which is 32 Byte aligned and provides resize functionality." alt="" coords="51,5,110,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:a03347f2f904ec20a297336de2ccbc595"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#a03347f2f904ec20a297336de2ccbc595">AnimateableProperty</a> (int count=1)</td></tr>
<tr class="memdesc:a03347f2f904ec20a297336de2ccbc595"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new animateable property. <a href="#a03347f2f904ec20a297336de2ccbc595">More...</a><br /></td></tr>
<tr class="separator:a03347f2f904ec20a297336de2ccbc595"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebbb904e26b2c86f1e06ca7c4cbadb05"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#aebbb904e26b2c86f1e06ca7c4cbadb05">AnimateableProperty</a> (int count, float value)</td></tr>
<tr class="memdesc:aebbb904e26b2c86f1e06ca7c4cbadb05"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new animateable property. <a href="#aebbb904e26b2c86f1e06ca7c4cbadb05">More...</a><br /></td></tr>
<tr class="separator:aebbb904e26b2c86f1e06ca7c4cbadb05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c44e2b9892326fae9d1849fb434ffcf"><td class="memItemLeft" align="right" valign="top"><a id="a5c44e2b9892326fae9d1849fb434ffcf"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#a5c44e2b9892326fae9d1849fb434ffcf">~AnimateableProperty</a> ()</td></tr>
<tr class="memdesc:a5c44e2b9892326fae9d1849fb434ffcf"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the animateable property. <br /></td></tr>
<tr class="separator:a5c44e2b9892326fae9d1849fb434ffcf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aee6da9f0513f2e187eea0178b521541b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#aee6da9f0513f2e187eea0178b521541b">getCount</a> () const</td></tr>
<tr class="memdesc:aee6da9f0513f2e187eea0178b521541b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the count of floats for a single property. <a href="#aee6da9f0513f2e187eea0178b521541b">More...</a><br /></td></tr>
<tr class="separator:aee6da9f0513f2e187eea0178b521541b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a178c047273b99fc0871c41417389a489"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#a178c047273b99fc0871c41417389a489">write</a> (const float *data)</td></tr>
<tr class="memdesc:a178c047273b99fc0871c41417389a489"><td class="mdescLeft"> </td><td class="mdescRight">Writes the properties value and marks it non-animated. <a href="#a178c047273b99fc0871c41417389a489">More...</a><br /></td></tr>
<tr class="separator:a178c047273b99fc0871c41417389a489"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8938dd09a418f758cf3547a0805ba2b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#ae8938dd09a418f758cf3547a0805ba2b">write</a> (const float *data, int position, int count)</td></tr>
<tr class="memdesc:ae8938dd09a418f758cf3547a0805ba2b"><td class="mdescLeft"> </td><td class="mdescRight">Writes the properties value and marks it animated. <a href="#ae8938dd09a418f758cf3547a0805ba2b">More...</a><br /></td></tr>
<tr class="separator:ae8938dd09a418f758cf3547a0805ba2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5bf7a878276598a1077b40be2de6c278"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#a5bf7a878276598a1077b40be2de6c278">read</a> (float position, float *out)</td></tr>
<tr class="memdesc:a5bf7a878276598a1077b40be2de6c278"><td class="mdescLeft"> </td><td class="mdescRight">Reads the properties value. <a href="#a5bf7a878276598a1077b40be2de6c278">More...</a><br /></td></tr>
<tr class="separator:a5bf7a878276598a1077b40be2de6c278"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8decbf4f790739e50ad5ebc0f0f6070"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnimateableProperty.html#aa8decbf4f790739e50ad5ebc0f0f6070">isAnimated</a> () const</td></tr>
<tr class="memdesc:aa8decbf4f790739e50ad5ebc0f0f6070"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether the property is animated. <a href="#aa8decbf4f790739e50ad5ebc0f0f6070">More...</a><br /></td></tr>
<tr class="separator:aa8decbf4f790739e50ad5ebc0f0f6070"><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 saves animation data for float properties. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a03347f2f904ec20a297336de2ccbc595"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03347f2f904ec20a297336de2ccbc595">◆ </a></span>AnimateableProperty() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AnimateableProperty::AnimateableProperty </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>count</em> = <code>1</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new animateable property. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>The count of floats for a single property. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aebbb904e26b2c86f1e06ca7c4cbadb05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebbb904e26b2c86f1e06ca7c4cbadb05">◆ </a></span>AnimateableProperty() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AnimateableProperty::AnimateableProperty </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new animateable property. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">count</td><td>The count of floats for a single property. </td></tr>
<tr><td class="paramname">value</td><td>The value that the property should get initialized with. All count floats will be initialized to the same value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aee6da9f0513f2e187eea0178b521541b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee6da9f0513f2e187eea0178b521541b">◆ </a></span>getCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int AnimateableProperty::getCount </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the count of floats for a single property. </p>
<dl class="section return"><dt>Returns</dt><dd>The count of floats stored per frame. </dd></dl>
</div>
</div>
<a id="aa8decbf4f790739e50ad5ebc0f0f6070"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8decbf4f790739e50ad5ebc0f0f6070">◆ </a></span>isAnimated()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool AnimateableProperty::isAnimated </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether the property is animated. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the property is animated. </dd></dl>
</div>
</div>
<a id="a5bf7a878276598a1077b40be2de6c278"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bf7a878276598a1077b40be2de6c278">◆ </a></span>read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AnimateableProperty::read </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"><em>out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the properties value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir"></td><td class="paramname">position</td><td>The position in the animation in frames. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Where to write the value to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a178c047273b99fc0871c41417389a489"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a178c047273b99fc0871c41417389a489">◆ </a></span>write() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AnimateableProperty::write </td>
<td>(</td>
<td class="paramtype">const float * </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the properties value and marks it non-animated. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The new value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae8938dd09a418f758cf3547a0805ba2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8938dd09a418f758cf3547a0805ba2b">◆ </a></span>write() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void AnimateableProperty::write </td>
<td>(</td>
<td class="paramtype">const float * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>position</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes the properties value and marks it animated. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>The new value. </td></tr>
<tr><td class="paramname">position</td><td>The position in the animation in frames. </td></tr>
<tr><td class="paramname">count</td><td>The count of frames to write. </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="AnimateableProperty_8h_source.html">AnimateableProperty.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
>
825
