qgsphongtexturedmaterialsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgsphongtexturedmaterialsettings.h
  --------------------------------------
  Date                 : August 2020
  Copyright            : (C) 2020 by Nyall Dawson
  Email                : nyall dot dawson at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSPHONGTEXTUREDMATERIALSETTINGS_H
#define QGSPHONGTEXTUREDMATERIALSETTINGS_H
 
#include <optional>
 
#include "qgis_core.h"
#include "qgsabstractmaterialsettings.h"
 
#include <QColor>
 
class QgsMaterial;
class QDomElement;

class CORE_EXPORT QgsPhongTexturedMaterialSettings : public QgsAbstractMaterialSettings
{
  public:
    QgsPhongTexturedMaterialSettings() = default;
 
    QString type() const override;

    static bool supportsTechnique( Qgis::MaterialRenderingTechnique technique );

    static QgsAbstractMaterialSettings *create() SIP_FACTORY;
 
    QgsPhongTexturedMaterialSettings *clone() const override SIP_FACTORY;
    bool equals( const QgsAbstractMaterialSettings *other ) const override;
    QSet< QgsAbstractMaterialSettings::Property > supportedProperties() const override;

    QColor ambient() const { return mAmbient; }
    QColor specular() const { return mSpecular; }
    double shininess() const { return mShininess; }

    QString diffuseTexturePath() const { return mDiffuseTexturePath; }

    double textureScale() const { return mTextureScale; }

    double textureRotation() const { return mTextureRotation; }

    QPointF textureOffset() const { return mTextureOffset; }
 
    bool requiresTextureCoordinates() const override;

    double opacity() const { return mOpacity; }

    void setAmbient( const QColor &ambient ) { mAmbient = ambient; }

    void setSpecular( const QColor &specular ) { mSpecular = specular; }
    void setShininess( double shininess ) { mShininess = shininess; }

    void setDiffuseTexturePath( const QString &path )
    {
      mDiffuseTexturePath = path;
      mTextureAverageColor.reset();
    }

    void setTextureScale( double scale ) { mTextureScale = scale; }

    void setTextureRotation( double rotation ) { mTextureRotation = rotation; }

    void setTextureOffset( QPointF offset ) { mTextureOffset = offset; }

    void setOpacity( double opacity ) { mOpacity = opacity; }

    QColor averageColor() const override;

    void setColorsFromBase( const QColor &baseColor, float metallic );

    void setColorsFromBase( const QColor &baseColor ) override;
 
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
 
    // TODO c++20 - replace with = default
    bool operator==( const QgsPhongTexturedMaterialSettings &other ) const
    {
      return mAmbient == other.mAmbient
             && mSpecular == other.mSpecular
             && mShininess == other.mShininess
             && mOpacity == other.mOpacity
             && mDiffuseTexturePath == other.mDiffuseTexturePath
             && mTextureScale == other.mTextureScale
             && mTextureRotation == other.mTextureRotation
             && qgsDoubleNear( mTextureOffset.x(), other.mTextureOffset.x() )
             && qgsDoubleNear( mTextureOffset.y(), other.mTextureOffset.y() )
             && dataDefinedProperties() == other.dataDefinedProperties();
    }
 
  private:
    QColor textureAverageColor() const;
 
  private:
    QColor mAmbient { QColor::fromRgbF( 0.1f, 0.1f, 0.1f, 1.0f ) };
    QColor mSpecular { QColor::fromRgbF( 1.0f, 1.0f, 1.0f, 1.0f ) };
    double mShininess = 0.0;
    double mOpacity = 1.0;
    QString mDiffuseTexturePath;
    double mTextureScale { 1.0f };
    double mTextureRotation { 0.0f };
    QPointF mTextureOffset { 0.0, 0.0 };
    mutable std::optional<QColor> mTextureAverageColor;
};
 
 
#endif // QGSPHONGTEXTUREDMATERIALSETTINGS_H