QgsSkyboxSettings Class Reference

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

#include <qgsskyboxsettings.h>

Inheritance diagram for QgsSkyboxSettings:

Public Member Functions
	QgsSkyboxSettings ()=default
	QgsSkyboxSettings (const QgsSkyboxSettings &other)
QgsSkyboxSettings *	clone () const override
	Returns a deep copy of this background settings object.
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.
bool	environmentalLightingEnabled () const
	Returns true if the skybox should generate environmental lighting effects.
double	environmentalLightStrength () const
	Returns the environmental light strength, as a factor between 0 and 1.
QgsSkyboxSettings &	operator= (QgsSkyboxSettings const &rhs)
void	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	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	setEnvironmentalLightingEnabled (bool enabled)
	Sets whether the skybox should generate environmental lighting effects.
void	setEnvironmentalLightStrength (double strength)
	Sets the strength of the environmental light, as a factor between 0 and 1.
Qgis::Map3DBackgroundType	type () const override
	Returns the unique type for this background settings class.
void	writeXml (QDomElement &element, const QgsReadWriteContext &context) const override
	Writes settings to a DOM element.
Public Member Functions inherited from QgsAbstract3DMapBackgroundSettings
virtual	~QgsAbstract3DMapBackgroundSettings ()=default

Detailed Description

Contains the configuration of a skybox entity.

Since

QGIS 3.16

Definition at line 40 of file qgsskyboxsettings.h.

Constructor & Destructor Documentation

QgsSkyboxSettings() [1/2]

QgsSkyboxSettings::QgsSkyboxSettings ( )

default

QgsSkyboxSettings() [2/2]

QgsSkyboxSettings::QgsSkyboxSettings

(

const QgsSkyboxSettings &

other

)

Definition at line 33 of file qgsskyboxsettings.cpp.

Member Function Documentation

clone()

QgsSkyboxSettings * QgsSkyboxSettings::clone ( ) const

overridevirtual

Returns a deep copy of this background settings object.

Implements QgsAbstract3DMapBackgroundSettings.

Definition at line 27 of file qgsskyboxsettings.cpp.

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 66 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 96 of file qgsskyboxsettings.cpp.

environmentalLightingEnabled()

bool QgsSkyboxSettings::environmentalLightingEnabled ( ) const

inline

Returns true if the skybox should generate environmental lighting effects.

See also

setEnvironmentalLightingEnabled()

environmentalLightStrength()

Since

QGIS 4.2

Definition at line 97 of file qgsskyboxsettings.h.

environmentalLightStrength()

double QgsSkyboxSettings::environmentalLightStrength ( ) const

inline

Returns the environmental light strength, as a factor between 0 and 1.

See also

setEnvironmentalLightStrength()

environmentalLightingEnabled()

Since

QGIS 4.2

Definition at line 116 of file qgsskyboxsettings.h.

operator=()

QgsSkyboxSettings & QgsSkyboxSettings::operator=

(

QgsSkyboxSettings const &

rhs

)

Definition at line 45 of file qgsskyboxsettings.cpp.

readXml()

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

overridevirtual

Reads settings from a DOM element.

Implements QgsAbstract3DMapBackgroundSettings.

Definition at line 60 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 72 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 101 of file qgsskyboxsettings.cpp.

setEnvironmentalLightingEnabled()

void QgsSkyboxSettings::setEnvironmentalLightingEnabled ( bool enabled )

inline

Sets whether the skybox should generate environmental lighting effects.

See also

environmentalLightingEnabled()

setEnvironmentalLightStrength()

Since

QGIS 4.2

Definition at line 106 of file qgsskyboxsettings.h.

setEnvironmentalLightStrength()

void QgsSkyboxSettings::setEnvironmentalLightStrength ( double strength )

inline

Sets the strength of the environmental light, as a factor between 0 and 1.

See also

environmentalLightStrength()

setEnvironmentalLightingEnabled()

Since

QGIS 4.2

Definition at line 126 of file qgsskyboxsettings.h.

type()

Qgis::Map3DBackgroundType QgsSkyboxSettings::type ( ) const

inlineoverridevirtual

Returns the unique type for this background settings class.

Implements QgsAbstract3DMapBackgroundSettings.

Definition at line 47 of file qgsskyboxsettings.h.

writeXml()

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

overridevirtual

Writes settings to a DOM element.

Implements QgsAbstract3DMapBackgroundSettings.

Definition at line 79 of file qgsskyboxsettings.cpp.

---

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

• /build/qgis-4.1.0+git20260608+26185ffb827+99sid/src/3d/qgsskyboxsettings.h
• /build/qgis-4.1.0+git20260608+26185ffb827+99sid/src/3d/qgsskyboxsettings.cpp