QSkeletonLoader Class
(Qt3DCore::QSkeletonLoader)Used to load a skeleton of joints from file. More...
| Header: | #include <QSkeletonLoader> |
| qmake: | QT += 3dcore |
| Since: | Qt 5.10 |
| Instantiated By: | SkeletonLoader |
| Inherits: | Qt3DCore::QAbstractSkeleton |
Public Types
| enum | Status { NotReady, Ready, Error } |
Properties
- createJointsEnabled : bool
- rootJoint : Qt3DCore::QJoint* const
- source : QUrl
- status : const Status
- 1 property inherited from Qt3DCore::QAbstractSkeleton
- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject
Public Functions
| QSkeletonLoader(Qt3DCore::QNode *parent = nullptr) | |
| QSkeletonLoader(const QUrl &source, Qt3DCore::QNode *parent = nullptr) | |
| bool | isCreateJointsEnabled() const |
| Qt3DCore::QJoint * | rootJoint() const |
| QUrl | source() const |
| Qt3DCore::QSkeletonLoader::Status | status() const |
- 1 public function inherited from Qt3DCore::QAbstractSkeleton
- 13 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject
Public Slots
| void | setCreateJointsEnabled(bool enabled) |
| void | setSource(const QUrl &source) |
- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject
Signals
| void | createJointsEnabledChanged(bool createJointsEnabled) |
| void | rootJointChanged(Qt3DCore::QJoint *rootJoint) |
| void | sourceChanged(const QUrl &source) |
| void | statusChanged(Qt3DCore::QSkeletonLoader::Status status) |
- 1 signal inherited from Qt3DCore::QAbstractSkeleton
- 4 signals inherited from Qt3DCore::QNode
- 2 signals inherited from QObject
Static Public Members
| const QMetaObject | staticMetaObject |
- 9 static public members inherited from QObject
Additional Inherited Members
- 1 protected function inherited from Qt3DCore::QAbstractSkeleton
- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject
Detailed Description
Used to load a skeleton of joints from file.
Use SkeletonLoader 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.
Member Type Documentation
enum QSkeletonLoader::Status
This enum identifies the status of skeleton.
| Constant | Value | Description |
|---|---|---|
Qt3DCore::QSkeletonLoader::NotReady | 0 | The skeleton has not been loaded yet |
Qt3DCore::QSkeletonLoader::Ready | 1 | The skeleton was successfully loaded |
Qt3DCore::QSkeletonLoader::Error | 2 | An error occurred while loading the skeleton |
Property Documentation
createJointsEnabled : bool
This property holds a boolean to indicate whether createJoints is enabled or not.
Access functions:
| bool | isCreateJointsEnabled() const |
| void | setCreateJointsEnabled(bool enabled) |
Notifier signal:
| void | createJointsEnabledChanged(bool createJointsEnabled) |
rootJoint : Qt3DCore::QJoint* const
Access functions:
| Qt3DCore::QJoint * | rootJoint() const |
Notifier signal:
| void | rootJointChanged(Qt3DCore::QJoint *rootJoint) |
source : QUrl
Holds the source url from which to load the skeleton.
Access functions:
| QUrl | source() const |
| void | setSource(const QUrl &source) |
Notifier signal:
| void | sourceChanged(const QUrl &source) |
status : const Status
Holds the current status of skeleton loading.
Access functions:
| Qt3DCore::QSkeletonLoader::Status | status() const |
Notifier signal:
| void | statusChanged(Qt3DCore::QSkeletonLoader::Status status) |
Member Function Documentation
QSkeletonLoader::QSkeletonLoader(Qt3DCore::QNode *parent = nullptr)
Constructs a new QSkeletonLoader with parent.
QSkeletonLoader::QSkeletonLoader(const QUrl &source, Qt3DCore::QNode *parent = nullptr)
Constructs a new QSkeletonLoader with parent and sets the source.
bool QSkeletonLoader::isCreateJointsEnabled() const
Returns a boolean indicating whether CreateJoints is enabled or not. The default value is false.
Note: Getter function for property createJointsEnabled.
Qt3DCore::QJoint *QSkeletonLoader::rootJoint() const
Returns the root joint of the hierarchy of joints forming the skeleton.
Note: Getter function for property rootJoint.
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. 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.