class QSkeletonLoader¶

Used to load a skeleton of joints from file. More…

Synopsis¶

Properties¶

createJointsEnabledᅟ - A boolean to indicate whether createJoints is enabled or not
rootJointᅟ
sourceᅟ
statusᅟ

Methods¶

def __init__()
def isCreateJointsEnabled()
def rootJoint()
def source()
def status()

Signals¶

def createJointsEnabledChanged()
def rootJointChanged()
def sourceChanged()
def statusChanged()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

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.

class Status¶

This enum identifies the status of skeleton.

Constant

Description

Qt3DCore.QSkeletonLoader.NotReady

The skeleton has not been loaded yet

Qt3DCore.QSkeletonLoader.Ready

The skeleton was successfully loaded

Qt3DCore.QSkeletonLoader.Error

An error occurred while loading the skeleton

Constant	Description
Qt3DCore.QSkeletonLoader.NotReady	The skeleton has not been loaded yet
Qt3DCore.QSkeletonLoader.Ready	The skeleton was successfully loaded
Qt3DCore.QSkeletonLoader.Error	An error occurred while loading the skeleton

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property createJointsEnabledᅟ: bool¶

This property holds A boolean to indicate whether createJoints is enabled or not..

Access functions:

isCreateJointsEnabled()
setCreateJointsEnabled()
Signal createJointsEnabledChanged()

property rootJointᅟ: QJoint¶

Access functions:

rootJoint()
Signal rootJointChanged()

property sourceᅟ: QUrl¶

Holds the source url from which to load the skeleton.

Access functions:

source()
setSource()
Signal sourceChanged()

property statusᅟ: Qt3DCore.QSkeletonLoader.Status¶

Holds the current status of skeleton loading.

Access functions:

status()
Signal statusChanged()

__init__([parent=None])¶

Parameters:: parent – QNode

Constructs a new QSkeletonLoader with parent.

__init__(source[, parent=None])

Parameters:

source – QUrl
parent – QNode

Constructs a new QSkeletonLoader with parent and sets the source.

createJointsEnabledChanged(createJointsEnabled)¶

Parameters:: createJointsEnabled – bool

Notification signal of property createJointsEnabledᅟ .

isCreateJointsEnabled()¶

Return type:: bool

Returns a boolean indicating whether CreateJoints is enabled or not. The default value is false.

Getter of property createJointsEnabledᅟ .

rootJoint()¶

Return type:: QJoint

Returns the root joint of the hierarchy of joints forming the skeleton.

Getter of property rootJointᅟ .

rootJointChanged(rootJoint)¶

Parameters:: rootJoint – QJoint

Notification signal of property rootJointᅟ .

setCreateJointsEnabled(enabled)¶

Parameters:: enabled – bool