Add commands to dump frame graph and scene graph

prints to the console, also dump the list of paths in the frame graph
to help understand render views.

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

3 files changed, 52 insertions, 1 deletions

diff --git a/src/core/nodes/qentity.cpp b/src/core/nodes/qentity.cpp
index 93601901f..1199dfc4b 100644
--- a/src/core/nodes/qentity.cpp
+++ b/src/core/nodes/qentity.cpp
@@ -53,6 +53,50 @@
 
 QT_BEGIN_NAMESPACE
 
+namespace {
+
+QString dumpNode(const Qt3DCore::QEntity *n) {
+    auto formatNode = [](const Qt3DCore::QNode *n) {
+        QString res = QString(QLatin1String("%1{%2}"))
+                          .arg(QLatin1String(n->metaObject()->className()))
+                          .arg(n->id().id());
+        if (!n->objectName().isEmpty())
+            res += QString(QLatin1String(" (%1)")).arg(n->objectName());
+        if (!n->isEnabled())
+            res += QLatin1String(" [D]");
+        return res;
+    };
+
+    QString res = formatNode(n);
+    const auto &components = n->components();
+    if (components.size()) {
+        QStringList componentNames;
+        for (const auto &c : components)
+            componentNames += formatNode(c);
+        res += QString(QLatin1String(" [ %1 ]")).arg(componentNames.join(QLatin1String(", ")));
+    }
+
+    return res;
+}
+
+QStringList dumpSG(const Qt3DCore::QEntity *n, int level = 0)
+{
+    QStringList reply;
+    QString res = dumpNode(n);
+    reply += res.rightJustified(res.length() + level * 2, ' ');
+
+    const auto children = n->childNodes();
+    for (auto *child: children) {
+        auto *childFGNode = qobject_cast<Qt3DCore::QEntity *>(child);
+        if (childFGNode != nullptr)
+            reply += dumpSG(childFGNode, level + 1);
+    }
+
+    return reply;
+}
+
+}
+
 namespace Qt3DCore {
 
 /*!
@@ -244,6 +288,12 @@ QNodeId QEntityPrivate::parentEntityId() const
     return m_parentEntityId;
 }
 
+QString QEntityPrivate::dumpSceneGraph() const
+{
+    Q_Q(const QEntity);
+    return dumpSG(q).join('\n');
+}
+
 QNodeCreatedChangeBasePtr QEntity::createNodeCreationChange() const
 {
     auto creationChange = QNodeCreatedChangePtr<QEntityData>::create(this);
diff --git a/src/core/nodes/qentity_p.h b/src/core/nodes/qentity_p.h
index 803754c87..992f81931 100644
--- a/src/core/nodes/qentity_p.h
+++ b/src/core/nodes/qentity_p.h
@@ -82,6 +82,7 @@ public :
         return typedComponents;
     }
 
+    QString dumpSceneGraph() const;
     void removeDestroyedComponent(QComponent *comp);
 
     QComponentVector m_components;
diff --git a/src/core/services/qsysteminformationservice.cpp b/src/core/services/qsysteminformationservice.cpp
index 212038eea..87cc08e59 100644
--- a/src/core/services/qsysteminformationservice.cpp
+++ b/src/core/services/qsysteminformationservice.cpp
@@ -430,7 +430,7 @@ void QSystemInformationService::dumpCommand(const QString &command)
             return;
         }
     }
-    qWarning() << res;
+    qWarning() << qPrintable(res.toString());
 }
 
 }