<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickanimator.cpp -->
<title>Animator QML Type | Qt Quick 5.12.6</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.12</td><td ><a href="qtquick-index.html">Qt Quick</a></td><td ><a href="qtquick-qmlmodule.html">QML Types</a></td><td >Animator QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtquick-index.html">Qt 5.12.6 Reference Documentation</a></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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Animator QML Type</h1>
<span class="subtitle"></span>
<!-- $$$Animator-brief -->
<p>Is the base of all QML animators. <a href="#details">More...</a></p>
<!-- @@@Animator -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import QtQuick 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.2</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-animation.html">Animation</a></p>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qtquick-opacityanimator.html">OpacityAnimator</a>, <a href="qml-qtquick-rotationanimator.html">RotationAnimator</a>, <a href="qml-qtquick-scaleanimator.html">ScaleAnimator</a>, <a href="qml-qtquick-uniformanimator.html">UniformAnimator</a>, <a href="qml-qtquick-xanimator.html">XAnimator</a>, and <a href="qml-qtquick-yanimator.html">YAnimator</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qtquick-animator-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-animator.html#duration-prop">duration</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#easing-prop">easing</a></b></b><ul>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#easing.type-prop">easing.type</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#easing.amplitude-prop">easing.amplitude</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#easing.overshoot-prop">easing.overshoot</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#easing.period-prop">easing.period</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#easing.bezierCurve-prop">easing.bezierCurve</a></b></b> : list<real></li>
</ul>
</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#from-prop">from</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#target-prop">target</a></b></b> : QtQuick::Item</li>
<li class="fn"><b><b><a href="qml-qtquick-animator.html#to-prop">to</a></b></b> : real</li>
</ul>
<!-- $$$Animator-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>Animator types are a special type of animation which operate directly on Qt Quick's scene graph, rather than the QML objects and their properties like regular Animation types do. This has the benefit that Animator based animations can animate on the <a href="qtquick-visualcanvas-scenegraph.html#threaded-render-loop-threaded">scene graph's rendering thread</a> even when the UI thread is blocked.</p>
<p>The value of the QML property will be updated after the animation has finished. The property is not updated while the animation is running.</p>
<p>The Animator types can be used just like any other Animation type.</p>
<pre class="qml">
Rectangle {
id: mixBox
width: 50
height: 50
ParallelAnimation {
ColorAnimation {
target: mixBox
property: "color"
from: "forestgreen"
to: "lightsteelblue";
duration: 1000
}
ScaleAnimator {
target: mixBox
from: 2
to: 1
duration: 1000
}
running: true
}
}
</pre>
<p>If all sub-animations of <a href="qml-qtquick-parallelanimation.html">ParallelAnimation</a> and <a href="qml-qtquick-sequentialanimation.html">SequentialAnimation</a> are Animator types, the <a href="qml-qtquick-parallelanimation.html">ParallelAnimation</a> and <a href="qml-qtquick-sequentialanimation.html">SequentialAnimation</a> will also be treated as an Animator and be run on the scene graph's rendering thread when possible.</p>
<p>The Animator types can be used for animations during transitions, but they do not support the <a href="qml-qtquick-transition.html#reversible-prop">reversible</a> property.</p>
<p>The Animator type cannot be used directly in a QML file. It exists to provide a set of common properties and methods, available across all the other animator types that inherit from it. Attempting to use the Animator type directly will result in an error.</p>
<!-- @@@Animator -->
<h2>Property Documentation</h2>
<!-- $$$duration -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="duration-prop">
<td class="tblQmlPropNode"><p>
<a name="duration-prop"></a><span class="name">duration</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the duration of the animation in milliseconds.</p>
<p>The default value is 250.</p>
</div></div><!-- @@@duration -->
<br/>
<!-- $$$easing -->
<div class="qmlitem"><div class="qmlproto"><div class="table"><table class="qmlname"><tr valign="top" class="even" id="easing-prop"><th class="centerAlign"><p><a name="easing-prop"></a><b>easing group</b></p></th></tr><tr valign="top" class="odd" id="easing.type-prop"><td class="tblQmlPropNode"><p><a name="easing.type-prop"></a><span class="name">easing.type</span> : <span class="type">enumeration</span></p></td></tr><tr valign="top" class="odd" id="easing.amplitude-prop"><td class="tblQmlPropNode"><p><a name="easing.amplitude-prop"></a><span class="name">easing.amplitude</span> : <span class="type">real</span></p></td></tr><tr valign="top" class="odd" id="easing.overshoot-prop"><td class="tblQmlPropNode"><p><a name="easing.overshoot-prop"></a><span class="name">easing.overshoot</span> : <span class="type">real</span></p></td></tr><tr valign="top" class="odd" id="easing.period-prop"><td class="tblQmlPropNode"><p><a name="easing.period-prop"></a><span class="name">easing.period</span> : <span class="type">real</span></p></td></tr><tr valign="top" class="odd" id="easing.bezierCurve-prop"><td class="tblQmlPropNode"><p><a name="easing.bezierCurve-prop"></a><span class="name">easing.bezierCurve</span> : <span class="type">list</span><<span class="type">real</span>></p></td></tr></table></div></div><div class="qmldoc"><p>Specifies the easing curve used for the animation</p>
<p>To specify an easing curve you need to specify at least the type. For some curves you can also specify amplitude, period and/or overshoot (more details provided after the table). The default easing curve is <code>Easing.Linear</code>.</p>
<pre class="qml">
</pre>
<p>Available types are:</p>
<div class="table"><table class="generic">
<tr valign="top" class="odd"><td ><code>Easing.Linear</code></td><td >Easing curve for a linear (t) function: velocity is constant.</td><td ><img src="images/qeasingcurve-linear.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InQuad</code></td><td >Easing curve for a quadratic (t^2) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-inquad.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutQuad</code></td><td >Easing curve for a quadratic (t^2) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outquad.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutQuad</code></td><td >Easing curve for a quadratic (t^2) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutquad.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInQuad</code></td><td >Easing curve for a quadratic (t^2) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinquad.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InCubic</code></td><td >Easing curve for a cubic (t^3) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-incubic.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutCubic</code></td><td >Easing curve for a cubic (t^3) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outcubic.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutCubic</code></td><td >Easing curve for a cubic (t^3) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutcubic.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInCubic</code></td><td >Easing curve for a cubic (t^3) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outincubic.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InQuart</code></td><td >Easing curve for a quartic (t^4) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-inquart.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutQuart</code></td><td >Easing curve for a quartic (t^4) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outquart.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutQuart</code></td><td >Easing curve for a quartic (t^4) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutquart.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInQuart</code></td><td >Easing curve for a quartic (t^4) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinquart.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InQuint</code></td><td >Easing curve for a quintic (t^5) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-inquint.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutQuint</code></td><td >Easing curve for a quintic (t^5) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outquint.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutQuint</code></td><td >Easing curve for a quintic (t^5) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutquint.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInQuint</code></td><td >Easing curve for a quintic (t^5) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinquint.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InSine</code></td><td >Easing curve for a sinusoidal (sin(t)) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-insine.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutSine</code></td><td >Easing curve for a sinusoidal (sin(t)) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outsine.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutSine</code></td><td >Easing curve for a sinusoidal (sin(t)) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutsine.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInSine</code></td><td >Easing curve for a sinusoidal (sin(t)) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinsine.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InExpo</code></td><td >Easing curve for an exponential (2^t) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-inexpo.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutExpo</code></td><td >Easing curve for an exponential (2^t) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outexpo.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutExpo</code></td><td >Easing curve for an exponential (2^t) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutexpo.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInExpo</code></td><td >Easing curve for an exponential (2^t) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinexpo.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InCirc</code></td><td >Easing curve for a circular (sqrt(1-t^2)) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-incirc.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutCirc</code></td><td >Easing curve for a circular (sqrt(1-t^2)) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outcirc.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutCirc</code></td><td >Easing curve for a circular (sqrt(1-t^2)) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutcirc.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInCirc</code></td><td >Easing curve for a circular (sqrt(1-t^2)) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outincirc.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InElastic</code></td><td >Easing curve for an elastic (exponentially decaying sine wave) function: accelerating from zero velocity. <br />
The peak amplitude can be set with the <i>amplitude</i> parameter, and the period of decay by the <i>period</i> parameter.</td><td ><img src="images/qeasingcurve-inelastic.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutElastic</code></td><td >Easing curve for an elastic (exponentially decaying sine wave) function: decelerating to zero velocity. <br />
The peak amplitude can be set with the <i>amplitude</i> parameter, and the period of decay by the <i>period</i> parameter.</td><td ><img src="images/qeasingcurve-outelastic.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutElastic</code></td><td >Easing curve for an elastic (exponentially decaying sine wave) function: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutelastic.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInElastic</code></td><td >Easing curve for an elastic (exponentially decaying sine wave) function: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinelastic.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InBack</code></td><td >Easing curve for a back (overshooting cubic function: (s+1)*t^3 - s*t^2) easing in: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-inback.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutBack</code></td><td >Easing curve for a back (overshooting cubic function: (s+1)*t^3 - s*t^2) easing out: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outback.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutBack</code></td><td >Easing curve for a back (overshooting cubic function: (s+1)*t^3 - s*t^2) easing in/out: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutback.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInBack</code></td><td >Easing curve for a back (overshooting cubic easing: (s+1)*t^3 - s*t^2) easing out/in: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinback.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InBounce</code></td><td >Easing curve for a bounce (exponentially decaying parabolic bounce) function: accelerating from zero velocity.</td><td ><img src="images/qeasingcurve-inbounce.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutBounce</code></td><td >Easing curve for a bounce (exponentially decaying parabolic bounce) function: decelerating to zero velocity.</td><td ><img src="images/qeasingcurve-outbounce.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.InOutBounce</code></td><td >Easing curve for a bounce (exponentially decaying parabolic bounce) function easing in/out: acceleration until halfway, then deceleration.</td><td ><img src="images/qeasingcurve-inoutbounce.png" alt="" /></td></tr>
<tr valign="top" class="odd"><td ><code>Easing.OutInBounce</code></td><td >Easing curve for a bounce (exponentially decaying parabolic bounce) function easing out/in: deceleration until halfway, then acceleration.</td><td ><img src="images/qeasingcurve-outinbounce.png" alt="" /></td></tr>
<tr valign="top" class="even"><td ><code>Easing.Bezier</code></td><td >Custom easing curve defined by the easing.bezierCurve property.</td><td ></td></tr>
</table></div>
<p><code>easing.amplitude</code> is only applicable for bounce and elastic curves (curves of type <code>Easing.InBounce</code>, <code>Easing.OutBounce</code>, <code>Easing.InOutBounce</code>, <code>Easing.OutInBounce</code>, <code>Easing.InElastic</code>, <code>Easing.OutElastic</code>, <code>Easing.InOutElastic</code> or <code>Easing.OutInElastic</code>).</p>
<p><code>easing.overshoot</code> is only applicable if <code>easing.type</code> is: <code>Easing.InBack</code>, <code>Easing.OutBack</code>, <code>Easing.InOutBack</code> or <code>Easing.OutInBack</code>.</p>
<p><code>easing.period</code> is only applicable if easing.type is: <code>Easing.InElastic</code>, <code>Easing.OutElastic</code>, <code>Easing.InOutElastic</code> or <code>Easing.OutInElastic</code>.</p>
<p><code>easing.bezierCurve</code> is only applicable if easing.type is: <code>Easing.Bezier</code>. This property is a list<real> containing groups of three points defining a curve from 0,0 to 1,1 - control1, control2, end point: [cx1, cy1, cx2, cy2, endx, endy, ...]. The last point must be 1,1.</p>
<p>See the <a href="qtquick-animation-example.html#easing-curves">Easing Curves</a> for a demonstration of the different easing settings.</p>
</div></div><!-- @@@easing -->
<br/>
<!-- $$$from -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="from-prop">
<td class="tblQmlPropNode"><p>
<a name="from-prop"></a><span class="name">from</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the starting value for the animation.</p>
<p>If the Animator is defined within a <a href="qmlexampletoggleswitch.html#transition">Transition</a> or <a href="qml-qtquick-behavior.html">Behavior</a>, this value defaults to the value defined in the starting state of the <a href="qmlexampletoggleswitch.html#transition">Transition</a>, or the current value of the property at the moment the <a href="qml-qtquick-behavior.html">Behavior</a> is triggered.</p>
<p><b>See also </b><a href="qtquick-statesanimations-animations.html">Animation and Transitions in Qt Quick</a>.</p>
</div></div><!-- @@@from -->
<br/>
<!-- $$$target -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="target-prop">
<td class="tblQmlPropNode"><p>
<a name="target-prop"></a><span class="name">target</span> : <span class="type"><a href="qml-qtquick-item.html">QtQuick::Item</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the target item of the animator.</p>
<p><b>Note: </b>Animator targets must be Item based types.</p></div></div><!-- @@@target -->
<br/>
<!-- $$$to -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="to-prop">
<td class="tblQmlPropNode"><p>
<a name="to-prop"></a><span class="name">to</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the end value for the animation.</p>
<p>If the Animator is defined within a <a href="qmlexampletoggleswitch.html#transition">Transition</a> or <a href="qml-qtquick-behavior.html">Behavior</a>, this value defaults to the value defined in the end state of the <a href="qmlexampletoggleswitch.html#transition">Transition</a>, or the value of the property change that triggered the <a href="qml-qtquick-behavior.html">Behavior</a>.</p>
</div></div><!-- @@@to -->
<br/>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-updates
>
by-pkgid
>
6e2327ca1c896c6d674ae53117299f21
>
files
>
882
