<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qkeyframeanimation.cpp -->
<title>KeyframeAnimation QML Type | Qt 3D 5.12.2</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="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-qml.html">QML Types</a></td><td >KeyframeAnimation QML Type</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qt3d-index.html">Qt 5.12.2 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">KeyframeAnimation QML Type</h1>
<span class="subtitle"></span>
<!-- $$$KeyframeAnimation-brief -->
<p>A type implementing simple keyframe animation to a Transform. <a href="#details">More...</a></p>
<!-- @@@KeyframeAnimation -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Import Statement:</td><td class="memItemRight bottomAlign"> import Qt3D.Animation 2.12</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.9</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiates:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-animation-keyframeanimation.html"><a href="qt3danimation-qkeyframeanimation.html">QKeyframeAnimation</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <p><a href="qml-qt3d-animation-abstractanimation.html">AbstractAnimation</a></p>
</td></tr></table></div><ul>
<li><a href="qml-qt3d-animation-keyframeanimation-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-qt3d-animation-keyframeanimation.html#easing-prop">easing</a></b></b> : EasingCurve</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-keyframeanimation.html#endMode-prop">endMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-keyframeanimation.html#framePositions-prop">framePositions</a></b></b> : list<real></li>
<li class="fn"><b><b><a href="qml-qt3d-animation-keyframeanimation.html#keyframes-prop">keyframes</a></b></b> : list<Transform></li>
<li class="fn"><b><b><a href="qml-qt3d-animation-keyframeanimation.html#startMode-prop">startMode</a></b></b> : enumeration</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-keyframeanimation.html#target-prop">target</a></b></b> : Transform</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-keyframeanimation.html#targetName-prop">targetName</a></b></b> : string</li>
</ul>
<!-- $$$KeyframeAnimation-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p>A <a href="qml-qt3d-animation-keyframeanimation.html">KeyframeAnimation</a> type implements simple keyframe animation that can be used to animate <a href="qml-qt3d-core-transform.html">Transform</a>. The keyframes consists of multiple timed <a href="qml-qt3d-core-transform.html">Qt3D.Core::Transform</a>s, which are interpolated and applied to the target Transform. EasingCurve is used between keyframes to control the interpolator. RepeatMode can be set for when the position set to the <a href="qml-qt3d-animation-keyframeanimation.html">KeyframeAnimation</a> is less or or greater than the values defined in the keyframe positions.</p>
<!-- @@@KeyframeAnimation -->
<h2>Property Documentation</h2>
<!-- $$$easing -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="easing-prop">
<td class="tblQmlPropNode"><p>
<a name="easing-prop"></a><span class="name">easing</span> : <span class="type">EasingCurve</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the easing curve of the interpolator between keyframes.</p>
</div></div><!-- @@@easing -->
<br/>
<!-- $$$endMode -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="endMode-prop">
<td class="tblQmlPropNode"><p>
<a name="endMode-prop"></a><span class="name">endMode</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the repeat mode for the position values greater than the last frame position.</p>
<ul>
<li>None</li>
<li>Constant</li>
<li>Repeat</li>
</ul>
</div></div><!-- @@@endMode -->
<br/>
<!-- $$$framePositions -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="framePositions-prop">
<td class="tblQmlPropNode"><p>
<a name="framePositions-prop"></a><span class="name">framePositions</span> : <span class="type">list</span><<span class="type">real</span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the positions of the keyframes. Each position in the list specifies the position of the corresponding keyframe. The values must be in an ascending order. Values can be positive or negative and do not have any predefined unit.</p>
</div></div><!-- @@@framePositions -->
<br/>
<!-- $$$keyframes -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="keyframes-prop">
<td class="tblQmlPropNode"><p>
<a name="keyframes-prop"></a><span class="name">keyframes</span> : <span class="type">list</span><<span class="type"><a href="qml-qt3d-core-transform.html">Transform</a></span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the list of keyframes in the keyframe animation.</p>
</div></div><!-- @@@keyframes -->
<br/>
<!-- $$$startMode -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="startMode-prop">
<td class="tblQmlPropNode"><p>
<a name="startMode-prop"></a><span class="name">startMode</span> : <span class="type">enumeration</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the repeat mode for the position values less than the first frame position.</p>
<ul>
<li>None</li>
<li>Constant</li>
<li>Repeat</li>
</ul>
</div></div><!-- @@@startMode -->
<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-qt3d-core-transform.html">Transform</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the target Transform the animation is applied to.</p>
</div></div><!-- @@@target -->
<br/>
<!-- $$$targetName -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="targetName-prop">
<td class="tblQmlPropNode"><p>
<a name="targetName-prop"></a><span class="name">targetName</span> : <span class="type">string</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the name of the target transform. This is a convenience property making it easier to match the target transform to the keyframe animation. The name is usually same as the name of the parent entity of the target transform, but does not have to be.</p>
</div></div><!-- @@@targetName -->
<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>
