<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qquickpathinterpolator.cpp -->
<title>PathInterpolator 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 >PathInterpolator 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="#details">Detailed Description</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">PathInterpolator QML Type</h1>
<span class="subtitle"></span>
<!-- $$$PathInterpolator-brief -->
<p>Specifies how to manually animate along a path <a href="#details">More...</a></p>
<!-- @@@PathInterpolator -->
<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-pathinterpolator-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-pathinterpolator.html#angle-prop">angle</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-pathinterpolator.html#path-prop">path</a></b></b> : Path</li>
<li class="fn"><b><b><a href="qml-qtquick-pathinterpolator.html#progress-prop">progress</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-pathinterpolator.html#x-prop">x</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qtquick-pathinterpolator.html#y-prop">y</a></b></b> : real</li>
</ul>
<!-- $$$PathInterpolator-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qtquick-animation-example.html#pathinterpolator">PathInterpolator</a> provides <code>x</code>, <code>y</code>, and <code>angle</code> information for a particular <code>progress</code> along a path.</p>
<p>In the following example, we animate a green rectangle along a bezier path.</p>
<pre class="qml">
import QtQuick 2.0
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">width</span>: <span class="number">400</span>
<span class="name">height</span>: <span class="number">400</span>
<span class="type"><a href="qml-qtquick-pathinterpolator.html">PathInterpolator</a></span> {
<span class="name">id</span>: <span class="name">motionPath</span>
<span class="name">path</span>: <span class="name">Path</span> {
<span class="name">startX</span>: <span class="number">0</span>; <span class="name">startY</span>: <span class="number">0</span>
<span class="type"><a href="qml-qtquick-pathcubic.html">PathCubic</a></span> {
<span class="name">x</span>: <span class="number">350</span>; <span class="name">y</span>: <span class="number">350</span>
<span class="name">control1X</span>: <span class="number">350</span>; <span class="name">control1Y</span>: <span class="number">0</span>
<span class="name">control2X</span>: <span class="number">0</span>; <span class="name">control2Y</span>: <span class="number">350</span>
}
}
NumberAnimation on <span class="name">progress</span> { <span class="name">from</span>: <span class="number">0</span>; <span class="name">to</span>: <span class="number">1</span>; <span class="name">duration</span>: <span class="number">2000</span> }
}
<span class="type"><a href="qml-qtquick-rectangle.html">Rectangle</a></span> {
<span class="name">width</span>: <span class="number">50</span>; <span class="name">height</span>: <span class="number">50</span>
<span class="name">color</span>: <span class="string">"green"</span>
<span class="comment">//bind our attributes to follow the path as progress changes</span>
<span class="name">x</span>: <span class="name">motionPath</span>.<span class="name">x</span>
<span class="name">y</span>: <span class="name">motionPath</span>.<span class="name">y</span>
<span class="name">rotation</span>: <span class="name">motionPath</span>.<span class="name">angle</span>
}
}
</pre>
<!-- @@@PathInterpolator -->
<h2>Property Documentation</h2>
<!-- $$$angle -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="angle-prop">
<td class="tblQmlPropNode"><p>
<a name="angle-prop"></a><span class="name">angle</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the angle of the path tangent at <a href="qml-qtquick-pathinterpolator.html#progress-prop">progress</a>.</p>
<p>Angles are reported clockwise, with zero degrees at the 3 o'clock position.</p>
</div></div><!-- @@@angle -->
<br/>
<!-- $$$path -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="path-prop">
<td class="tblQmlPropNode"><p>
<a name="path-prop"></a><span class="name">path</span> : <span class="type"><a href="qml-qtquick-path.html">Path</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>This property holds the path to interpolate.</p>
<p>For more information on defining a path see the <a href="qml-qtquick-path.html">Path</a> documentation.</p>
</div></div><!-- @@@path -->
<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 current progress along the path.</p>
<p>Typical usage of <a href="qtquick-animation-example.html#pathinterpolator">PathInterpolator</a> is to set the progress (often via a <a href="qml-qtquick-numberanimation.html">NumberAnimation</a>), and read the corresponding values for x, y, and angle (often via bindings to these values).</p>
<p>Progress ranges from 0.0 to 1.0.</p>
</div></div><!-- @@@progress -->
<br/>
<!-- $$$x -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="x-prop">
<td class="tblQmlPropNode"><p>
<a name="x-prop"></a><span class="name">x</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties hold the position of the path at <a href="qml-qtquick-pathinterpolator.html#progress-prop">progress</a>.</p>
</div></div><!-- @@@x -->
<br/>
<!-- $$$y -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="y-prop">
<td class="tblQmlPropNode"><p>
<a name="y-prop"></a><span class="name">y</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>These properties hold the position of the path at <a href="qml-qtquick-pathinterpolator.html#progress-prop">progress</a>.</p>
</div></div><!-- @@@y -->
<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>
