qgsskyboxsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgsskyboxsettings.h
  --------------------------------------
  Date                 : August 2020
  Copyright            : (C) 2020 by Belgacem Nedjima
  Email                : gb uderscore nedjima at esi dot dz
 ***************************************************************************
 *                                                                         *
 *   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 QGSSKYBOXSETTINGS_H
#define QGSSKYBOXSETTINGS_H
 
#include "qgis_3d.h"
#include "qgsabstract3dmapbackgroundsettings.h"
#include "qgsskyboxentity.h"
 
#include <QMap>
#include <QString>
 
#define SIP_NO_FILE
 
class QgsReadWriteContext;
class QDomElement;
 
// this is broken for z-up coordinate system
#define ENABLE_PANORAMIC_SKYBOX 0

class _3D_EXPORT QgsSkyboxSettings : public QgsAbstract3DMapBackgroundSettings
{
  public:
    QgsSkyboxSettings() = default;
    QgsSkyboxSettings( const QgsSkyboxSettings &other );
    QgsSkyboxSettings &operator=( QgsSkyboxSettings const &rhs );
 
    Qgis::Map3DBackgroundType type() const override { return Qgis::Map3DBackgroundType::DistinctTextureSkybox; }
    QgsSkyboxSettings *clone() const override SIP_FACTORY;

    void readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    void writeXml( QDomElement &element, const QgsReadWriteContext &context ) const override;
 
#if ENABLE_PANORAMIC_SKYBOX
    QString panoramicTexturePath() const { return mPanoramicTexturePath; }
    void setPanoramicTexturePath( const QString &texturePath ) { mPanoramicTexturePath = texturePath; }
#endif

    QMap<QString, QString> cubeMapFacesPaths() const { return mCubeMapFacesPaths; }

    void setCubeMapFace( const QString &face, const QString &path ) { mCubeMapFacesPaths[face] = path; }

    Qgis::SkyboxCubeMapping cubeMapping() const;

    void setCubeMapping( Qgis::SkyboxCubeMapping mapping );

    bool environmentalLightingEnabled() const { return mEnableEnvironmentalLighting; }

    void setEnvironmentalLightingEnabled( bool enabled ) { mEnableEnvironmentalLighting = enabled; }

    double environmentalLightStrength() const { return mEnvironmentalLightStrength; }

    void setEnvironmentalLightStrength( double strength ) { mEnvironmentalLightStrength = strength; }
 
  private:
#if ENABLE_PANORAMIC_SKYBOX
    QString mPanoramicTexturePath;
#endif
 
    Qgis::SkyboxCubeMapping mCubeMapping = Qgis::SkyboxCubeMapping::NativeZUp;
    QMap<QString, QString> mCubeMapFacesPaths;
    bool mEnableEnvironmentalLighting = true;
    double mEnvironmentalLightStrength = 1.0;
};
 
#endif // QGSSKYBOXSETTINGS_H