qgssunlightsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgssunlightsettings.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 QGSSUNLIGHTSETTINGS_H
#define QGSSUNLIGHTSETTINGS_H
 
#include "qgis_3d.h"
#include "qgslightsource.h"
#include "qgsvector3d.h"
 
#include <QColor>
 
class QDomDocument;
class QDomElement;

class _3D_EXPORT QgsSunLightSettings : public QgsLightSource
{
  public:
    QgsSunLightSettings() = default;
 
    Qgis::LightSourceType type() const override;
    QgsSunLightSettings *clone() const override SIP_FACTORY;
    Qt3DCore::QEntity *createEntity( const Qgs3DMapSettings &map, Qt3DCore::QEntity *parent ) const override SIP_SKIP;
    QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context = QgsReadWriteContext() ) const override;
    void readXml( const QDomElement &elem, const QgsReadWriteContext &context = QgsReadWriteContext() ) override;

    QgsVector3D direction( const Qgs3DMapSettings &map ) const;

    QDateTime sunTime() const { return mSunTime; }

    void setSunTime( const QDateTime &time ) { mSunTime = time; }

    QColor color() const { return mColor; }

    void setColor( const QColor &color ) { mColor = color; }

    double intensity() const { return mIntensity; }

    void setIntensity( double intensity ) { mIntensity = intensity; }

    double atmosphericPressure() const { return mAtmosphericPressure; }

    void setAtmosphericPressure( double pressure ) { mAtmosphericPressure = pressure; }

    double temperature() const { return mTemperature; }

    void setTemperature( double temperature ) { mTemperature = temperature; }

    double referenceElevation() const { return mReferenceElevation; }

    void setReferenceElevation( double elevation ) { mReferenceElevation = elevation; }
 
    bool operator==( const QgsSunLightSettings &other ) const;
 
  private:
    QDateTime mSunTime = QDateTime::currentDateTimeUtc();
 
    QColor mColor = Qt::white;
    double mIntensity = 1.0;
 
    double mAtmosphericPressure = 1013.25;
    double mTemperature = 15.0;
 
    double mReferenceElevation = 0.0;
};
 
#endif // QGSSUNLIGHTSETTINGS_H