QgsAmbientOcclusionSettings Class Reference

Contains the configuration of ambient occlusion rendering. More...

#include <qgsambientocclusionsettings.h>

Public Member Functions
	QgsAmbientOcclusionSettings ()=default
	QgsAmbientOcclusionSettings (const QgsAmbientOcclusionSettings &other)
float	intensity () const
	Returns the shading factor of the ambient occlusion effect.
bool	isEnabled () const
	Returns whether ambient occlusion effect is enabled.
QgsAmbientOcclusionSettings &	operator= (QgsAmbientOcclusionSettings const &rhs)
float	radius () const
	Returns the radius parameter of the ambient occlusion effect.
void	readXml (const QDomElement &element, const QgsReadWriteContext &context)
	Reads settings from a DOM element.
void	setEnabled (bool enabled)
	Sets whether ambient occlusion effect is enabled.
void	setIntensity (float factor)
	Sets the shading factor of the ambient occlusion effect.
void	setRadius (float radius)
	Sets the radius parameter of the ambient occlusion effect.
void	setThreshold (float threshold)
	Sets at what amount of occlusion the effect will kick in.
float	threshold () const
	Returns at what amount of occlusion the effect will kick in.
void	writeXml (QDomElement &element, const QgsReadWriteContext &context) const
	Writes settings to a DOM element.

Detailed Description

Contains the configuration of ambient occlusion rendering.

Note

Not available in Python bindings

Since

QGIS 3.28

Definition at line 35 of file qgsambientocclusionsettings.h.

Constructor & Destructor Documentation

QgsAmbientOcclusionSettings() [1/2]

QgsAmbientOcclusionSettings::QgsAmbientOcclusionSettings ( )

default

QgsAmbientOcclusionSettings() [2/2]

QgsAmbientOcclusionSettings::QgsAmbientOcclusionSettings

(

const QgsAmbientOcclusionSettings &

other

)

Definition at line 23 of file qgsambientocclusionsettings.cpp.

Member Function Documentation

intensity()

float QgsAmbientOcclusionSettings::intensity ( ) const

inline

Returns the shading factor of the ambient occlusion effect.

Definition at line 57 of file qgsambientocclusionsettings.h.

isEnabled()

bool QgsAmbientOcclusionSettings::isEnabled ( ) const

inline

Returns whether ambient occlusion effect is enabled.

Definition at line 51 of file qgsambientocclusionsettings.h.

operator=()

QgsAmbientOcclusionSettings & QgsAmbientOcclusionSettings::operator=

(

QgsAmbientOcclusionSettings const &

rhs

)

Definition at line 31 of file qgsambientocclusionsettings.cpp.

radius()

float QgsAmbientOcclusionSettings::radius ( ) const

inline

Returns the radius parameter of the ambient occlusion effect.

Definition at line 63 of file qgsambientocclusionsettings.h.

readXml()

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

Reads settings from a DOM element.

Definition at line 40 of file qgsambientocclusionsettings.cpp.

setEnabled()

void QgsAmbientOcclusionSettings::setEnabled ( bool  enabled )

inline

Sets whether ambient occlusion effect is enabled.

Definition at line 48 of file qgsambientocclusionsettings.h.

setIntensity()

void QgsAmbientOcclusionSettings::setIntensity ( float  factor )

inline

Sets the shading factor of the ambient occlusion effect.

Definition at line 54 of file qgsambientocclusionsettings.h.

setRadius()

void QgsAmbientOcclusionSettings::setRadius ( float  radius )

inline

Sets the radius parameter of the ambient occlusion effect.

Definition at line 60 of file qgsambientocclusionsettings.h.

setThreshold()

void QgsAmbientOcclusionSettings::setThreshold ( float  threshold )

inline

Sets at what amount of occlusion the effect will kick in.

Definition at line 66 of file qgsambientocclusionsettings.h.

threshold()

float QgsAmbientOcclusionSettings::threshold ( ) const

inline

Returns at what amount of occlusion the effect will kick in.

Definition at line 69 of file qgsambientocclusionsettings.h.

writeXml()

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

Writes settings to a DOM element.

Definition at line 50 of file qgsambientocclusionsettings.cpp.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/qgsambientocclusionsettings.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/qgsambientocclusionsettings.cpp