qgsmetalroughmaterialsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgsmetalroughmaterialsettings.h
  --------------------------------------
  Date                 : December 2023
  Copyright            : (C) 2023 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 QGSMETALROUGHMATERIALSETTINGS_H
#define QGSMETALROUGHMATERIALSETTINGS_H
 
#include "qgis_core.h"
#include "qgsabstractmaterialsettings.h"
 
#include <QColor>
 
class QDomElement;

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

    static bool supportsTechnique( Qgis::MaterialRenderingTechnique technique );

    static QgsAbstractMaterialSettings *create() SIP_FACTORY;
 
    QgsMetalRoughMaterialSettings *clone() const override SIP_FACTORY;
    bool equals( const QgsAbstractMaterialSettings *other ) const override;

    QColor baseColor() const { return mBaseColor; }

    double metalness() const { return mMetalness; }

    double roughness() const { return mRoughness; }

    QColor emissionColor() const { return mEmissiveColor; }

    double emissionFactor() const { return mEmissionFactor; }

    double opacity() const { return mOpacity; }

    QColor averageColor() const override;

    void setBaseColor( const QColor &color ) { mBaseColor = color; }

    void setMetalness( double metalness ) { mMetalness = metalness; }

    void setRoughness( double roughness ) { mRoughness = roughness; }

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

    void setEmissionColor( const QColor &color ) { mEmissiveColor = color; }

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

    void setColorsFromBase( const QColor &baseColor ) override;
 
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) override;
    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const override;
 
    bool operator==( const QgsMetalRoughMaterialSettings &other ) const
    {
      return mBaseColor == other.mBaseColor
             && mEmissiveColor == other.mEmissiveColor
             && qgsDoubleNear( mMetalness, other.mMetalness )
             && qgsDoubleNear( mRoughness, other.mRoughness )
             && qgsDoubleNear( mOpacity, other.mOpacity )
             && qgsDoubleNear( mEmissionFactor, other.mEmissionFactor )
             && dataDefinedProperties() == other.dataDefinedProperties();
    }
 
  private:
    QColor mBaseColor { QColor::fromRgbF( 0.5f, 0.5f, 0.5f, 1.0f ) };
    QColor mEmissiveColor;
    double mMetalness = 0.0;
    double mRoughness = 0.5;
    double mEmissionFactor = 1.0;
    double mOpacity = 1.0;
};
 
 
#endif // QGSMETALROUGHMATERIALSETTINGS_H