QAdditiveClipBlend Class
(Qt3DAnimation::QAdditiveClipBlend)Performs an additive blend of two animation clips based on an additive factor. More...
Header: | #include <QAdditiveClipBlend> |
qmake: | QT += 3danimation |
Since: | Qt 5.9 |
Instantiated By: | AdditiveClipBlend |
Inherits: | Qt3DAnimation::QAbstractClipBlendNode |
Properties
- additiveClip : Qt3DAnimation::QAbstractClipBlendNode*
- additiveFactor : float
- baseClip : Qt3DAnimation::QAbstractClipBlendNode*
- 3 properties inherited from Qt3DCore::QNode
- 1 property inherited from QObject
Public Functions
QAdditiveClipBlend(Qt3DCore::QNode *parent = nullptr) | |
virtual | ~QAdditiveClipBlend() |
Qt3DAnimation::QAbstractClipBlendNode * | additiveClip() const |
float | additiveFactor() const |
Qt3DAnimation::QAbstractClipBlendNode * | baseClip() const |
- 13 public functions inherited from Qt3DCore::QNode
- 31 public functions inherited from QObject
Public Slots
void | setAdditiveClip(Qt3DAnimation::QAbstractClipBlendNode *additiveClip) |
void | setAdditiveFactor(float additiveFactor) |
void | setBaseClip(Qt3DAnimation::QAbstractClipBlendNode *baseClip) |
- 3 public slots inherited from Qt3DCore::QNode
- 1 public slot inherited from QObject
Signals
void | additiveClipChanged(Qt3DAnimation::QAbstractClipBlendNode *additiveClip) |
void | additiveFactorChanged(float additiveFactor) |
void | baseClipChanged(Qt3DAnimation::QAbstractClipBlendNode *baseClip) |
- 4 signals inherited from Qt3DCore::QNode
- 2 signals inherited from QObject
Static Public Members
const QMetaObject | staticMetaObject |
- 9 static public members inherited from QObject
Protected Functions
QAdditiveClipBlend(Qt3DAnimation::QAdditiveClipBlendPrivate &dd, Qt3DCore::QNode *parent = nullptr) |
- 2 protected functions inherited from Qt3DCore::QNode
- 9 protected functions inherited from QObject
Detailed Description
Performs an additive blend of two animation clips based on an additive factor.
QAdditiveClipBlend can be useful to create advanced animation effects based on individual animation clips. For example, if you:
- set the baseClip property to a normal walk cycle animation clip and
- set the additiveClip property to a shaking head difference clip,
then adjusting the additiveFactor property will control how much of the additiveClip gets added on to the baseClip. This has he effect that with an additiveFactor of zero, this blend node will yield the original walk cycle clip. With an additiveFactor of 1, it will yield the walk cycle including a shaking head animation.
The blending operation implemented by this class is:
resultClip = baseClip + additiveFactor * additiveClip
There is nothing stopping you from using values for the additiveFacor property outside the 0 to 1 range, but please be aware that the input animation clips may not be authored in such a way for this to make sense.
See also QBlendedClipAnimator.
Property Documentation
additiveClip : Qt3DAnimation::QAbstractClipBlendNode*
This property holds the additive clip to be blended with the baseClip. The amount of blending is controlled by the additiveFactor property.
Access functions:
Qt3DAnimation::QAbstractClipBlendNode * | additiveClip() const |
void | setAdditiveClip(Qt3DAnimation::QAbstractClipBlendNode *additiveClip) |
Notifier signal:
void | additiveClipChanged(Qt3DAnimation::QAbstractClipBlendNode *additiveClip) |
additiveFactor : float
Specifies the blending factor, typically between 0 and 1, to control the blending of two animation clips.
Access functions:
float | additiveFactor() const |
void | setAdditiveFactor(float additiveFactor) |
Notifier signal:
void | additiveFactorChanged(float additiveFactor) |
baseClip : Qt3DAnimation::QAbstractClipBlendNode*
This property holds the base animation clip. When the additiveFactor is zero the baseClip will also be the resulting clip of this blend node.
Access functions:
Qt3DAnimation::QAbstractClipBlendNode * | baseClip() const |
void | setBaseClip(Qt3DAnimation::QAbstractClipBlendNode *baseClip) |
Notifier signal:
void | baseClipChanged(Qt3DAnimation::QAbstractClipBlendNode *baseClip) |
Member Function Documentation
QAdditiveClipBlend::QAdditiveClipBlend(Qt3DCore::QNode *parent = nullptr)
Default constructs an instance of QAdditiveClipBlend.
[protected]
QAdditiveClipBlend::QAdditiveClipBlend(Qt3DAnimation::QAdditiveClipBlendPrivate &dd, Qt3DCore::QNode *parent = nullptr)
Default constructs an instance of QAdditiveClipBlend.
[virtual]
QAdditiveClipBlend::~QAdditiveClipBlend()
Destroys the instance of QAdditiveClipBlend. The destructor is virtual.
© 2019 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.