QArmature Class | Qt 3D 5.12.7

Qt 5.12 | Qt 3D | C++ Classes | QArmature

Qt 5.12.7 Reference Documentation

# QArmature Class

(Qt3DCore::QArmature)

Used to calculate skinning transform matrices and set them on shaders. More...

Header: | #include <QArmature>
qmake: | QT += 3dcore
Since: | Qt 5.10
Instantiated By: | Armature
Inherits: | Qt3DCore::QComponent

- List of all members, including inherited members
- Obsolete members

## Properties

- skeleton : Qt3DCore::QAbstractSkeleton*

- 1 property inherited from Qt3DCore::QComponent
- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject

## Public Functions

| QArmature(Qt3DCore::QNode *parent = nullptr)
Qt3DCore::QAbstractSkeleton * | skeleton() const

- 2 public functions inherited from Qt3DCore::QComponent
- 13 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject

## Public Slots

void | setSkeleton(Qt3DCore::QAbstractSkeleton *skeleton)

- 1 public slot inherited from Qt3DCore::QComponent
- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject

## Signals

void | skeletonChanged(Qt3DCore::QAbstractSkeleton *skeleton)

- 3 signals inherited from Qt3DCore::QComponent
- 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

- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject

## Detailed Description

Used to calculate skinning transform matrices and set them on shaders.

The Armature component is aggregated by entities to give them the ability to calculate the palette of skinning transform matrices needed to properly render skinned meshes.

Each vertex in a skinned mesh is associated (bound) to up to 4 joints in a skeleton. For each joint affecting a vertex the mesh also provides a weight which determines the level of influence of the corresponding joint. The skinning palette used for performing the transformation of skinned vertices is provided by the Armature and is calculated from the joints contained in the referenced skeleton.

Updating the local transform of a joint results in the skinning matrices being recalculated and the skinned mesh vertices bound to that joint moving accordingly.

## Property Documentation

### skeleton : Qt3DCore::QAbstractSkeleton*

Holds the skeleton used to calculate the skinning transform matrix palette.

Access functions:

Qt3DCore::QAbstractSkeleton * | skeleton() const
void | setSkeleton(Qt3DCore::QAbstractSkeleton *skeleton)

Notifier signal:

void | skeletonChanged(Qt3DCore::QAbstractSkeleton *skeleton)

## Member Function Documentation

### QArmature::QArmature(Qt3DCore::QNode *parent = nullptr)

Constructs a new QArmature with parent.