qgsmetalroughtexturedmaterialsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgsmetalroughtexturedmaterialsettings.h
  --------------------------------------
  Date                 : April 2026
  Copyright            : (C) 2026 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 QGSMETALROUGHTEXTUREDMATERIALSETTINGS_H
#define QGSMETALROUGHTEXTUREDMATERIALSETTINGS_H
 
#include "qgis_core.h"
#include "qgsabstractmaterialsettings.h"
 
#include <QColor>
 
class QDomElement;

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

    static bool supportsTechnique( Qgis::MaterialRenderingTechnique technique );

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

    QString baseColorTexturePath() const { return mBaseColorTexturePath; }

    QString metalnessTexturePath() const { return mMetalnessTexturePath; }

    QString roughnessTexturePath() const { return mRoughnessTexturePath; }

    QString normalTexturePath() const { return mNormalTexturePath; }

    QString heightTexturePath() const { return mHeightTexturePath; }

    double parallaxScale() const { return mParallaxScale; }

    QString emissionTexturePath() const { return mEmissionTexturePath; }

    double emissionFactor() const { return mEmissionFactor; }

    QString ambientOcclusionTexturePath() const { return mAmbientOcclusionTexturePath; }

    double textureScale() const { return mTextureScale; }

    double textureRotation() const { return mTextureRotation; }

    QPointF textureOffset() const { return mTextureOffset; }

    double opacity() const { return mOpacity; }

    void setBaseColorTexturePath( const QString &path ) { mBaseColorTexturePath = path; }

    void setMetalnessTexturePath( const QString &path ) { mMetalnessTexturePath = path; }

    void setRoughnessTexturePath( const QString &path ) { mRoughnessTexturePath = path; }

    void setNormalTexturePath( const QString &path ) { mNormalTexturePath = path; }

    void setHeightTexturePath( const QString &path ) { mHeightTexturePath = path; }

    void setParallaxScale( double scale ) { mParallaxScale = scale; }

    void setAmbientOcclusionTexturePath( const QString &path ) { mAmbientOcclusionTexturePath = path; }

    void setEmissionTexturePath( const QString &path ) { mEmissionTexturePath = path; }

    void setEmissionFactor( double factor ) { mEmissionFactor = factor; }

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

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

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

    void setOpacity( double opacity ) { mOpacity = opacity; }
 
    bool requiresTextureCoordinates() const override;
    bool requiresTangents() const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;

    QColor averageColor() const override;

    void setColorsFromBase( const QColor &baseColor ) override;
 
    bool operator==( const QgsMetalRoughTexturedMaterialSettings &other ) const
    {
      return mBaseColorTexturePath == other.mBaseColorTexturePath
             && mMetalnessTexturePath == other.mMetalnessTexturePath
             && mRoughnessTexturePath == other.mRoughnessTexturePath
             && mNormalTexturePath == other.mNormalTexturePath
             && mAmbientOcclusionTexturePath == other.mAmbientOcclusionTexturePath
             && mHeightTexturePath == other.mHeightTexturePath
             && mEmissionTexturePath == other.mEmissionTexturePath
             && qgsDoubleNear( mTextureScale, other.mTextureScale )
             && qgsDoubleNear( mTextureRotation, other.mTextureRotation )
             && qgsDoubleNear( mEmissionFactor, other.mEmissionFactor )
             && qgsDoubleNear( mParallaxScale, other.mParallaxScale )
             && qgsDoubleNear( mTextureOffset.x(), other.mTextureOffset.x() )
             && qgsDoubleNear( mTextureOffset.y(), other.mTextureOffset.y() )
             && qgsDoubleNear( mOpacity, other.mOpacity )
             && dataDefinedProperties() == other.dataDefinedProperties();
    }
 
  private:
    QColor textureAverageColor( const QString &texturePath ) const;
 
  private:
    QString mBaseColorTexturePath;
    QString mMetalnessTexturePath;
    QString mRoughnessTexturePath;
    QString mNormalTexturePath;
    QString mHeightTexturePath;
    double mParallaxScale { 0.1 };
 
    QString mAmbientOcclusionTexturePath;
 
    QString mEmissionTexturePath;
    double mEmissionFactor { 1.0 };
 
    double mTextureScale { 1.0 };
    double mTextureRotation { 0.0 };
    QPointF mTextureOffset { 0.0, 0.0 };
    double mOpacity { 1.0 };
 
    mutable std::optional<QColor> mAverageColor;
};
 
 
#endif // QGSMETALROUGHTEXTUREDMATERIALSETTINGS_H