Add API to map animation channels to properties

Change-Id: I98aecf101eb052979f7a2e98c8bfcf899f27fb02
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

1 files changed, 137 insertions, 0 deletions

diff --git a/src/animation/frontend/qchannelmapping.cpp b/src/animation/frontend/qchannelmapping.cpp
new file mode 100644
index 000000000..a920ad6e0
--- /dev/null
+++ b/src/animation/frontend/qchannelmapping.cpp
@@ -0,0 +1,137 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qchannelmapping.h"
+#include "qchannelmapping_p.h"
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DAnimation {
+
+QChannelMappingPrivate::QChannelMappingPrivate()
+    : Qt3DCore::QNodePrivate()
+    , m_channelName()
+    , m_target(nullptr)
+    , m_property()
+{
+}
+
+QChannelMapping::QChannelMapping(Qt3DCore::QNode *parent)
+    : Qt3DCore::QNode(*new QChannelMappingPrivate, parent)
+{
+}
+
+QChannelMapping::QChannelMapping(QChannelMappingPrivate &dd, Qt3DCore::QNode *parent)
+    : Qt3DCore::QNode(dd, parent)
+{
+}
+
+QChannelMapping::~QChannelMapping()
+{
+}
+
+QString QChannelMapping::channelName() const
+{
+    Q_D(const QChannelMapping);
+    return d->m_channelName;
+}
+
+Qt3DCore::QNode *QChannelMapping::target() const
+{
+    Q_D(const QChannelMapping);
+    return d->m_target;
+}
+
+QString QChannelMapping::property() const
+{
+    Q_D(const QChannelMapping);
+    return d->m_property;
+}
+
+void QChannelMapping::setChannelName(const QString &channelName)
+{
+    Q_D(QChannelMapping);
+    if (d->m_channelName == channelName)
+        return;
+
+    d->m_channelName = channelName;
+    emit channelNameChanged(channelName);
+}
+
+void QChannelMapping::setTarget(Qt3DCore::QNode *target)
+{
+    Q_D(QChannelMapping);
+    if (d->m_target == target)
+        return;
+
+    if (d->m_target)
+        d->unregisterDestructionHelper(d->m_target);
+
+    if (target && !target->parent())
+        target->setParent(this);
+    d->m_target = target;
+
+    // Ensures proper bookkeeping
+    if (d->m_target)
+        d->registerDestructionHelper(d->m_target, &QChannelMapping::setTarget, d->m_target);
+
+    emit targetChanged(target);
+}
+
+void QChannelMapping::setProperty(const QString &property)
+{
+    Q_D(QChannelMapping);
+    if (d->m_property == property)
+        return;
+
+    d->m_property = property;
+    emit propertyChanged(property);
+}
+
+Qt3DCore::QNodeCreatedChangeBasePtr QChannelMapping::createNodeCreationChange() const
+{
+    auto creationChange = Qt3DCore::QNodeCreatedChangePtr<QChannelMappingData>::create(this);
+    auto &data = creationChange->data;
+    Q_D(const QChannelMapping);
+    data.channelName = d->m_channelName;
+    data.targetId = Qt3DCore::qIdForNode(d->m_target);
+    data.property = d->m_property;
+    return creationChange;
+}
+
+} // namespace Qt3DAnimation
+
+QT_END_NAMESPACE