Add C++ QPhongAlphaMaterial

Change-Id: Id0a428bb2bc4301d08a86153deddd85fd340dc0f
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
Reviewed-by: Andy Nichols <andy.nichols@theqtcompany.com>

4 files changed, 486 insertions, 2 deletions

diff --git a/src/render/defaults/defaults.pri b/src/render/defaults/defaults.pri
index 190f8e4b5..1560f55ec 100644
--- a/src/render/defaults/defaults.pri
+++ b/src/render/defaults/defaults.pri
@@ -20,7 +20,9 @@ HEADERS += \
     $$PWD/qskyboxentity.h \
     $$PWD/qskyboxentity_p.h \
     $$PWD/qgoochmaterial.h \
-    $$PWD/qgoochmaterial_p.h
+    $$PWD/qgoochmaterial_p.h \
+    $$PWD/qphongalphamaterial.h \
+    $$PWD/qphongalphamaterial_p.h
 
 SOURCES += \
     $$PWD/qphongmaterial.cpp \
@@ -32,4 +34,6 @@ SOURCES += \
     $$PWD/qforwardrenderer.cpp \
     $$PWD/qpervertexcolormaterial.cpp \
     $$PWD/qskyboxentity.cpp \
-    $$PWD/qgoochmaterial.cpp
+    $$PWD/qgoochmaterial.cpp \
+    $$PWD/qphongalphamaterial.cpp
+
diff --git a/src/render/defaults/qphongalphamaterial.cpp b/src/render/defaults/qphongalphamaterial.cpp
new file mode 100644
index 000000000..6235b54a0
--- /dev/null
+++ b/src/render/defaults/qphongalphamaterial.cpp
@@ -0,0 +1,287 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 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 "qphongalphamaterial.h"
+#include "qphongalphamaterial_p.h"
+#include <Qt3DRender/qmaterial.h>
+#include <Qt3DRender/qeffect.h>
+#include <Qt3DRender/qtechnique.h>
+#include <Qt3DRender/qshaderprogram.h>
+#include <Qt3DRender/qparameter.h>
+#include <Qt3DRender/qrenderpass.h>
+#include <Qt3DRender/qgraphicsapifilter.h>
+#include <Qt3DRender/qblendequation.h>
+#include <Qt3DRender/qblendstate.h>
+#include <Qt3DRender/qdepthmask.h>
+#include <QUrl>
+#include <QVector3D>
+#include <QVector4D>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+/*!
+    \class Qt3DRender::QPhongAlphaMaterialPrivate
+    \internal
+*/
+QPhongAlphaMaterialPrivate::QPhongAlphaMaterialPrivate()
+    : QMaterialPrivate()
+    , m_phongEffect(new QEffect())
+    , m_ambientParameter(new QParameter(QStringLiteral("ka"), QColor::fromRgbF(0.05f, 0.05f, 0.05f, 1.0f)))
+    , m_diffuseParameter(new QParameter(QStringLiteral("kd"), QColor::fromRgbF(0.7f, 0.7f, 0.7f, 1.0f)))
+    , m_specularParameter(new QParameter(QStringLiteral("ks"), QColor::fromRgbF(0.95f, 0.95f, 0.95f, 1.0f)))
+    , m_shininessParameter(new QParameter(QStringLiteral("shininess"), 150.0f))
+    , m_alphaParameter(new QParameter(QStringLiteral("alpha"), 0.5f))
+    , m_lightPositionParameter(new QParameter(QStringLiteral("lightPosition"), QVector4D(1.0f, 1.0f, 0.0f, 1.0f)))
+    , m_lightIntensityParameter(new QParameter(QStringLiteral("lightIntensity"), QVector3D(1.0f, 1.0f, 1.0f)))
+    , m_phongAlphaGL3Technique(new QTechnique())
+    , m_phongAlphaGL2Technique(new QTechnique())
+    , m_phongAlphaES2Technique(new QTechnique())
+    , m_phongAlphaGL3RenderPass(new QRenderPass())
+    , m_phongAlphaGL2RenderPass(new QRenderPass())
+    , m_phongAlphaES2RenderPass(new QRenderPass())
+    , m_phongAlphaGL3Shader(new QShaderProgram())
+    , m_phongAlphaGL2ES2Shader(new QShaderProgram())
+    , m_depthMask(new QDepthMask())
+    , m_blendState(new QBlendState())
+    , m_blendEquation(new QBlendEquation())
+{
+}
+
+/*!
+    \class Qt3DRender::QPhongAlphaMaterial
+
+    \brief The QPhongAlphaMaterial class provides a default implementation of
+    the phong lighting effect with alpha
+.
+    \inmodule Qt3DRenderer
+    \since 5.5
+
+    The phong lighting effect is based on the combination of 3 lighting components ambient, diffuse and specular.
+    The relative strengths of these components is controlled by means of their reflectivity coefficients which are modelled as RGB triplets:
+
+    \list
+    \li Ambient is the color that is emitted by an object without any other light source.
+    \li Diffuse is the color that is emitted for rought surface reflections with the lights.
+    \li Specular is the color emitted for shiny surface reflections with the lights.
+    \li The shininess of a surface is controlled by a float property.
+    \li Alpha is the transparency of the surface between 0 (fully transparent) and 1 (opaque).
+    \endlist
+
+    This material uses an effect with a single render pass approach and performs per fragment lighting.
+    Techniques are provided for OpenGL 2, OpenGL 3 or above as well as OpenGL ES 2.
+*/
+
+/*!
+    \fn Qt3DRender::QPhongAlphaMaterial::QPhongAlphaMaterial(QNode *parent)
+
+    Constructs a new QPhongAlphaMaterial instance with parent object \a parent.
+*/
+QPhongAlphaMaterial::QPhongAlphaMaterial(QNode *parent)
+    : QMaterial(*new QPhongAlphaMaterialPrivate, parent)
+{
+    Q_D(QPhongAlphaMaterial);
+    QObject::connect(d->m_ambientParameter, SIGNAL(valueChanged()), this, SIGNAL(ambientChanged()));
+    QObject::connect(d->m_diffuseParameter, SIGNAL(valueChanged()), this, SIGNAL(diffuseChanged()));
+    QObject::connect(d->m_specularParameter, SIGNAL(valueChanged()), this, SIGNAL(specularChanged()));
+    QObject::connect(d->m_shininessParameter, SIGNAL(valueChanged()), this, SIGNAL(shininessChanged()));
+    QObject::connect(d->m_alphaParameter, SIGNAL(valueChanged()), this, SIGNAL(alphaChanged()));
+    d->init();
+}
+
+/*!
+   \fn Qt3DRender::QPhongAlphaMaterial::~QPhongAlphaMaterial()
+
+   Destroys the QPhongAlphaMaterial.
+*/
+QPhongAlphaMaterial::~QPhongAlphaMaterial()
+{
+}
+
+/*!
+    \property Qt3DRender::QPhongAlphaMaterial::ambient
+
+    Holds the ambient color.
+*/
+QColor QPhongAlphaMaterial::ambient() const
+{
+    Q_D(const QPhongAlphaMaterial);
+    return d->m_ambientParameter->value().value<QColor>();
+}
+
+/*!
+    \property Qt3DRender::QPhongAlphaMaterial::diffuse
+
+    Holds the diffuse color.
+*/
+QColor QPhongAlphaMaterial::diffuse() const
+{
+    Q_D(const QPhongAlphaMaterial);
+    return d->m_diffuseParameter->value().value<QColor>();
+}
+
+/*!
+    \property QColor Qt3DRender::QPhongAlphaMaterial::specular
+
+    Holds the specular color.
+*/
+QColor QPhongAlphaMaterial::specular() const
+{
+    Q_D(const QPhongAlphaMaterial);
+    return d->m_specularParameter->value().value<QColor>();
+}
+
+/*!
+    \property Qt3DRender::QPhongAlphaMaterial::shininess
+
+    Holds the shininess exponent.
+*/
+float QPhongAlphaMaterial::shininess() const
+{
+    Q_D(const QPhongAlphaMaterial);
+    return d->m_shininessParameter->value().toFloat();
+}
+
+/*!
+    \property Qt3DRender::QPhongAlphaMaterial::alpha
+
+    Holds the alpha component of the object which varies between 0 and 1.
+
+    \note: default value is 0.5f
+*/
+float QPhongAlphaMaterial::alpha() const
+{
+    Q_D(const QPhongAlphaMaterial);
+    return d->m_alphaParameter->value().toFloat();
+}
+
+void QPhongAlphaMaterial::setAmbient(const QColor &ambient)
+{
+    Q_D(QPhongAlphaMaterial);
+    d->m_ambientParameter->setValue(ambient);
+}
+
+void QPhongAlphaMaterial::setDiffuse(const QColor &diffuse)
+{
+    Q_D(QPhongAlphaMaterial);
+    d->m_diffuseParameter->setValue(diffuse);
+}
+
+void QPhongAlphaMaterial::setSpecular(const QColor &specular)
+{
+    Q_D(QPhongAlphaMaterial);
+    d->m_specularParameter->setValue(specular);
+}
+
+void QPhongAlphaMaterial::setShininess(float shininess)
+{
+    Q_D(QPhongAlphaMaterial);
+    d->m_shininessParameter->setValue(shininess);
+}
+
+void QPhongAlphaMaterial::setAlpha(float alpha)
+{
+    Q_D(QPhongAlphaMaterial);
+    d->m_alphaParameter->setValue(alpha);
+}
+
+// TODO: Define how lights are properties are set in the shaders. Ideally using a QShaderData
+void QPhongAlphaMaterialPrivate::init()
+{
+    m_phongAlphaGL3Shader->setVertexShaderCode(QShaderProgram::loadSource(QUrl(QStringLiteral("qrc:/shaders/gl3/phongalpha.vert"))));
+    m_phongAlphaGL3Shader->setFragmentShaderCode(QShaderProgram::loadSource(QUrl(QStringLiteral("qrc:/shaders/gl3/phongalpha.frag"))));
+    m_phongAlphaGL2ES2Shader->setVertexShaderCode(QShaderProgram::loadSource(QUrl(QStringLiteral("qrc:/shaders/es2/phongalpha.vert"))));
+    m_phongAlphaGL2ES2Shader->setFragmentShaderCode(QShaderProgram::loadSource(QUrl(QStringLiteral("qrc:/shaders/es2/phongalpha.frag"))));
+
+    m_phongAlphaGL3Technique->graphicsApiFilter()->setApi(QGraphicsApiFilter::OpenGL);
+    m_phongAlphaGL3Technique->graphicsApiFilter()->setMajorVersion(3);
+    m_phongAlphaGL3Technique->graphicsApiFilter()->setMinorVersion(1);
+    m_phongAlphaGL3Technique->graphicsApiFilter()->setProfile(QGraphicsApiFilter::CoreProfile);
+
+    m_phongAlphaGL2Technique->graphicsApiFilter()->setApi(QGraphicsApiFilter::OpenGL);
+    m_phongAlphaGL2Technique->graphicsApiFilter()->setMajorVersion(2);
+    m_phongAlphaGL2Technique->graphicsApiFilter()->setMinorVersion(0);
+    m_phongAlphaGL2Technique->graphicsApiFilter()->setProfile(QGraphicsApiFilter::NoProfile);
+
+    m_phongAlphaES2Technique->graphicsApiFilter()->setApi(QGraphicsApiFilter::OpenGLES);
+    m_phongAlphaES2Technique->graphicsApiFilter()->setMajorVersion(2);
+    m_phongAlphaES2Technique->graphicsApiFilter()->setMinorVersion(0);
+    m_phongAlphaES2Technique->graphicsApiFilter()->setProfile(QGraphicsApiFilter::NoProfile);
+
+    m_depthMask->setMask(false);
+    m_blendState->setSrcRGB(QBlendState::SrcAlpha);
+    m_blendState->setDstRGB(QBlendState::OneMinusSrcAlpha);
+    m_blendEquation->setMode(QBlendEquation::FuncAdd);
+
+    m_phongAlphaGL3RenderPass->setShaderProgram(m_phongAlphaGL3Shader);
+    m_phongAlphaGL2RenderPass->setShaderProgram(m_phongAlphaGL2ES2Shader);
+    m_phongAlphaES2RenderPass->setShaderProgram(m_phongAlphaGL2ES2Shader);
+
+    m_phongAlphaGL3RenderPass->addRenderState(m_depthMask);
+    m_phongAlphaGL3RenderPass->addRenderState(m_blendState);
+    m_phongAlphaGL3RenderPass->addRenderState(m_blendEquation);
+
+    m_phongAlphaGL2RenderPass->addRenderState(m_depthMask);
+    m_phongAlphaGL2RenderPass->addRenderState(m_blendState);
+    m_phongAlphaGL2RenderPass->addRenderState(m_blendEquation);
+
+    m_phongAlphaES2RenderPass->addRenderState(m_depthMask);
+    m_phongAlphaES2RenderPass->addRenderState(m_blendState);
+    m_phongAlphaES2RenderPass->addRenderState(m_blendEquation);
+
+    m_phongAlphaGL3Technique->addPass(m_phongAlphaGL3RenderPass);
+    m_phongAlphaGL2Technique->addPass(m_phongAlphaGL2RenderPass);
+    m_phongAlphaES2Technique->addPass(m_phongAlphaES2RenderPass);
+
+    m_phongEffect->addTechnique(m_phongAlphaGL3Technique);
+    m_phongEffect->addTechnique(m_phongAlphaGL2Technique);
+    m_phongEffect->addTechnique(m_phongAlphaES2Technique);
+
+    m_phongEffect->addParameter(m_ambientParameter);
+    m_phongEffect->addParameter(m_diffuseParameter);
+    m_phongEffect->addParameter(m_specularParameter);
+    m_phongEffect->addParameter(m_shininessParameter);
+    m_phongEffect->addParameter(m_alphaParameter);
+    m_phongEffect->addParameter(m_lightPositionParameter);
+    m_phongEffect->addParameter(m_lightIntensityParameter);
+
+    q_func()->setEffect(m_phongEffect);
+}
+
+} // namespace Qt3DRender
+
+QT_END_NAMESPACE
diff --git a/src/render/defaults/qphongalphamaterial.h b/src/render/defaults/qphongalphamaterial.h
new file mode 100644
index 000000000..7d4d88ffc
--- /dev/null
+++ b/src/render/defaults/qphongalphamaterial.h
@@ -0,0 +1,89 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 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$
+**
+****************************************************************************/
+
+#ifndef QT3DRENDER_RENDER_QPHONGALPHAMATERIAL_H
+#define QT3DRENDER_RENDER_QPHONGALPHAMATERIAL_H
+
+#include <Qt3DRender/qmaterial.h>
+#include <QColor>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+class QPhongAlphaMaterialPrivate;
+
+class QT3DRENDERSHARED_EXPORT QPhongAlphaMaterial : public QMaterial
+{
+    Q_OBJECT
+    Q_PROPERTY(QColor ambient READ ambient WRITE setAmbient NOTIFY ambientChanged)
+    Q_PROPERTY(QColor diffuse READ diffuse WRITE setDiffuse NOTIFY diffuseChanged)
+    Q_PROPERTY(QColor specular READ specular WRITE setSpecular NOTIFY specularChanged)
+    Q_PROPERTY(float shininess READ shininess WRITE setShininess NOTIFY shininessChanged)
+    Q_PROPERTY(float alpha READ alpha WRITE setAlpha NOTIFY alphaChanged)
+
+public:
+    explicit QPhongAlphaMaterial(Qt3DCore::QNode *parent = 0);
+    ~QPhongAlphaMaterial();
+
+    QColor ambient() const;
+    QColor diffuse() const;
+    QColor specular() const;
+    float shininess() const;
+    float alpha() const;
+
+    void setAmbient(const QColor &ambient);
+    void setDiffuse(const QColor &diffuse);
+    void setSpecular(const QColor &specular);
+    void setShininess(float shininess);
+    void setAlpha(float alpha);
+
+Q_SIGNALS:
+    void ambientChanged();
+    void diffuseChanged();
+    void specularChanged();
+    void shininessChanged();
+    void alphaChanged();
+
+private:
+    Q_DECLARE_PRIVATE(QPhongAlphaMaterial)
+};
+
+} // namespace Qt3DRender
+
+QT_END_NAMESPACE
+
+#endif // QT3DRENDER_RENDER_QPHONGALPHAMATERIAL_H
diff --git a/src/render/defaults/qphongalphamaterial_p.h b/src/render/defaults/qphongalphamaterial_p.h
new file mode 100644
index 000000000..9c91669b2
--- /dev/null
+++ b/src/render/defaults/qphongalphamaterial_p.h
@@ -0,0 +1,104 @@
+/****************************************************************************
+**
+** Copyright (C) 2014 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$
+**
+****************************************************************************/
+
+#ifndef QT3DRENDER_RENDER_QPHONGALPHAMATERIAL_P_H
+#define QT3DRENDER_RENDER_QPHONGALPHAMATERIAL_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists for the convenience
+// of other Qt classes.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <Qt3DRender/private/qmaterial_p.h>
+
+QT_BEGIN_NAMESPACE
+
+namespace Qt3DRender {
+
+class QEffect;
+class QTechnique;
+class QParameter;
+class QShaderProgram;
+class QRenderPass;
+class QParameterMapping;
+class QDepthMask;
+class QBlendState;
+class QBlendEquation;
+
+class QPhongAlphaMaterial;
+
+class QPhongAlphaMaterialPrivate : public QMaterialPrivate
+{
+public:
+    QPhongAlphaMaterialPrivate();
+
+    void init();
+
+    QEffect *m_phongEffect;
+    QParameter *m_ambientParameter;
+    QParameter *m_diffuseParameter;
+    QParameter *m_specularParameter;
+    QParameter *m_shininessParameter;
+    QParameter *m_alphaParameter;
+    QParameter *m_lightPositionParameter;
+    QParameter *m_lightIntensityParameter;
+    QTechnique *m_phongAlphaGL3Technique;
+    QTechnique *m_phongAlphaGL2Technique;
+    QTechnique *m_phongAlphaES2Technique;
+    QRenderPass *m_phongAlphaGL3RenderPass;
+    QRenderPass *m_phongAlphaGL2RenderPass;
+    QRenderPass *m_phongAlphaES2RenderPass;
+    QShaderProgram *m_phongAlphaGL3Shader;
+    QShaderProgram *m_phongAlphaGL2ES2Shader;
+    QDepthMask *m_depthMask;
+    QBlendState *m_blendState;
+    QBlendEquation *m_blendEquation;
+
+    Q_DECLARE_PUBLIC(QPhongAlphaMaterial)
+};
+
+} // namespace Qt3DRender
+
+QT_END_NAMESPACE
+
+#endif // QT3DRENDER_RENDER_QPHONGALPHAMATERIAL_P_H
+