QGIS API Documentation 4.1.0-Master (01362494303)
Loading...
Searching...
No Matches
qgsskyboxsettings.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsskyboxsettings.cpp
3 --------------------------------------
4 Date : August 2020
5 Copyright : (C) 2020 by Belgacem Nedjima
6 Email : gb uderscore nedjima at esi dot dz
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#include "qgsskyboxsettings.h"
17
18#include "qgsreadwritecontext.h"
19#include "qgssymbollayerutils.h"
20
21#include <QDomDocument>
22#include <QString>
23
24using namespace Qt::StringLiterals;
25
27 : mSkyboxType( other.mSkyboxType )
29 , mPanoramicTexturePath( other.mPanoramicTexturePath )
30#endif
31 , mCubeMapping( other.mCubeMapping )
32 , mCubeMapFacesPaths( other.mCubeMapFacesPaths )
33{}
34
36{
37 if ( &rhs == this )
38 return *this;
39
40 this->mSkyboxType = rhs.mSkyboxType;
41#if ENABLE_PANORAMIC_SKYBOX
42 this->mPanoramicTexturePath = rhs.mPanoramicTexturePath;
43#endif
44 this->mCubeMapFacesPaths = rhs.mCubeMapFacesPaths;
45 this->mCubeMapping = rhs.mCubeMapping;
46 return *this;
47}
48
49void QgsSkyboxSettings::readXml( const QDomElement &element, const QgsReadWriteContext &context )
50{
51 const QgsPathResolver &pathResolver = context.pathResolver();
52 const QString skyboxTypeStr = element.attribute( u"skybox-type"_s );
53 if ( skyboxTypeStr == "Distinct Faces"_L1 )
55#if ENABLE_PANORAMIC_SKYBOX
56 else if ( skyboxTypeStr == "Panoramic Texture"_L1 )
57 mSkyboxType = Qgis::SkyboxType::Panoramic;
58 mPanoramicTexturePath = pathResolver.readPath( element.attribute( u"panoramic-texture-path"_s ) );
59#endif
60 mCubeMapFacesPaths.clear();
61 mCubeMapFacesPaths[u"posX"_s] = pathResolver.readPath( element.attribute( u"posX-texture-path"_s ) );
62 mCubeMapFacesPaths[u"posY"_s] = pathResolver.readPath( element.attribute( u"posY-texture-path"_s ) );
63 mCubeMapFacesPaths[u"posZ"_s] = pathResolver.readPath( element.attribute( u"posZ-texture-path"_s ) );
64 mCubeMapFacesPaths[u"negX"_s] = pathResolver.readPath( element.attribute( u"negX-texture-path"_s ) );
65 mCubeMapFacesPaths[u"negY"_s] = pathResolver.readPath( element.attribute( u"negY-texture-path"_s ) );
66 mCubeMapFacesPaths[u"negZ"_s] = pathResolver.readPath( element.attribute( u"negZ-texture-path"_s ) );
67 mCubeMapping = qgsEnumKeyToValue( element.attribute( u"mapping"_s ), Qgis::SkyboxCubeMapping::NativeZUp );
68}
69
70void QgsSkyboxSettings::writeXml( QDomElement &element, const QgsReadWriteContext &context ) const
71{
72 switch ( mSkyboxType )
73 {
75 element.setAttribute( u"skybox-type"_s, u"Distinct Faces"_s );
76 break;
77
78#if ENABLE_PANORAMIC_SKYBOX
79 case Qgis::SkyboxType::Panoramic:
80 element.setAttribute( u"skybox-type"_s, u"Panoramic Texture"_s );
81 break;
82#endif
83 }
84
85 const QgsPathResolver &pathResolver = context.pathResolver();
86#if ENABLE_PANORAMIC_SKYBOX
87 element.setAttribute( u"panoramic-texture-path"_s, pathResolver.writePath( mPanoramicTexturePath ) );
88#endif
89 element.setAttribute( u"posX-texture-path"_s, pathResolver.writePath( mCubeMapFacesPaths[u"posX"_s] ) );
90 element.setAttribute( u"posY-texture-path"_s, pathResolver.writePath( mCubeMapFacesPaths[u"posY"_s] ) );
91 element.setAttribute( u"posZ-texture-path"_s, pathResolver.writePath( mCubeMapFacesPaths[u"posZ"_s] ) );
92 element.setAttribute( u"negX-texture-path"_s, pathResolver.writePath( mCubeMapFacesPaths[u"negX"_s] ) );
93 element.setAttribute( u"negY-texture-path"_s, pathResolver.writePath( mCubeMapFacesPaths[u"negY"_s] ) );
94 element.setAttribute( u"negZ-texture-path"_s, pathResolver.writePath( mCubeMapFacesPaths[u"negZ"_s] ) );
95 element.setAttribute( u"mapping"_s, qgsEnumValueToKey( mCubeMapping ) );
96}
97
99{
100 return mCubeMapping;
101}
102
104{
105 mCubeMapping = mapping;
106}
SkyboxCubeMapping
Skybox texture cube mapping for distinct texture skyboxes.
Definition qgis.h:4385
@ NativeZUp
Textures exported for Z-up (+X Right, +Y Forward, +Z Up).
Definition qgis.h:4386
@ DistinctTextures
Cube map built from distinct textures.
Definition qgis.h:4373
Resolves relative paths into absolute paths and vice versa.
QString writePath(const QString &filename) const
Prepare a filename to save it to the project file.
QString readPath(const QString &filename) const
Turn filename read from the project file to an absolute path.
A container for the context for various read/write operations on objects.
const QgsPathResolver & pathResolver() const
Returns path resolver for conversion between relative and absolute paths.
void setCubeMapping(Qgis::SkyboxCubeMapping mapping)
Sets the cube face mapping scheme.
QgsSkyboxSettings()=default
void readXml(const QDomElement &element, const QgsReadWriteContext &context)
Reads settings from a DOM element.
QgsSkyboxSettings & operator=(QgsSkyboxSettings const &rhs)
void writeXml(QDomElement &element, const QgsReadWriteContext &context) const
Writes settings to a DOM element.
Qgis::SkyboxCubeMapping cubeMapping() const
Returns the cube face mapping scheme.
T qgsEnumKeyToValue(const QString &key, const T &defaultValue, bool tryValueAsKey=true, bool *returnOk=nullptr)
Returns the value corresponding to the given key of an enum.
Definition qgis.h:7323
QString qgsEnumValueToKey(const T &value, bool *returnOk=nullptr)
Returns the value for the given key of an enum.
Definition qgis.h:7304
#define ENABLE_PANORAMIC_SKYBOX