<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qanimationcontroller.cpp -->
<title>AnimationController 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 >AnimationController 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="#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>A controller type for 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 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-animationcontroller.html"><a href="qt3danimation-qanimationcontroller.html">QAnimationController</a></td></tr></table></div><ul>
<li><a href="qml-qt3d-animation-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-qt3d-animation-animationcontroller.html#activeAnimationGroup-prop">activeAnimationGroup</a></b></b> : int</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-animationcontroller.html#animationGroups-prop">animationGroups</a></b></b> : list<AnimationGroup></li>
<li class="fn"><b><b><a href="qml-qt3d-animation-animationcontroller.html#entity-prop">entity</a></b></b> : Entity</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-animationcontroller.html#position-prop">position</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-animationcontroller.html#positionOffset-prop">positionOffset</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-animationcontroller.html#positionScale-prop">positionScale</a></b></b> : real</li>
<li class="fn"><b><b><a href="qml-qt3d-animation-animationcontroller.html#recursive-prop">recursive</a></b></b> : bool</li>
</ul>
<a name="methods"></a>
<h2 id="methods">Methods</h2>
<ul>
<li class="fn">int <b><b><a href="qml-qt3d-animation-animationcontroller.html#getAnimationIndex-method">getAnimationIndex</a></b></b>(<i>name</i>)</li>
<li class="fn">AnimationGroup <b><b><a href="qml-qt3d-animation-animationcontroller.html#getGroup-method">getGroup</a></b></b>(<i>index</i>)</li>
</ul>
<!-- $$$AnimationController-description -->
<a name="details"></a>
<h2 id="details">Detailed Description</h2>
<p><a href="qml-qt3d-animation-animationcontroller.html">AnimationController</a> type controls the selection and playback of animations. The type can be used to find all animations from Entity tree and create <a href="qml-qt3d-animation-animationgroup.html">AnimationGroups</a> from the animations with the same name. The user can select which animation group is currently controlled with the animation controller by setting the active animation. The animation position is then propagated to that group after scaling and offsetting the provided position value with the <a href="qml-qt3d-animation-animationcontroller.html#positionScale-prop">positionScale</a> and <a href="qml-qt3d-animation-animationcontroller.html#positionOffset-prop">positionOffset</a> values.</p>
<p><b>Note: </b>that the animation controller doesn't have internal timer, but instead the user is responsible for updating the position property in timely manner.</p><!-- @@@AnimationController -->
<h2>Property Documentation</h2>
<!-- $$$activeAnimationGroup -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="activeAnimationGroup-prop">
<td class="tblQmlPropNode"><p>
<a name="activeAnimationGroup-prop"></a><span class="name">activeAnimationGroup</span> : <span class="type">int</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the currectly active animation group.</p>
</div></div><!-- @@@activeAnimationGroup -->
<br/>
<!-- $$$animationGroups -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="animationGroups-prop">
<td class="tblQmlPropNode"><p>
<a name="animationGroups-prop"></a><span class="name">animationGroups</span> : <span class="type">list</span><<span class="type"><a href="qml-qt3d-animation-animationgroup.html">AnimationGroup</a></span>></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the list of animation groups in the controller.</p>
</div></div><!-- @@@animationGroups -->
<br/>
<!-- $$$entity -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="entity-prop">
<td class="tblQmlPropNode"><p>
<a name="entity-prop"></a><span class="name">entity</span> : <span class="type"><a href="qml-qt3d-core-entity.html">Entity</a></span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the entity animations are gathered and grouped from. If the controller already holds animations, they are cleared.</p>
</div></div><!-- @@@entity -->
<br/>
<!-- $$$position -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="position-prop">
<td class="tblQmlPropNode"><p>
<a name="position-prop"></a><span class="name">position</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the current position of the animation. When the position is set, it is scaled and offset with <a href="qml-qt3d-animation-animationcontroller.html#positionScale-prop">positionScale</a>/<a href="qml-qt3d-animation-animationcontroller.html#positionOffset-prop">positionOffset</a> and propagated to the active animation group.</p>
</div></div><!-- @@@position -->
<br/>
<!-- $$$positionOffset -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="positionOffset-prop">
<td class="tblQmlPropNode"><p>
<a name="positionOffset-prop"></a><span class="name">positionOffset</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the position offset of the animation.</p>
</div></div><!-- @@@positionOffset -->
<br/>
<!-- $$$positionScale -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="positionScale-prop">
<td class="tblQmlPropNode"><p>
<a name="positionScale-prop"></a><span class="name">positionScale</span> : <span class="type">real</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds the position scale of the animation.</p>
</div></div><!-- @@@positionScale -->
<br/>
<!-- $$$recursive -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="recursive-prop">
<td class="tblQmlPropNode"><p>
<a name="recursive-prop"></a><span class="name">recursive</span> : <span class="type">bool</span></p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Holds whether the recursively search the entity tree when gathering animations from the entity. If set to true, the animations are searched also from the child entities of the entity. If set to false, only the entity passed to the controller is searched.</p>
</div></div><!-- @@@recursive -->
<br/>
<h2>Method Documentation</h2>
<!-- $$$getAnimationIndex -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="getAnimationIndex-method">
<td class="tblQmlFuncNode"><p>
<a name="getAnimationIndex-method"></a><span class="type">int</span> <span class="name">getAnimationIndex</span>(<i>name</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the index of the animation with <i>name</i>. Returns -1 if no <a href="qml-qt3d-animation-animationgroup.html">AnimationGroup</a> with the given name is found.</p>
</div></div><!-- @@@getAnimationIndex -->
<br/>
<!-- $$$getGroup -->
<div class="qmlitem"><div class="qmlproto">
<div class="table"><table class="qmlname">
<tr valign="top" class="odd" id="getGroup-method">
<td class="tblQmlFuncNode"><p>
<a name="getGroup-method"></a><span class="type"><a href="qml-qt3d-animation-animationgroup.html">AnimationGroup</a></span> <span class="name">getGroup</span>(<i>index</i>)</p></td></tr>
</table></div>
</div><div class="qmldoc"><p>Returns the <a href="qml-qt3d-animation-animationgroup.html">AnimationGroup</a> with the given <i>index</i>.</p>
</div></div><!-- @@@getGroup -->
<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>
