<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html> <html lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <!-- qanimationcliploader.cpp --> <title>QAnimationClipLoader Class | Qt 3D 5.11</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 ><a href="../qtdoc/index.html">Qt 5.11</a></td><td ><a href="qt3d-index.html">Qt 3D</a></td><td ><a href="qt3d-cpp.html">C++ Classes</a></td><td >QAnimationClipLoader</td></tr></table><table class="buildversion"><tr> <td id="buildversion" width="100%" align="right">Qt 5.11.2 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="#public-types">Public Types</a></li> <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="#protected-functions">Protected Functions</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">QAnimationClipLoader Class</h1> <span class="small-subtitle">(<a href="qt3danimation-qanimationcliploader.html">Qt3DAnimation::QAnimationClipLoader</a>)<br/></span> <!-- $$$QAnimationClipLoader-brief --> <p>Enables loading key frame animation data from a file. <a href="#details">More...</a></p> <!-- @@@QAnimationClipLoader --> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QAnimationClipLoader></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"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3danimation-qabstractanimationclip.html">Qt3DAnimation::QAbstractAnimationClip</a></td></tr></table></div><ul> <li><a href="qt3danimation-qanimationcliploader-members.html">List of all members, including inherited members</a></li> </ul> <a name="public-types"></a> <h2 id="public-types">Public Types</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qanimationcliploader.html#Status-enum">Status</a></b> { NotReady, Ready, Error }</td></tr> </table></div> <a name="properties"></a> <h2 id="properties">Properties</h2> <ul> <li class="fn"><b><a href="qt3danimation-qanimationcliploader.html#source-prop">source</a></b> : QUrl</li> <li class="fn"><b><a href="qt3danimation-qanimationcliploader.html#status-prop">status</a></b> : const Status</li> </ul> <ul> <li class="fn">1 property inherited from <a href="qt3danimation-qabstractanimationclip.html#properties">Qt3DAnimation::QAbstractAnimationClip</a></li> <li class="fn">3 properties inherited from <a href="qt3dcore-qnode.html#properties">Qt3DCore::QNode</a></li> <li class="fn">1 property inherited from <a href="../qtcore/qobject.html#properties">QObject</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-qanimationcliploader.html#QAnimationClipLoader">QAnimationClipLoader</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qanimationcliploader.html#QAnimationClipLoader-1">QAnimationClipLoader</a></b>(const QUrl &<i>source</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qanimationcliploader.html#dtor.QAnimationClipLoader">~QAnimationClipLoader</a></b>()</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qanimationcliploader.html#source-prop">source</a></b>() const</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> Qt3DAnimation::QAnimationClipLoader::Status </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qanimationcliploader.html#status">status</a></b>() const</td></tr> </table></div> <ul> <li class="fn">1 public function inherited from <a href="qt3danimation-qabstractanimationclip.html#public-functions">Qt3DAnimation::QAbstractAnimationClip</a></li> <li class="fn">13 public functions inherited from <a href="qt3dcore-qnode.html#public-functions">Qt3DCore::QNode</a></li> <li class="fn">34 public functions inherited from <a href="../qtcore/qobject.html#public-functions">QObject</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-qanimationcliploader.html#source-prop">setSource</a></b>(const QUrl &<i>source</i>)</td></tr> </table></div> <ul> <li class="fn">3 public slots inherited from <a href="qt3dcore-qnode.html#public-slots">Qt3DCore::QNode</a></li> <li class="fn">1 public slot inherited from <a href="../qtcore/qobject.html#public-slots">QObject</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-qanimationcliploader.html#source-prop">sourceChanged</a></b>(const QUrl &<i>source</i>)</td></tr> <tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qanimationcliploader.html#status-prop">statusChanged</a></b>(Qt3DAnimation::QAnimationClipLoader::Status <i>status</i>)</td></tr> </table></div> <ul> <li class="fn">1 signal inherited from <a href="qt3danimation-qabstractanimationclip.html#signals">Qt3DAnimation::QAbstractAnimationClip</a></li> <li class="fn">4 signals inherited from <a href="qt3dcore-qnode.html#signals">Qt3DCore::QNode</a></li> <li class="fn">2 signals inherited from <a href="../qtcore/qobject.html#signals">QObject</a></li> </ul> <a name="protected-functions"></a> <h2 id="protected-functions">Protected Functions</h2> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3danimation-qanimationcliploader.html#QAnimationClipLoader-2">QAnimationClipLoader</a></b>(Qt3DAnimation::QAnimationClipLoaderPrivate &<i>dd</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr> </table></div> <ul> <li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li> <li class="fn">9 protected functions inherited from <a href="../qtcore/qobject.html#protected-functions">QObject</a></li> </ul> <h3>Additional Inherited Members</h3> <ul> <li class="fn">1 public variable inherited from <a href="../qtcore/qobject.html#public-variables">QObject</a></li> <li class="fn">10 static public members inherited from <a href="../qtcore/qobject.html#static-public-members">QObject</a></li> <li class="fn">2 protected variables inherited from <a href="../qtcore/qobject.html#protected-variables">QObject</a></li> </ul> <a name="details"></a> <!-- $$$QAnimationClipLoader-description --> <div class="descr"> <h2 id="details">Detailed Description</h2> <p>Enables loading key frame animation data from a file.</p> </div> <!-- @@@QAnimationClipLoader --> <div class="types"> <h2>Member Type Documentation</h2> <!-- $$$Status$$$NotReady$$$Ready$$$Error --> <h3 class="fn" id="Status-enum"><a name="Status-enum"></a>enum QAnimationClipLoader::<span class="name">Status</span></h3> <p>This enum identifies the status of animation clip.</p> <div class="table"><table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr> <tr><td class="topAlign"><code>Qt3DAnimation::QAnimationClipLoader::NotReady</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The clip has not been loaded yet</td></tr> <tr><td class="topAlign"><code>Qt3DAnimation::QAnimationClipLoader::Ready</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The clip was successfully loaded</td></tr> <tr><td class="topAlign"><code>Qt3DAnimation::QAnimationClipLoader::Error</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">An error occurred while loading the clip</td></tr> </table></div> <!-- @@@Status --> </div> <div class="prop"> <h2>Property Documentation</h2> <!-- $$$source-prop$$$source$$$setSourceconstQUrl&$$$sourceChangedconstQUrl& --> <h3 class="fn" id="source-prop"><a name="source-prop"></a><span class="name">source</span> : <span class="type"><a href="../qtcore/qurl.html">QUrl</a></span></h3> <p>Holds the source URL from which to load the animation clip. Currently glTF2 and the native Qt 3D json animation file formats are supported.</p> <p>In the case where a file contains multiple animations, it is possible to select which animation should be loaded by way of query parameters on the source url. The accepted query parameters are animationIndex and animationName. If both are specified, animationName is ignored.</p> <p>If a file contains only a single animation, there is no need to specify the animationIndex or animationName. We simply use the one available animation.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> QUrl </td><td class="memItemRight bottomAlign"><span class="name"><b>source</b></span>() const</td></tr> <tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setSource</b></span>(const QUrl &<i>source</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>sourceChanged</b></span>(const QUrl &<i>source</i>)</td></tr> </table></div> <!-- @@@source --> <!-- $$$status-prop$$$status$$$statusChangedQt3DAnimation::QAnimationClipLoader::Status --> <h3 class="fn" id="status-prop"><a name="status-prop"></a><span class="name">status</span> : const <span class="type"><a href="qt3danimation-qanimationcliploader.html#Status-enum">Status</a></span></h3> <p>This property contains the status of the animation clip.</p> <p><b>Access functions:</b></p> <div class="table"><table class="alignedsummary"> <tr><td class="memItemLeft topAlign rightAlign"> Qt3DAnimation::QAnimationClipLoader::Status </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3danimation-qanimationcliploader.html#status">status</a></b></span>() const</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>statusChanged</b></span>(Qt3DAnimation::QAnimationClipLoader::Status <i>status</i>)</td></tr> </table></div> <!-- @@@status --> </div> <div class="func"> <h2>Member Function Documentation</h2> <!-- $$$QAnimationClipLoader[overload1]$$$QAnimationClipLoaderQt3DCore::QNode* --> <h3 class="fn" id="QAnimationClipLoader"><a name="QAnimationClipLoader"></a>QAnimationClipLoader::<span class="name">QAnimationClipLoader</span>(<span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QAnimationClipLoader.</p><!-- @@@QAnimationClipLoader --> <!-- $$$QAnimationClipLoader$$$QAnimationClipLoaderconstQUrl&Qt3DCore::QNode* --> <h3 class="fn" id="QAnimationClipLoader-1"><a name="QAnimationClipLoader-1"></a>QAnimationClipLoader::<span class="name">QAnimationClipLoader</span>(const <span class="type"><a href="../qtcore/qurl.html">QUrl</a></span> &<i>source</i>, <span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QAnimationClipLoader.</p><!-- @@@QAnimationClipLoader --> <!-- $$$QAnimationClipLoader$$$QAnimationClipLoaderQt3DAnimation::QAnimationClipLoaderPrivate&Qt3DCore::QNode* --> <h3 class="fn" id="QAnimationClipLoader-2"><a name="QAnimationClipLoader-2"></a><code>[protected] </code>QAnimationClipLoader::<span class="name">QAnimationClipLoader</span>(<span class="type">Qt3DAnimation::QAnimationClipLoaderPrivate</span> &<i>dd</i>, <span class="type">Qt3DCore::QNode</span> *<i>parent</i> = nullptr)</h3> <p>Default constructs an instance of QAnimationClipLoader.</p><!-- @@@QAnimationClipLoader --> <!-- $$$~QAnimationClipLoader[overload1]$$$~QAnimationClipLoader --> <h3 class="fn" id="dtor.QAnimationClipLoader"><a name="dtor.QAnimationClipLoader"></a><code>[virtual] </code>QAnimationClipLoader::<span class="name">~QAnimationClipLoader</span>()</h3> <p>Destroys the instance of QAnimationClipLoader. The destructor is virtual.</p><!-- @@@~QAnimationClipLoader --> <!-- $$$status --> <h3 class="fn" id="status"><a name="status"></a><span class="type">Qt3DAnimation::QAnimationClipLoader::Status</span> QAnimationClipLoader::<span class="name">status</span>() const</h3> <p>Returns the status of the animation clip.</p> <p><b>Note:</b> Getter function for property <a href="qt3danimation-qanimationcliploader.html#status-prop">status</a>. </p><!-- @@@status --> </div> </div> </div> </div> </div> </div> <div class="footer"> <p> <acronym title="Copyright">©</acronym> 2018 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>