<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickanimationcontroller.cpp -->
<title>AnimationController QML Type | Qt Quick 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-qmlmodule.html">QML Types</a></td><td >AnimationController QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#properties">Properties</a></li>
<li class="level1"><a href="#methods">Methods</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">AnimationController QML Type</h1>
<span class="subtitle"></span>
<!-- $$$AnimationController-brief -->
<p>Enables manual control of animations <a href="#details">More...</a></p>
<!-- @@@AnimationController -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick 2.7</td></tr></table></div><ul>
<li><a href="qml-qtquick-animationcontroller-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h2 id="properties">Properties</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-animationcontroller.html#animation-prop">animation</a></b></b> : Animation</li>
<li class="fn"><b><b><a href="qml-qtquick-animationcontroller.html#progress-prop">progress</a></b></b> : real</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn"><b><b><a href="qml-qtquick-animationcontroller.html#completeToBeginning-method">completeToBeginning</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-animationcontroller.html#completeToEnd-method">completeToEnd</a></b></b>()</li>
<li class="fn"><b><b><a href="qml-qtquick-animationcontroller.html#reload-method">reload</a></b></b>()</li>
</ul>
<!-- $$$AnimationController-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Normally animations are driven by an internal timer, but the <a href="qml-qtquick-animationcontroller.html">AnimationController</a> allows the given <i>animation</i> to be driven by a <i>progress</i> value explicitly.</p>
<!-- @@@AnimationController -->
<h2>Property Documentation</h2>
<!-- $$$animation -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="animation-prop">
<td class="tblQmlPropNode"><p>
<a name="animation-prop"></a><span class="qmldefault">[default] </span><span class="name">animation</span> : <span class="type"><a href="qml-qtquick-animation.html">Animation</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the animation to be controlled by the <a href="qml-qtquick-animationcontroller.html">AnimationController</a>.</p>
<p>Note:An animation controlled by <a href="qml-qtquick-animationcontroller.html">AnimationController</a> will always have its <code>running</code> and <code>paused</code> properties set to true. It can not be manually started or stopped (much like an animation in a Behavior can not be manually started or stopped).</p>
</div></div><!-- @@@animation -->
<br/>
<!-- $$$progress -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="progress-prop">
<td class="tblQmlPropNode"><p>
<a name="progress-prop"></a><span class="name">progress</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the animation progress value.</p>
<p>The valid <code>progress</code> value is 0.0 to 1.0, setting values less than 0 will be converted to 0, setting values great than 1 will be converted to 1.</p>
</div></div><!-- @@@progress -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$completeToBeginning -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="completeToBeginning-method">
<td class="tblQmlFuncNode"><p>
<a name="completeToBeginning-method"></a><span class="name">completeToBeginning</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Finishes running the controlled animation in a backwards direction.</p>
<p>After calling this method, the animation runs normally from the current progress point in a backwards direction to the beginning state.</p>
<p>The animation controller's progress value will be automatically updated while the animation is running.</p>
<p><b>See also </b><a href="qml-qtquick-animationcontroller.html#completeToEnd-method">completeToEnd()</a> and <a href="qml-qtquick-animationcontroller.html#progress-prop">progress</a>.</p>
</div></div><!-- @@@completeToBeginning -->
<br/>
<!-- $$$completeToEnd -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="completeToEnd-method">
<td class="tblQmlFuncNode"><p>
<a name="completeToEnd-method"></a><span class="name">completeToEnd</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Finishes running the controlled animation in a forwards direction.</p>
<p>After calling this method, the animation runs normally from the current progress point in a forwards direction to the end state.</p>
<p>The animation controller's progress value will be automatically updated while the animation is running.</p>
<p><b>See also </b><a href="qml-qtquick-animationcontroller.html#completeToBeginning-method">completeToBeginning()</a> and <a href="qml-qtquick-animationcontroller.html#progress-prop">progress</a>.</p>
</div></div><!-- @@@completeToEnd -->
<br/>
<!-- $$$reload -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="reload-method">
<td class="tblQmlFuncNode"><p>
<a name="reload-method"></a><span class="name">reload</span>()</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Reloads the animation properties</p>
<p>If the animation properties changed, calling this method to reload the animation definations.</p>
</div></div><!-- @@@reload -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
