Introduce QShaderProgramBuilder

This is the frontend class for building ShaderProgram content from graph
files.

Change-Id: Iae43d745473737537052a533653beee72506ea49
Reviewed-by: Sean Harmer <sean.harmer@kdab.com>

1 files changed, 304 insertions, 0 deletions

diff --git a/src/render/materialsystem/qshaderprogrambuilder.cpp b/src/render/materialsystem/qshaderprogrambuilder.cpp
new file mode 100644
index 000000000..0ca2ed407
--- /dev/null
+++ b/src/render/materialsystem/qshaderprogrambuilder.cpp
@@ -0,0 +1,304 @@
+/****************************************************************************
+**
+** 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:LGPL$
+** 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 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.LGPL3 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-3.0.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 (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** 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-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qshaderprogrambuilder.h"
+#include "qshaderprogrambuilder_p.h"
+#include "qshaderprogram.h"
+#include <Qt3DCore/qpropertyupdatedchange.h>
+#include <Qt3DRender/private/qurlhelper_p.h>
+#include <QDebug>
+#include <QFile>
+#include <QFileInfo>
+#include <QUrl>
+
+/*!
+    \class Qt3DRender::QShaderProgramBuilder
+    \inmodule Qt3DRender
+    \brief Generates a Shader Program content from loaded graphs.
+    \inherits Qt3DCore::QNode
+    \since 5.10
+
+    A shader program builder consists of several different shader graphs
+    used to generate shader code.
+*/
+
+/*!
+    \qmltype ShaderProgramBuilder
+    \instantiates Qt3DRender::QShaderProgramBuilder
+    \inqmlmodule Qt3D.Render
+    \brief Generates a Shader Program content from loaded graphs.
+    \since 5.10
+
+    A shader program builder consists of several different shader graphs
+    used to generate shader code.
+*/
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+QShaderProgramBuilderPrivate::QShaderProgramBuilderPrivate()
+    : QNodePrivate(),
+      m_shaderProgram(nullptr)
+{
+}
+
+QShaderProgramBuilder::QShaderProgramBuilder(QNode *parent)
+    : QNode(*new QShaderProgramBuilderPrivate, parent)
+{
+}
+
+QShaderProgramBuilder::~QShaderProgramBuilder()
+{
+}
+
+/*! \internal */
+QShaderProgramBuilder::QShaderProgramBuilder(QShaderProgramBuilderPrivate &dd, QNode *parent)
+    : QNode(dd, parent)
+{
+}
+
+/*!
+    \qmlproperty string ShaderProgramBuilder::shaderProgram
+
+    Holds the shader program on which this builder generates code.
+*/
+/*!
+    \property QShaderProgramBuilder::shaderProgram
+
+    Holds the shader program on which this builder generates code.
+*/
+void QShaderProgramBuilder::setShaderProgram(QShaderProgram *program)
+{
+    Q_D(QShaderProgramBuilder);
+    if (program != d->m_shaderProgram) {
+
+        if (d->m_shaderProgram)
+            d->unregisterDestructionHelper(d->m_shaderProgram);
+
+        // We need to add it as a child of the current node if it has been declared inline
+        // Or not previously added as a child of the current node so that
+        // 1) The backend gets notified about it's creation
+        // 2) When the current node is destroyed, it gets destroyed as well
+        if (program && !program->parent())
+            program->setParent(this);
+        d->m_shaderProgram = program;
+
+        // Ensures proper bookkeeping
+        if (d->m_shaderProgram)
+            d->registerDestructionHelper(d->m_shaderProgram, &QShaderProgramBuilder::setShaderProgram, d->m_shaderProgram);
+
+        emit shaderProgramChanged(program);
+    }
+}
+
+QShaderProgram *QShaderProgramBuilder::shaderProgram() const
+{
+    Q_D(const QShaderProgramBuilder);
+    return d->m_shaderProgram;
+}
+
+/*!
+    \qmlproperty string ShaderProgram::vertexShaderGraph
+
+    Holds the URL to the vertex shader graph used by this shader program builder.
+*/
+/*!
+    \property QShaderProgramBuilder::vertexShaderGraph
+
+    Holds the URL to the vertex shader graph used by this shader program builder.
+*/
+void QShaderProgramBuilder::setVertexShaderGraph(const QUrl &vertexShaderGraph)
+{
+    Q_D(QShaderProgramBuilder);
+    if (vertexShaderGraph != d->m_vertexShaderGraph) {
+        d->m_vertexShaderGraph = vertexShaderGraph;
+        emit vertexShaderGraphChanged(vertexShaderGraph);
+    }
+}
+
+QUrl QShaderProgramBuilder::vertexShaderGraph() const
+{
+    Q_D(const QShaderProgramBuilder);
+    return d->m_vertexShaderGraph;
+}
+
+/*!
+    \qmlproperty string ShaderProgram::tessellationControlShaderGraph
+
+    Holds the URL to the tesselation control shader graph used by this shader program builder.
+*/
+/*!
+    \property QShaderProgramBuilder::tessellationControlShaderGraph
+
+    Holds the URL to the tesselation control shader graph used by this shader program builder.
+*/
+void QShaderProgramBuilder::setTessellationControlShaderGraph(const QUrl &tessellationControlShaderGraph)
+{
+    Q_D(QShaderProgramBuilder);
+    if (tessellationControlShaderGraph != d->m_tessControlShaderGraph) {
+        d->m_tessControlShaderGraph = tessellationControlShaderGraph;
+        emit tessellationControlShaderGraphChanged(tessellationControlShaderGraph);
+    }
+}
+
+QUrl QShaderProgramBuilder::tessellationControlShaderGraph() const
+{
+    Q_D(const QShaderProgramBuilder);
+    return d->m_tessControlShaderGraph;
+}
+
+/*!
+    \qmlproperty string ShaderProgram::tessellationEvaluationShaderGraph
+
+    Holds the URL to the tesselation evaluation shader graph used by this shader program builder.
+*/
+/*!
+    \property QShaderProgramBuilder::tessellationEvaluationShaderGraph
+
+    Holds the URL to the tesselation evaluation shader graph used by this shader program builder.
+*/
+void QShaderProgramBuilder::setTessellationEvaluationShaderGraph(const QUrl &tessellationEvaluationShaderGraph)
+{
+    Q_D(QShaderProgramBuilder);
+    if (tessellationEvaluationShaderGraph != d->m_tessEvalShaderGraph) {
+        d->m_tessEvalShaderGraph = tessellationEvaluationShaderGraph;
+        emit tessellationEvaluationShaderGraphChanged(tessellationEvaluationShaderGraph);
+    }
+}
+
+QUrl QShaderProgramBuilder::tessellationEvaluationShaderGraph() const
+{
+    Q_D(const QShaderProgramBuilder);
+    return d->m_tessEvalShaderGraph;
+}
+
+/*!
+    \qmlproperty string ShaderProgram::geometryShaderGraph
+
+    Holds the URL to the geometry shader graph used by this shader program builder.
+*/
+/*!
+    \property QShaderProgramBuilder::geometryShaderGraph
+
+    Holds the URL to the geometry shader graph used by this shader program builder.
+*/
+void QShaderProgramBuilder::setGeometryShaderGraph(const QUrl &geometryShaderGraph)
+{
+    Q_D(QShaderProgramBuilder);
+    if (geometryShaderGraph != d->m_geometryShaderGraph) {
+        d->m_geometryShaderGraph = geometryShaderGraph;
+        emit geometryShaderGraphChanged(geometryShaderGraph);
+    }
+}
+
+QUrl QShaderProgramBuilder::geometryShaderGraph() const
+{
+    Q_D(const QShaderProgramBuilder);
+    return d->m_geometryShaderGraph;
+}
+
+/*!
+    \qmlproperty string ShaderProgram::fragmentShaderGraph
+
+    Holds the URL to the fragment shader graph used by this shader program builder.
+*/
+/*!
+    \property QShaderProgramBuilder::fragmentShaderGraph
+
+    Holds the URL to the fragment shader graph used by this shader program builder.
+*/
+void QShaderProgramBuilder::setFragmentShaderGraph(const QUrl &fragmentShaderGraph)
+{
+    Q_D(QShaderProgramBuilder);
+    if (fragmentShaderGraph != d->m_fragmentShaderGraph) {
+        d->m_fragmentShaderGraph = fragmentShaderGraph;
+        emit fragmentShaderGraphChanged(fragmentShaderGraph);
+    }
+}
+
+QUrl QShaderProgramBuilder::fragmentShaderGraph() const
+{
+    Q_D(const QShaderProgramBuilder);
+    return d->m_fragmentShaderGraph;
+}
+
+/*!
+    \qmlproperty string ShaderProgram::computeShaderGraph
+
+    Holds the URL to the compute shader graph used by this shader program builder.
+*/
+/*!
+    \property QShaderProgramBuilder::computeShaderGraph
+
+    Holds the URL to the compute shader graph used by this shader program builder.
+*/
+void QShaderProgramBuilder::setComputeShaderGraph(const QUrl &computeShaderGraph)
+{
+    Q_D(QShaderProgramBuilder);
+    if (computeShaderGraph != d->m_computeShaderGraph) {
+        d->m_computeShaderGraph = computeShaderGraph;
+        emit computeShaderGraphChanged(computeShaderGraph);
+    }
+}
+
+QUrl QShaderProgramBuilder::computeShaderGraph() const
+{
+    Q_D(const QShaderProgramBuilder);
+    return d->m_computeShaderGraph;
+}
+
+Qt3DCore::QNodeCreatedChangeBasePtr QShaderProgramBuilder::createNodeCreationChange() const
+{
+    auto creationChange = Qt3DCore::QNodeCreatedChangePtr<QShaderProgramBuilderData>::create(this);
+    auto &data = creationChange->data;
+    Q_D(const QShaderProgramBuilder);
+    data.shaderProgramId = d->m_shaderProgram ? d->m_shaderProgram->id() : Qt3DCore::QNodeId();
+    data.vertexShaderGraph = d->m_vertexShaderGraph;
+    data.tessellationControlShaderGraph = d->m_tessControlShaderGraph;
+    data.tessellationEvaluationShaderGraph = d->m_tessEvalShaderGraph;
+    data.geometryShaderGraph = d->m_geometryShaderGraph;
+    data.fragmentShaderGraph = d->m_fragmentShaderGraph;
+    data.computeShaderGraph = d->m_computeShaderGraph;
+    return creationChange;
+}
+
+} // of namespace Qt3DRender
+
+QT_END_NAMESPACE