QgsSkyboxSettings Class Reference

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

#include <qgsskyboxsettings.h>

Public Member Functions
	QgsSkyboxSettings ()=default
	QgsSkyboxSettings (const QgsSkyboxSettings &other)
QMap< QString, QString >	cubeMapFacesPaths () const
	Returns a map containing the path of each texture specified by the user.
Qgis::SkyboxCubeMapping	cubeMapping () const
	Returns the cube face mapping scheme.
QgsSkyboxSettings &	operator= (QgsSkyboxSettings const &rhs)
void	readXml (const QDomElement &element, const QgsReadWriteContext &context)
	Reads settings from a DOM element.
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".
void	setCubeMapping (Qgis::SkyboxCubeMapping mapping)
	Sets the cube face mapping scheme.
void	setSkyboxType (Qgis::SkyboxType type)
	Sets the type of the skybox.
Qgis::SkyboxType	skyboxType () const
	Returns the type of the skybox.
void	writeXml (QDomElement &element, const QgsReadWriteContext &context) const
	Writes settings to a DOM element.

Detailed Description

Contains the configuration of a skybox entity.

Since

QGIS 3.16

Definition at line 39 of file qgsskyboxsettings.h.

Constructor & Destructor Documentation

QgsSkyboxSettings() [1/2]

QgsSkyboxSettings::QgsSkyboxSettings ( )

default

QgsSkyboxSettings() [2/2]

QgsSkyboxSettings::QgsSkyboxSettings

(

const QgsSkyboxSettings &

other

)

Definition at line 26 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 67 of file qgsskyboxsettings.h.

cubeMapping()

Qgis::SkyboxCubeMapping QgsSkyboxSettings::cubeMapping

(

)

const

Returns the cube face mapping scheme.

See also

setCubeMapping()

Since

QGIS 4.2

Definition at line 98 of file qgsskyboxsettings.cpp.

operator=()

QgsSkyboxSettings & QgsSkyboxSettings::operator=

(

QgsSkyboxSettings const &

rhs

)

Definition at line 35 of file qgsskyboxsettings.cpp.

readXml()

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

Reads settings from a DOM element.

Definition at line 49 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 73 of file qgsskyboxsettings.h.

setCubeMapping()

void QgsSkyboxSettings::setCubeMapping

(

Qgis::SkyboxCubeMapping

mapping

)

Sets the cube face mapping scheme.

See also

cubeMapping()

Since

QGIS 4.2

Definition at line 103 of file qgsskyboxsettings.cpp.

setSkyboxType()

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

inline

Sets the type of the skybox.

Definition at line 54 of file qgsskyboxsettings.h.

skyboxType()

Qgis::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 70 of file qgsskyboxsettings.cpp.

---

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

• /build/qgis-4.1.0+git20260430+01362494303+99sid/src/3d/qgsskyboxsettings.h
• /build/qgis-4.1.0+git20260430+01362494303+99sid/src/3d/qgsskyboxsettings.cpp