Add QJoint frontend type

Represents a joint within a skeleton. For now we limit the scale to
a uniform scale represented by a single float. If there is demand
we can extend this to support non-uniform scales for joints using a
QVector3D.

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

3 files changed, 276 insertions, 1 deletions

diff --git a/tests/auto/core/core.pro b/tests/auto/core/core.pro
index c36a9bf22..02af273aa 100644
--- a/tests/auto/core/core.pro
+++ b/tests/auto/core/core.pro
@@ -12,7 +12,8 @@ SUBDIRS = \
     qaspectjob \
     qchangearbiter \
     qscene \
-    qservicelocator
+    qservicelocator \
+    qjoint
 
 qtConfig(private_tests) {
     SUBDIRS += \
diff --git a/tests/auto/core/qjoint/qjoint.pro b/tests/auto/core/qjoint/qjoint.pro
new file mode 100644
index 000000000..e25d57102
--- /dev/null
+++ b/tests/auto/core/qjoint/qjoint.pro
@@ -0,0 +1,12 @@
+TEMPLATE = app
+
+TARGET = tst_qjoint
+
+QT += 3dcore 3dcore-private testlib
+
+CONFIG += testcase
+
+SOURCES += \
+    tst_qjoint.cpp
+
+include(../common/common.pri)
diff --git a/tests/auto/core/qjoint/tst_qjoint.cpp b/tests/auto/core/qjoint/tst_qjoint.cpp
new file mode 100644
index 000000000..60c80bfe5
--- /dev/null
+++ b/tests/auto/core/qjoint/tst_qjoint.cpp
@@ -0,0 +1,262 @@
+/****************************************************************************
+**
+** Copyright (C) 2017 Klaralvdalens Datakonsult AB (KDAB).
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt3D module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <QtTest/QTest>
+#include <Qt3DCore/qjoint.h>
+#include <Qt3DCore/private/qjoint_p.h>
+#include <Qt3DCore/qpropertyupdatedchange.h>
+#include <Qt3DCore/qnodecreatedchange.h>
+#include <Qt3DCore/private/qnodecreatedchangegenerator_p.h>
+#include <QObject>
+#include <QSignalSpy>
+#include <testpostmanarbiter.h>
+
+using namespace Qt3DCore;
+
+class tst_QJoint : public QObject
+{
+    Q_OBJECT
+
+private Q_SLOTS:
+    void checkDefaultConstruction()
+    {
+        // GIVEN
+        QJoint joint;
+
+        // THEN
+        QCOMPARE(joint.scale(), 1.0f);
+        QCOMPARE(joint.rotation(), QQuaternion());
+        QCOMPARE(joint.translation(), QVector3D(0.0f, 0.0f, 0.0f));
+    }
+
+    void checkPropertyChanges()
+    {
+        // GIVEN
+        QJoint joint;
+
+        {
+            // WHEN
+            QSignalSpy spy(&joint, SIGNAL(scaleChanged(float)));
+            const float newValue(2.5f);
+            joint.setScale(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(joint.scale(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            joint.setScale(newValue);
+
+            // THEN
+            QCOMPARE(joint.scale(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+
+        {
+            // WHEN
+            QSignalSpy spy(&joint, SIGNAL(rotationChanged(QQuaternion)));
+            const auto newValue = QQuaternion::fromAxisAndAngle(0.0f, 1.0f, 0.0f, 45.0f);
+            joint.setRotation(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(joint.rotation(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            joint.setRotation(newValue);
+
+            // THEN
+            QCOMPARE(joint.rotation(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+
+        {
+            // WHEN
+            QSignalSpy spy(&joint, SIGNAL(translationChanged(QVector3D)));
+            const QVector3D newValue(1.0f, 2.0f, 3.0f);
+            joint.setTranslation(newValue);
+
+            // THEN
+            QVERIFY(spy.isValid());
+            QCOMPARE(joint.translation(), newValue);
+            QCOMPARE(spy.count(), 1);
+
+            // WHEN
+            spy.clear();
+            joint.setTranslation(newValue);
+
+            // THEN
+            QCOMPARE(joint.translation(), newValue);
+            QCOMPARE(spy.count(), 0);
+        }
+    }
+
+    void checkCreationData()
+    {
+        // GIVEN
+        QJoint joint;
+
+        joint.setScale(3.5f);
+        joint.setRotation(QQuaternion::fromAxisAndAngle(0.0f, 1.0f, 0.0f, 30.0f));
+        joint.setTranslation(QVector3D(3.0f, 2.0f, 1.0f));
+
+        // WHEN
+        QVector<Qt3DCore::QNodeCreatedChangeBasePtr> creationChanges;
+
+        {
+            Qt3DCore::QNodeCreatedChangeGenerator creationChangeGenerator(&joint);
+            creationChanges = creationChangeGenerator.creationChanges();
+        }
+
+        // THEN
+        {
+            QCOMPARE(creationChanges.size(), 1);
+
+            const auto creationChangeData
+                = qSharedPointerCast<QNodeCreatedChange<QJointData>>(creationChanges.first());
+            const QJointData data = creationChangeData->data;
+
+            QCOMPARE(joint.id(), creationChangeData->subjectId());
+            QCOMPARE(joint.isEnabled(), true);
+            QCOMPARE(joint.isEnabled(), creationChangeData->isNodeEnabled());
+            QCOMPARE(joint.metaObject(), creationChangeData->metaObject());
+            QCOMPARE(joint.scale(), data.scale);
+            QCOMPARE(joint.rotation(), data.rotation);
+            QCOMPARE(joint.translation(), data.translation);
+        }
+
+        // WHEN
+        joint.setEnabled(false);
+
+        {
+            Qt3DCore::QNodeCreatedChangeGenerator creationChangeGenerator(&joint);
+            creationChanges = creationChangeGenerator.creationChanges();
+        }
+
+        // THEN
+        {
+            QCOMPARE(creationChanges.size(), 1);
+
+            const auto creationChangeData
+                = qSharedPointerCast<QNodeCreatedChange<QJointData>>(creationChanges.first());
+            const QJointData data = creationChangeData->data;
+
+            QCOMPARE(joint.id(), creationChangeData->subjectId());
+            QCOMPARE(joint.isEnabled(), false);
+            QCOMPARE(joint.isEnabled(), creationChangeData->isNodeEnabled());
+            QCOMPARE(joint.metaObject(), creationChangeData->metaObject());
+            QCOMPARE(joint.scale(), data.scale);
+            QCOMPARE(joint.rotation(), data.rotation);
+            QCOMPARE(joint.translation(), data.translation);
+        }
+    }
+
+    void checkPropertyUpdateChanges()
+    {
+        // GIVEN
+        TestArbiter arbiter;
+        QJoint joint;
+        arbiter.setArbiterOnNode(&joint);
+
+        {
+            // WHEN
+            joint.setScale(2.0f);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "scale");
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+            QCOMPARE(change->value().toFloat(), joint.scale());
+
+            arbiter.events.clear();
+
+            // WHEN
+            joint.setScale(2.0f);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+        {
+            // WHEN
+            const auto newValue = QQuaternion::fromAxisAndAngle(1.0f, 1.0f, 1.0f, 45.0f);
+            joint.setRotation(newValue);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "rotation");
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+            QCOMPARE(change->value().value<QQuaternion>(), newValue);
+
+            arbiter.events.clear();
+
+            // WHEN
+            joint.setRotation(newValue);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+
+        {
+            // WHEN
+            const QVector3D newValue(1.0f, 2.0f, 3.0f);
+            joint.setTranslation(newValue);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 1);
+            auto change = arbiter.events.first().staticCast<Qt3DCore::QPropertyUpdatedChange>();
+            QCOMPARE(change->propertyName(), "translation");
+            QCOMPARE(change->type(), Qt3DCore::PropertyUpdated);
+            QCOMPARE(change->value().value<QVector3D>(), newValue);
+
+            arbiter.events.clear();
+
+            // WHEN
+            joint.setTranslation(newValue);
+            QCoreApplication::processEvents();
+
+            // THEN
+            QCOMPARE(arbiter.events.size(), 0);
+        }
+    }
+};
+
+QTEST_MAIN(tst_QJoint)
+
+#include "tst_qjoint.moc"