QgsSkyboxSettings Class Reference

Contains the configuration of a skybox entity. More...

#include <qgsskyboxsettings.h>

Public Member Functions
	QgsSkyboxSettings ()=default
	default constructor More...
	QgsSkyboxSettings (const QgsSkyboxSettings &other)
	copy constructor More...
QMap< QString, QString >	cubeMapFacesPaths () const
	Returns a map containing the path of each texture specified by the user. More...
QgsSkyboxSettings &	operator= (QgsSkyboxSettings const &rhs)
	delete assignment operator More...
QString	panoramicTexturePath () const
	Returns the panoramic texture path of a skybox of type "Panormaic skybox". More...
void	readXml (const QDomElement &element, const QgsReadWriteContext &context)
	Reads settings from a DOM element. More...
void	setCubeMapFace (const QString &face, const QString &path)
	Sets a face of one of the skybox 6 textures The face parameter needs to be one of the followings: "posX", "posY", "posZ", "negX", "negY", "negZ". More...
void	setPanoramicTexturePath (const QString &texturePath)
	Sets the panoramic texture path of a skybox of type "Panoramic skybox". More...
void	setSkyboxType (QgsSkyboxEntity::SkyboxType type)
	Sets the type of the skybox. More...
QgsSkyboxEntity::SkyboxType	skyboxType () const
	Returns the type of the skybox. More...
void	writeXml (QDomElement &element, const QgsReadWriteContext &context) const
	Writes settings to a DOM element. More...

Detailed Description

Contains the configuration of a skybox entity.

3

Since

QGIS 3.16

Definition at line 36 of file qgsskyboxsettings.h.

Constructor & Destructor Documentation

QgsSkyboxSettings() [1/2]

QgsSkyboxSettings::QgsSkyboxSettings ( )

default

default constructor

QgsSkyboxSettings() [2/2]

QgsSkyboxSettings::QgsSkyboxSettings

(

const QgsSkyboxSettings &

other

)

copy constructor

Definition at line 23 of file qgsskyboxsettings.cpp.

Member Function Documentation

cubeMapFacesPaths()

QMap<QString, QString> QgsSkyboxSettings::cubeMapFacesPaths ( ) const

inline

Returns a map containing the path of each texture specified by the user.

The map will contain the following keys corresponding to each face "posX", "posY", "posZ", "negX", "negY", "negZ".

Definition at line 65 of file qgsskyboxsettings.h.

operator=()

QgsSkyboxSettings & QgsSkyboxSettings::operator=

(

QgsSkyboxSettings const &

rhs

)

delete assignment operator

Definition at line 31 of file qgsskyboxsettings.cpp.

panoramicTexturePath()

QString QgsSkyboxSettings::panoramicTexturePath ( ) const

inline

Returns the panoramic texture path of a skybox of type "Panormaic skybox".

Definition at line 57 of file qgsskyboxsettings.h.

readXml()

void QgsSkyboxSettings::readXml	(	const QDomElement &	element,
		const QgsReadWriteContext &	context
	)

Reads settings from a DOM element.

Definition at line 39 of file qgsskyboxsettings.cpp.

setCubeMapFace()

void QgsSkyboxSettings::setCubeMapFace ( const QString &  face, const QString &  path  )

inline

Sets a face of one of the skybox 6 textures The face parameter needs to be one of the followings: "posX", "posY", "posZ", "negX", "negY", "negZ".

Definition at line 71 of file qgsskyboxsettings.h.

setPanoramicTexturePath()

void QgsSkyboxSettings::setPanoramicTexturePath ( const QString &  texturePath )

inline

Sets the panoramic texture path of a skybox of type "Panoramic skybox".

Definition at line 59 of file qgsskyboxsettings.h.

setSkyboxType()

void QgsSkyboxSettings::setSkyboxType ( QgsSkyboxEntity::SkyboxType  type )

inline

Sets the type of the skybox.

Definition at line 54 of file qgsskyboxsettings.h.

skyboxType()

QgsSkyboxEntity::SkyboxType QgsSkyboxSettings::skyboxType ( ) const

inline

Returns the type of the skybox.

Definition at line 52 of file qgsskyboxsettings.h.

writeXml()

void QgsSkyboxSettings::writeXml	(	QDomElement &	element,
		const QgsReadWriteContext &	context
	)		const

Writes settings to a DOM element.

Definition at line 57 of file qgsskyboxsettings.cpp.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.20.0+99unstable/src/3d/qgsskyboxsettings.h
• /build/qgis-3.20.0+99unstable/src/3d/qgsskyboxsettings.cpp