Revision control
Copy as Markdown
// Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include "qcallbackmapping.h"
#include "qcallbackmapping_p.h"
#include <QtCore/qmetaobject.h>
#include <QtCore/QMetaProperty>
QT_BEGIN_NAMESPACE
namespace Qt3DAnimation {
QCallbackMappingPrivate::QCallbackMappingPrivate()
: QAbstractChannelMappingPrivate()
, m_channelName()
, m_type(static_cast<int>(QMetaType::UnknownType))
, m_callback(nullptr)
{
m_mappingType = QAbstractChannelMappingPrivate::CallbackMapping;
}
/*!
\class Qt3DAnimation::QCallbackMapping
\inherits Qt3DCore::QAbstractChannelMapping
\inmodule Qt3DAnimation
\brief Allows to map the channels within the clip onto an invocation
of a callback object.
*/
QCallbackMapping::QCallbackMapping(Qt3DCore::QNode *parent)
: QAbstractChannelMapping(*new QCallbackMappingPrivate, parent)
{
}
QCallbackMapping::QCallbackMapping(QCallbackMappingPrivate &dd, Qt3DCore::QNode *parent)
: QAbstractChannelMapping(dd, parent)
{
}
QCallbackMapping::~QCallbackMapping()
{
}
/*!
\property Qt3DAnimation::QCallbackMapping::channelName
Holds the name of the channel for the callback mapping.
*/
QString QCallbackMapping::channelName() const
{
Q_D(const QCallbackMapping);
return d->m_channelName;
}
QAnimationCallback *QCallbackMapping::callback() const
{
Q_D(const QCallbackMapping);
return d->m_callback;
}
void QCallbackMapping::setChannelName(const QString &channelName)
{
Q_D(QCallbackMapping);
if (d->m_channelName == channelName)
return;
d->m_channelName = channelName;
emit channelNameChanged(channelName);
}
/*!
Associates a \a callback object with this channel mapping.
Such mappings do not have to have a target object and property name. When
the \a callback object is set, every change in the animated value will lead
to invoking the callback's
\l {Qt3DAnimation::QAnimationCallback::valueChanged}{valueChanged} function either
on the gui/main thread, or directly on one of the thread pool's worker
thread. This is controlled by \a flags.
\a type specifies the type (for example, QMetaType::QVector3D,
QMetaType::QColor, or QMetaType::Float) of the animated value. When animating
node properties this does not need to be provided separately, however it
becomes important to supply this when there is only a callback.
\note A mapping can be associated both with a node property and a
callback. It is important however that \a type matches the type of the
property in this case. Note also that for properties of type QVariant (for
example, QParameter::value), the \a type is the type of the value stored in
the QVariant.
\note The \a callback pointer is expected to stay valid while any
associated animators are running.
*/
void QCallbackMapping::setCallback(int type, QAnimationCallback *callback, QAnimationCallback::Flags flags)
{
Q_D(QCallbackMapping);
if (d->m_type != type) {
d->m_type = type;
d->update();
}
if (d->m_callback != callback) {
d->m_callback = callback;
d->update();
}
if (d->m_callbackFlags != flags) {
d->m_callbackFlags = flags;
d->update();
}
}
} // namespace Qt3DAnimation
QT_END_NAMESPACE
#include "moc_qcallbackmapping.cpp"