Qt3DAnimation::QMorphingAnimation Class | Qt 3D | Qt 6.12.0
Description: A class implementing blend-shape morphing animation.
Keywords: class

- Qt 6.12
- Qt 3D
- C++ Classes
- Qt3DAnimation (Deprecated)
- QMorphingAnimation
- Qt 6.12.0 Reference Documentation

# Qt3DAnimation::QMorphingAnimation Class

class Qt3DAnimation::QMorphingAnimation

A class implementing blend-shape morphing animation. More...

Header: | `#include <qmorphinganimation.h>`
CMake: | `find_package(Qt6 REQUIRED COMPONENTS 3danimation)` `target_link_libraries(mytarget PRIVATE Qt6::3danimation)`
qmake: | `QT += 3danimation`
In QML: | MorphingAnimation
Inherits: | Qt3DAnimation::QAbstractAnimation
Status: | Technology preview

This class is in technology preview and is subject to change.

- List of all members, including inherited members

## Public Types

enum | Method { Normalized, Relative }

## Properties

easing : QEasingCurve interpolator : float method : Method | target : Qt3DRender::QGeometryRenderer* targetName : QString targetPositions : QVector<float>

## Public Functions

| QMorphingAnimation(QObject *parent = nullptr)
void | addMorphTarget(Qt3DAnimation::QMorphTarget *target)
QEasingCurve | easing() const
QVector<float> | getWeights(int positionIndex)
float | interpolator() const
Qt3DAnimation::QMorphingAnimation::Method | method() const
QVector<Qt3DAnimation::QMorphTarget *> | morphTargetList()
void | removeMorphTarget(Qt3DAnimation::QMorphTarget *target)
void | setMorphTargets(const QVector<Qt3DAnimation::QMorphTarget *> &targets)
void | setWeights(int positionIndex, const QVector<float> &weights)
Qt3DRender::QGeometryRenderer * | target() const
QString | targetName() const
QVector<float> | targetPositions() const

## Public Slots

void | setEasing(const QEasingCurve &easing)
void | setMethod(Qt3DAnimation::QMorphingAnimation::Method method)
void | setTarget(Qt3DRender::QGeometryRenderer *target)
void | setTargetName(const QString name)
void | setTargetPositions(const QVector<float> &targetPositions)

## Signals

void | easingChanged(const QEasingCurve &easing)
void | interpolatorChanged(float interpolator)
void | methodChanged(Qt3DAnimation::QMorphingAnimation::Method method)
void | targetChanged(Qt3DRender::QGeometryRenderer *target)
void | targetNameChanged(const QString &name)
void | targetPositionsChanged(const QVector<float> &targetPositions)

## Detailed Description

A Qt3DAnimation::QMorphingAnimation class implements blend-shape morphing animation to a target QGeometryRenderer. The QMorphingAnimation sets the correct QAttributes from the morph targets to the target QGeometryRenderer::geometry and calculates interpolator for the current position. The actual blending between the attributes must be implemented in the material. Qt3DAnimation::QMorphPhongMaterial implements material with morphing support for phong lighting model. The blending happens between 2 attributes - 'base' and 'target'. The names for the base and target attributes are taken from the morph target names, where the base attribute retains the name it already has and the target attribute name gets 'Target' appended to the name. The interpolator can be set as a QParameter to the used material. All morph targets in the animation should contain the attributes with same names as those in the base geometry.

## Member Type Documentation

### enum QMorphingAnimation::Method

This enumeration specifies the morphing method.

Constant | Value | Description
--- | --- | ---
`Qt3DAnimation::QMorphingAnimation::Normalized` | `0` | The blending should use the normalized formula; V' = Vbase * (1.0 - sum(Wi)) + sum[Vi * Wi]
`Qt3DAnimation::QMorphingAnimation::Relative` | `1` | The blending should use the relative formula; V' = Vbase + sum[Vi * Wi]

## Property Documentation

### easing : QEasingCurve

Holds the easing curve of the interpolator between morph targets.

Access functions:

QEasingCurve | easing() const
void | setEasing(const QEasingCurve &easing)

Notifier signal:

void | easingChanged(const QEasingCurve &easing)

### `[read-only]` interpolator : float

Holds the interpolator between base and target attributes.

Access functions:

float | interpolator() const

Notifier signal:

void | interpolatorChanged(float interpolator)

### method : Method

Holds the morphing method. The default is Relative.

Access functions:

Qt3DAnimation::QMorphingAnimation::Method | method() const
void | setMethod(Qt3DAnimation::QMorphingAnimation::Method method)

Notifier signal:

void | methodChanged(Qt3DAnimation::QMorphingAnimation::Method method)

### target : Qt3DRender::QGeometryRenderer*

Holds the target QGeometryRenderer the morphing animation is applied to.

Access functions:

Qt3DRender::QGeometryRenderer * | target() const
void | setTarget(Qt3DRender::QGeometryRenderer *target)

Notifier signal:

void | targetChanged(Qt3DRender::QGeometryRenderer *target)

### targetName : QString

Holds the name of the target geometry. This is a convenience property making it easier to match the target geometry to the morphing animation. The name is usually same as the name of the parent entity of the target QGeometryRenderer, but does not have to be.

Access functions:

QString | targetName() const
void | setTargetName(const QString name)

Notifier signal:

void | targetNameChanged(const QString &name)

### targetPositions : QVector<float>

Holds the position values of the morph target. Each position in the list specifies the position of the corresponding morph target with the same index. The values must be in an ascending order. Values can be positive or negative and do not have any predefined unit.

Access functions:

QVector<float> | targetPositions() const
void | setTargetPositions(const QVector<float> &targetPositions)

Notifier signal:

void | targetPositionsChanged(const QVector<float> &targetPositions)

## Member Function Documentation

### `[explicit]` QMorphingAnimation::QMorphingAnimation(QObject *parent = nullptr)

Construct a new QMorphingAnimation with parent.

### void QMorphingAnimation::addMorphTarget(Qt3DAnimation::QMorphTarget *target)

Add new morph target at the end of the animation.

### QVector<float> QMorphingAnimation::getWeights(int positionIndex)

Return morph weights at positionIndex.

### QVector<Qt3DAnimation::QMorphTarget *> QMorphingAnimation::morphTargetList()

Return morph target list.

### void QMorphingAnimation::removeMorphTarget(Qt3DAnimation::QMorphTarget *target)

Remove morph target from the animation.

### void QMorphingAnimation::setMorphTargets(const QVector<Qt3DAnimation::QMorphTarget *> &targets)

Set morph targets to animation. Old targets are cleared.

### void QMorphingAnimation::setWeights(int positionIndex, const QVector<float> &weights)

Sets morph weights at positionIndex.