<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qskeletonloader.cpp -->
<title>QSkeletonLoader 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 >QSkeletonLoader</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="#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="#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">QSkeletonLoader Class</h1>
<span class="small-subtitle">(<a href="qt3dcore-qskeletonloader.html">Qt3DCore::QSkeletonLoader</a>)<br/></span>
<!-- $$$QSkeletonLoader-brief -->
<p>Used to load a skeleton of joints from file. <a href="#details">More...</a></p>
<!-- @@@QSkeletonLoader -->
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">#include <QSkeletonLoader></span>
</td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> QT += 3dcore</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.10</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Instantiated By:</td><td class="memItemRight bottomAlign"> <a href="qml-qt3d-core-skeletonloader.html">SkeletonLoader</a></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qt3dcore-qabstractskeleton.html">Qt3DCore::QAbstractSkeleton</a></td></tr></table></div><ul>
<li><a href="qt3dcore-qskeletonloader-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="qt3dcore-qskeletonloader.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="qt3dcore-qskeletonloader.html#createJointsEnabled-prop">createJointsEnabled</a></b> : bool</li>
<li class="fn"><b><a href="qt3dcore-qskeletonloader.html#rootJoint-prop">rootJoint</a></b> : Qt3DCore::QJoint* const</li>
<li class="fn"><b><a href="qt3dcore-qskeletonloader.html#source-prop">source</a></b> : QUrl</li>
<li class="fn"><b><a href="qt3dcore-qskeletonloader.html#status-prop">status</a></b> : const Status</li>
</ul>
<ul>
<li class="fn">1 property inherited from <a href="qt3dcore-qabstractskeleton.html#properties">Qt3DCore::QAbstractSkeleton</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="qt3dcore-qskeletonloader.html#QSkeletonLoader">QSkeletonLoader</a></b>(Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.html#QSkeletonLoader-1">QSkeletonLoader</a></b>(const QUrl &<i>source</i>, Qt3DCore::QNode *<i>parent</i> = nullptr)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> bool </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.html#isCreateJointsEnabled">isCreateJointsEnabled</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DCore::QJoint *</td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.html#rootJoint">rootJoint</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QUrl </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.html#source-prop">source</a></b>() const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Qt3DCore::QSkeletonLoader::Status </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.html#status-prop">status</a></b>() const</td></tr>
</table></div>
<ul>
<li class="fn">1 public function inherited from <a href="qt3dcore-qabstractskeleton.html#public-functions">Qt3DCore::QAbstractSkeleton</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="qt3dcore-qskeletonloader.html#createJointsEnabled-prop">setCreateJointsEnabled</a></b>(bool <i>enabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.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>
</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="qt3dcore-qskeletonloader.html#createJointsEnabled-prop">createJointsEnabledChanged</a></b>(bool <i>createJointsEnabled</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.html#rootJoint-prop">rootJointChanged</a></b>(Qt3DCore::QJoint *<i>rootJoint</i>)</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qt3dcore-qskeletonloader.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="qt3dcore-qskeletonloader.html#status-prop">statusChanged</a></b>(Qt3DCore::QSkeletonLoader::Status <i>status</i>)</td></tr>
</table></div>
<ul>
<li class="fn">1 signal inherited from <a href="qt3dcore-qabstractskeleton.html#signals">Qt3DCore::QAbstractSkeleton</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="qt3dcore-qskeletonloader.html#staticMetaObject-var">staticMetaObject</a></b></td></tr>
</table></div>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 protected function inherited from <a href="qt3dcore-qabstractskeleton.html#protected-functions">Qt3DCore::QAbstractSkeleton</a></li>
<li class="fn">2 protected functions inherited from <a href="qt3dcore-qnode.html#protected-functions">Qt3DCore::QNode</a></li>
</ul>
<a name="details"></a>
<!-- $$$QSkeletonLoader-description -->
<div class="descr">
<h2 id="details">Detailed Description</h2>
<p>Used to load a skeleton of joints from file.</p>
<p>Use <a href="qml-qt3d-core-skeletonloader.html">SkeletonLoader</a> if you wish to load a whole skeleton from file rather than creating the joints yourself using Skeleton and Joints. Creating a skeleton and binding the vertices of a mesh to the skeleton is most easily performed in a 3D digital content creation tool such as Blender. The resulting skeleton and mesh can then be exported in a suitable format such as glTF 2 for consumption by Qt 3D.</p>
</div>
<!-- @@@QSkeletonLoader -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Status$$$NotReady$$$Ready$$$Error -->
<h3 class="fn" id="Status-enum"><a name="Status-enum"></a>enum QSkeletonLoader::<span class="name">Status</span></h3>
<p>This enum identifies the status of skeleton.</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>Qt3DCore::QSkeletonLoader::NotReady</code></td><td class="topAlign tblval"><code>0</code></td><td class="topAlign">The skeleton has not been loaded yet</td></tr>
<tr><td class="topAlign"><code>Qt3DCore::QSkeletonLoader::Ready</code></td><td class="topAlign tblval"><code>1</code></td><td class="topAlign">The skeleton was successfully loaded</td></tr>
<tr><td class="topAlign"><code>Qt3DCore::QSkeletonLoader::Error</code></td><td class="topAlign tblval"><code>2</code></td><td class="topAlign">An error occurred while loading the skeleton</td></tr>
</table></div>
<!-- @@@Status -->
</div>
<div class="prop">
<h2>Property Documentation</h2>
<!-- $$$createJointsEnabled-prop$$$isCreateJointsEnabled$$$setCreateJointsEnabledbool$$$createJointsEnabledChangedbool -->
<h3 class="fn" id="createJointsEnabled-prop"><a name="createJointsEnabled-prop"></a><span class="name">createJointsEnabled</span> : <span class="type">bool</span></h3>
<p>This property holds a boolean to indicate whether createJoints is enabled or not.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> bool </td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dcore-qskeletonloader.html#isCreateJointsEnabled">isCreateJointsEnabled</a></b></span>() const</td></tr>
<tr><td class="memItemLeft topAlign rightAlign"> void </td><td class="memItemRight bottomAlign"><span class="name"><b>setCreateJointsEnabled</b></span>(bool <i>enabled</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>createJointsEnabledChanged</b></span>(bool <i>createJointsEnabled</i>)</td></tr>
</table></div>
<!-- @@@createJointsEnabled -->
<!-- $$$rootJoint-prop$$$rootJoint$$$rootJointChangedQt3DCore::QJoint* -->
<h3 class="fn" id="rootJoint-prop"><a name="rootJoint-prop"></a><span class="name">rootJoint</span> : <span class="type"><a href="qt3dcore-qjoint.html">Qt3DCore::QJoint</a></span>* const</h3>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DCore::QJoint *</td><td class="memItemRight bottomAlign"><span class="name"><b><a href="qt3dcore-qskeletonloader.html#rootJoint">rootJoint</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>rootJointChanged</b></span>(Qt3DCore::QJoint *<i>rootJoint</i>)</td></tr>
</table></div>
<!-- @@@rootJoint -->
<!-- $$$source-prop$$$source$$$setSourceconstQUrl&$$$sourceChangedconstQUrl& -->
<h3 class="fn" id="source-prop"><a name="source-prop"></a><span class="name">source</span> : <span class="type">QUrl</span></h3>
<p>Holds the source url from which to load the skeleton.</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$$$statusChangedQt3DCore::QSkeletonLoader::Status -->
<h3 class="fn" id="status-prop"><a name="status-prop"></a><span class="name">status</span> : const <span class="type"><a href="qt3dcore-qskeletonloader.html#Status-enum">Status</a></span></h3>
<p>Holds the current status of skeleton loading.</p>
<p><b>Access functions:</b></p>
<div class="table"><table class="alignedsummary">
<tr><td class="memItemLeft topAlign rightAlign"> Qt3DCore::QSkeletonLoader::Status </td><td class="memItemRight bottomAlign"><span class="name"><b>status</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>(Qt3DCore::QSkeletonLoader::Status <i>status</i>)</td></tr>
</table></div>
<!-- @@@status -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QSkeletonLoader[overload1]$$$QSkeletonLoaderQt3DCore::QNode* -->
<h3 class="fn" id="QSkeletonLoader"><a name="QSkeletonLoader"></a>QSkeletonLoader::<span class="name">QSkeletonLoader</span>(<span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qt3dcore-qskeletonloader.html">QSkeletonLoader</a> with <i>parent</i>.</p>
<!-- @@@QSkeletonLoader -->
<!-- $$$QSkeletonLoader$$$QSkeletonLoaderconstQUrl&Qt3DCore::QNode* -->
<h3 class="fn" id="QSkeletonLoader-1"><a name="QSkeletonLoader-1"></a>QSkeletonLoader::<span class="name">QSkeletonLoader</span>(const <span class="type">QUrl</span> &<i>source</i>, <span class="type"><a href="qt3dcore-qnode.html">Qt3DCore::QNode</a></span> *<i>parent</i> = nullptr)</h3>
<p>Constructs a new <a href="qt3dcore-qskeletonloader.html">QSkeletonLoader</a> with <i>parent</i> and sets the <i>source</i>.</p>
<!-- @@@QSkeletonLoader -->
<!-- $$$isCreateJointsEnabled -->
<h3 class="fn" id="isCreateJointsEnabled"><a name="isCreateJointsEnabled"></a><span class="type">bool</span> QSkeletonLoader::<span class="name">isCreateJointsEnabled</span>() const</h3>
<p>Returns a boolean indicating whether CreateJoints is enabled or not. The default value is <code>false</code>.</p>
<p><b>Note:</b> Getter function for property <a href="qt3dcore-qskeletonloader.html#createJointsEnabled-prop">createJointsEnabled</a>. </p><!-- @@@isCreateJointsEnabled -->
<!-- $$$rootJoint -->
<h3 class="fn" id="rootJoint"><a name="rootJoint"></a><span class="type"><a href="qt3dcore-qjoint.html">Qt3DCore::QJoint</a></span> *QSkeletonLoader::<span class="name">rootJoint</span>() const</h3>
<p>Returns the root joint of the hierarchy of joints forming the skeleton.</p>
<p><b>Note:</b> Getter function for property <a href="qt3dcore-qskeletonloader.html#rootJoint-prop">rootJoint</a>. </p><!-- @@@rootJoint -->
</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>
