mirror of
https://github.com/thorvg/thorvg.git
synced 2025-06-08 05:33:36 +00:00
227 lines
17 KiB
HTML
227 lines
17 KiB
HTML
<!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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ThorVG: LottieAnimation</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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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="projectlogo"><img alt="Logo" src="small_logo.png"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ThorVG
|
|
 <span id="projectnumber">v0.13</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
|
<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','.html');
|
|
/* @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>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('classtvg_1_1LottieAnimation.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="classtvg_1_1LottieAnimation-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">LottieAnimation<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>The <a class="el" href="classtvg_1_1LottieAnimation.html" title="The LottieAnimation class enables control of advanced Lottie features.">LottieAnimation</a> class enables control of advanced Lottie features.
|
|
<a href="classtvg_1_1LottieAnimation.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for LottieAnimation:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classtvg_1_1LottieAnimation__inherit__graph.png" border="0" usemap="#aLottieAnimation_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="aLottieAnimation_inherit__map" id="aLottieAnimation_inherit__map">
|
|
<area shape="rect" title="The LottieAnimation class enables control of advanced Lottie features." alt="" coords="5,80,132,107"/>
|
|
<area shape="rect" href="classtvg_1_1Animation.html" title="The Animation class enables manipulation of animatable images." alt="" coords="24,5,113,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a target="top" 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:a4494026fda156de49129751764f36f1e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1LottieAnimation.html#a4494026fda156de49129751764f36f1e">override</a> (const char *slot) noexcept</td></tr>
|
|
<tr class="memdesc:a4494026fda156de49129751764f36f1e"><td class="mdescLeft"> </td><td class="mdescRight">Override Lottie properties using slot data. <a href="classtvg_1_1LottieAnimation.html#a4494026fda156de49129751764f36f1e">More...</a><br /></td></tr>
|
|
<tr class="separator:a4494026fda156de49129751764f36f1e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classtvg_1_1Animation"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classtvg_1_1Animation')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classtvg_1_1Animation.html">Animation</a></td></tr>
|
|
<tr class="memitem:a974f03b024a8beed5c8bfe32b56ac2c9 inherit pub_methods_classtvg_1_1Animation"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Animation.html#a974f03b024a8beed5c8bfe32b56ac2c9">frame</a> (float no) noexcept</td></tr>
|
|
<tr class="memdesc:a974f03b024a8beed5c8bfe32b56ac2c9 inherit pub_methods_classtvg_1_1Animation"><td class="mdescLeft"> </td><td class="mdescRight">Specifies the current frame in the animation. <a href="classtvg_1_1Animation.html#a974f03b024a8beed5c8bfe32b56ac2c9">More...</a><br /></td></tr>
|
|
<tr class="separator:a974f03b024a8beed5c8bfe32b56ac2c9 inherit pub_methods_classtvg_1_1Animation"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a004ba625c58005c931b244fb2515624f inherit pub_methods_classtvg_1_1Animation"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtvg_1_1Picture.html">Picture</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Animation.html#a004ba625c58005c931b244fb2515624f">picture</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a004ba625c58005c931b244fb2515624f inherit pub_methods_classtvg_1_1Animation"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a picture instance associated with this animation instance. <a href="classtvg_1_1Animation.html#a004ba625c58005c931b244fb2515624f">More...</a><br /></td></tr>
|
|
<tr class="separator:a004ba625c58005c931b244fb2515624f inherit pub_methods_classtvg_1_1Animation"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45585afc7e6dbab9fb2d5295b67c45ee inherit pub_methods_classtvg_1_1Animation"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Animation.html#a45585afc7e6dbab9fb2d5295b67c45ee">curFrame</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a45585afc7e6dbab9fb2d5295b67c45ee inherit pub_methods_classtvg_1_1Animation"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the current frame number of the animation. <a href="classtvg_1_1Animation.html#a45585afc7e6dbab9fb2d5295b67c45ee">More...</a><br /></td></tr>
|
|
<tr class="separator:a45585afc7e6dbab9fb2d5295b67c45ee inherit pub_methods_classtvg_1_1Animation"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a624e4fdeebf70f286188685e769125f3 inherit pub_methods_classtvg_1_1Animation"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Animation.html#a624e4fdeebf70f286188685e769125f3">totalFrame</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a624e4fdeebf70f286188685e769125f3 inherit pub_methods_classtvg_1_1Animation"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the total number of frames in the animation. <a href="classtvg_1_1Animation.html#a624e4fdeebf70f286188685e769125f3">More...</a><br /></td></tr>
|
|
<tr class="separator:a624e4fdeebf70f286188685e769125f3 inherit pub_methods_classtvg_1_1Animation"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a90ab38b7a2cb72d6b9de4492ff3e6679 inherit pub_methods_classtvg_1_1Animation"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Animation.html#a90ab38b7a2cb72d6b9de4492ff3e6679">duration</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:a90ab38b7a2cb72d6b9de4492ff3e6679 inherit pub_methods_classtvg_1_1Animation"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the duration of the animation in seconds. <a href="classtvg_1_1Animation.html#a90ab38b7a2cb72d6b9de4492ff3e6679">More...</a><br /></td></tr>
|
|
<tr class="separator:a90ab38b7a2cb72d6b9de4492ff3e6679 inherit pub_methods_classtvg_1_1Animation"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a295edc27ec3c8f15888e26c242d63312"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classtvg_1_1LottieAnimation.html">LottieAnimation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1LottieAnimation.html#a295edc27ec3c8f15888e26c242d63312">gen</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a295edc27ec3c8f15888e26c242d63312"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classtvg_1_1LottieAnimation.html" title="The LottieAnimation class enables control of advanced Lottie features.">LottieAnimation</a> object. <a href="classtvg_1_1LottieAnimation.html#a295edc27ec3c8f15888e26c242d63312">More...</a><br /></td></tr>
|
|
<tr class="separator:a295edc27ec3c8f15888e26c242d63312"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_static_methods_classtvg_1_1Animation"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classtvg_1_1Animation')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classtvg_1_1Animation.html">Animation</a></td></tr>
|
|
<tr class="memitem:a9f1d09061273b58fff49740abdeb1ddf inherit pub_static_methods_classtvg_1_1Animation"><td class="memItemLeft" align="right" valign="top">static std::unique_ptr< <a class="el" href="classtvg_1_1Animation.html">Animation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classtvg_1_1Animation.html#a9f1d09061273b58fff49740abdeb1ddf">gen</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a9f1d09061273b58fff49740abdeb1ddf inherit pub_static_methods_classtvg_1_1Animation"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classtvg_1_1Animation.html" title="The Animation class enables manipulation of animatable images.">Animation</a> object. <a href="classtvg_1_1Animation.html#a9f1d09061273b58fff49740abdeb1ddf">More...</a><br /></td></tr>
|
|
<tr class="separator:a9f1d09061273b58fff49740abdeb1ddf inherit pub_static_methods_classtvg_1_1Animation"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>The <a class="el" href="classtvg_1_1LottieAnimation.html" title="The LottieAnimation class enables control of advanced Lottie features.">LottieAnimation</a> class enables control of advanced Lottie features. </p>
|
|
<p>This class extends the <a class="el" href="classtvg_1_1Animation.html" title="The Animation class enables manipulation of animatable images.">Animation</a> and has additional interfaces.</p>
|
|
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classtvg_1_1Animation.html" title="The Animation class enables manipulation of animatable images.">Animation</a></dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a295edc27ec3c8f15888e26c242d63312"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a295edc27ec3c8f15888e26c242d63312">◆ </a></span>gen()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::unique_ptr<<a class="el" href="classtvg_1_1LottieAnimation.html">LottieAnimation</a>> gen </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a new <a class="el" href="classtvg_1_1LottieAnimation.html" title="The LottieAnimation class enables control of advanced Lottie features.">LottieAnimation</a> object. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="classtvg_1_1LottieAnimation.html" title="The LottieAnimation class enables control of advanced Lottie features.">LottieAnimation</a> object.</dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4494026fda156de49129751764f36f1e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4494026fda156de49129751764f36f1e">◆ </a></span>override()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="group__ThorVG.html#ga28287671eaf7406afd604bd055ba4066">Result</a> override </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>slot</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Override Lottie properties using slot data. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">slot</td><td>The Lottie slot data in JSON format to override, or <code>nullptr</code> to reset.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="retval"><dt>Return values</dt><dd>
|
|
<table class="retval">
|
|
<tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a505a83f220c02df2f85c3810cd9ceb38" title="The value returned in case of a correct request execution.">Result::Success</a></td><td>When succeed. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066a119732ff568bf103d744e930ae2404f1" title="The value returned in case the request cannot be processed - e.g. asking for properties of an object,...">Result::InsufficientCondition</a></td><td>In case the animation is not loaded. </td></tr>
|
|
<tr><td class="paramname"><a class="el" href="group__ThorVG.html#gga28287671eaf7406afd604bd055ba4066ae73a2e92f1c87086c838b442552a4775" title="The value returned in the event of a problem with the arguments given to the API - e....">Result::InvalidArguments</a></td><td>When the given parameter is invalid.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Experimental API </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><b>tvg</b></li><li class="navelem"><a class="el" href="classtvg_1_1LottieAnimation.html">LottieAnimation</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|