<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qclipanimator.cpp -->
<title>QClipAnimator Class | 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-cpp.html">C++ Classes</a></td><td >QClipAnimator</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="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#public-slots">Public Slots</a></li>
<li class="level1"><a href="#signals">Signals</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</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">QClipAnimator Class</h1>
<span class="small-subtitle">(<a href="qt3danimation-qclipanimator.html">Qt3DAnimation::QClipAnimator</a>)<br/></span>
<!-- $$$QClipAnimator-brief -->
<p><a href="qt3danimation-qclipanimator.html">QClipAnimator</a> is a component providing simple animation playback capabilities. <a href="#details">More...</a></p>
<!-- @@@QClipAnimator -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QClipAnimator></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3danimation</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"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-animation-clipanimator.html">ClipAnimator</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3danimation-qabstractclipanimator.html">Qt3DAnimation::QAbstractClipAnimator</a></td></tr></table></div><ul>
<li><a href="qt3danimation-qclipanimator-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><a href="qt3danimation-qclipanimator.html#clip-prop">clip</a></b> : Qt3DAnimation::QAbstractAnimationClip*</li>
</ul>
<ul>
<li class="fn">5 properties inherited from <a href="qt3danimation-qabstractclipanimator.html#properties">Qt3DAnimation::QAbstractClipAnimator</a></li>
<li class="fn">1 property inherited from <a href="qt3dcore-qcomponent.html#properties">Qt3DCore::QComponent</a></li>
<li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li>
</ul>
<a name="public-functions"></a>
<h2 id="public-functions">Public Functions</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qclipanimator.html#QClipAnimator">QClipAnimator</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qclipanimator.html#dtor.QClipAnimator">~QClipAnimator</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DAnimation::QAbstractAnimationClip *</td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qclipanimator.html#clip-prop">clip</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">5 public functions inherited from <a href="qt3danimation-qabstractclipanimator.html#public-functions">Qt3DAnimation::QAbstractClipAnimator</a></li>
<li class="fn">2 public functions inherited from <a href="qt3dcore-qcomponent.html#public-functions">Qt3DCore::QComponent</a></li>
<li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="public-slots"></a>
<h2 id="public-slots">Public Slots</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qclipanimator.html#clip-prop">setClip</a></b>(Qt3DAnimation::QAbstractAnimationClip *<i>clip</i>)</td></tr>
</table></div>
<ul>
<li class="fn">7 public slots inherited from <a href="qt3danimation-qabstractclipanimator.html#public-slots">Qt3DAnimation::QAbstractClipAnimator</a></li>
<li class="fn">1 public slot inherited from <a href="qt3dcore-qcomponent.html#public-slots">Qt3DCore::QComponent</a></li>
<li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li>
</ul>
<a name="signals"></a>
<h2 id="signals">Signals</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qclipanimator.html#clip-prop">clipChanged</a></b>(Qt3DAnimation::QAbstractAnimationClip *<i>clip</i>)</td></tr>
</table></div>
<ul>
<li class="fn">5 signals inherited from <a href="qt3danimation-qabstractclipanimator.html#signals">Qt3DAnimation::QAbstractClipAnimator</a></li>
<li class="fn">3 signals inherited from <a href="qt3dcore-qcomponent.html#signals">Qt3DCore::QComponent</a></li>
<li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li>
</ul>
<a name="static-public-members"></a>
<h2 id="static-public-members">Static Public Members</h2>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> const QMetaObject </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qclipanimator.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QClipAnimator-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p><a href="qt3danimation-qclipanimator.html">QClipAnimator</a> is a component providing simple animation playback capabilities.</p>
<p>An instance of <a href="qt3danimation-qclipanimator.html">QClipAnimator</a> can be aggregated by a QEntity to add the ability to play back animation clips and to apply the calculated animation values to properties of QObjects.</p>
<p>The animation key frame data is provided via the clip property. This can be created programmatically with <a href="qt3danimation-qanimationclip.html">QAnimationClip</a> or loaded from file with <a href="qt3danimation-qanimationcliploader.html">QAnimationClipLoader</a>.</p>
<p>In order to apply the values played back from the channels of data in the animation clip, the clip animator needs to have a <a href="qt3danimation-qchannelmapper.html">QChannelMapper</a> object assigned to the <a href="qt3danimation-qabstractclipanimator.html#channelMapper-prop">channelMapper</a> property.</p>
<p>The properties for controlling the animator are provided by the <a href="qt3danimation-qabstractclipanimator.html">QAbstractClipAnimator</a> base class.</p>
</div>
<p><b>See also </b><a href="qt3danimation-qabstractclipanimator.html">QAbstractClipAnimator</a>, <a href="qt3danimation-qabstractanimationclip.html">QAbstractAnimationClip</a>, <a href="qt3danimation-qchannelmapper.html">QChannelMapper</a>, and <a href="qt3danimation-qblendedclipanimator.html">QBlendedClipAnimator</a>.</p>
<!-- @@@QClipAnimator -->
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$clip-prop$$$clip$$$setClipQt3DAnimation::QAbstractAnimationClip*$$$clipChangedQt3DAnimation::QAbstractAnimationClip* -->
<h3 class="fn" id="clip-prop"><a name="clip-prop"></a><span class="name">clip</span> : <span class="type"><a href="qt3danimation-qabstractanimationclip.html">Qt3DAnimation::QAbstractAnimationClip</a></span>*</h3>
<p>This property holds the animation clip which contains the key frame data to be played back. The key frame data can be specified in either a <a href="qt3danimation-qanimationclip.html">QAnimationClip</a> or <a href="qt3danimation-qanimationcliploader.html">QAnimationClipLoader</a>.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DAnimation::QAbstractAnimationClip *</td><td class="memItemRight bottomAlign"><span class="name"><b>clip</b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setClip</b></span>(Qt3DAnimation::QAbstractAnimationClip *<i>clip</i>)</td></tr>
</table></div>
<p><b>Notifier signal:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>clipChanged</b></span>(Qt3DAnimation::QAbstractAnimationClip *<i>clip</i>)</td></tr>
</table></div>
<!-- @@@clip -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QClipAnimator[overload1]$$$QClipAnimatorQt3DCore::QNode* -->
<h3 class="fn" id="QClipAnimator"><a name="QClipAnimator"></a>QClipAnimator::<span class="name">QClipAnimator</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Default constructs an instance of QClipAnimator.</p><!-- @@@QClipAnimator -->
<!-- $$$~QClipAnimator[overload1]$$$~QClipAnimator -->
<h3 class="fn" id="dtor.QClipAnimator"><a name="dtor.QClipAnimator"></a><code>[virtual] </code>QClipAnimator::<span class="name">~QClipAnimator</span>()</h3>
<p>Destroys the instance of QClipAnimator. The destructor is virtual.</p><!-- @@@~QClipAnimator -->
</div>
</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>
