QgsLightSource Class Reference

Base class for light sources in 3d scenes. More...

#include <qgslightsource.h>

Inheritance diagram for QgsLightSource:

Public Member Functions
virtual	~QgsLightSource ()
virtual QgsLightSource *	clone () const =0
	Returns a copy of the light source.
virtual Qt3DCore::QEntity *	createEntity (const Qgs3DMapSettings &map, Qt3DCore::QEntity *parent) const =0
	Creates an entity representing the light source.
QString	id () const
	Returns the unique light ID string.
virtual void	readXml (const QDomElement &elem, const QgsReadWriteContext &context=QgsReadWriteContext())=0
	Reads configuration from a DOM element previously written using writeXml().
virtual void	resolveReferences (const QgsProject &project)
	After reading from XML, resolve references to any layers that have been read as layer IDs.
virtual Qgis::LightSourceType	type () const =0
	Returns the light source type.
virtual QDomElement	writeXml (QDomDocument &doc, const QgsReadWriteContext &context=QgsReadWriteContext()) const =0
	Writes the light source's configuration to a new DOM element and returns it.

Static Public Member Functions
static QgsLightSource *	createFromXml (const QDomElement &element, const QgsReadWriteContext &context)
	Creates a new light source from an XML element.

Protected Member Functions
	QgsLightSource ()

Protected Attributes
QString	mId
	Unique light ID.

Detailed Description

Base class for light sources in 3d scenes.

Since

QGIS 3.26

Definition at line 46 of file qgslightsource.h.

Constructor & Destructor Documentation

~QgsLightSource()

QgsLightSource::~QgsLightSource ( )

virtualdefault

QgsLightSource()

QgsLightSource::QgsLightSource ( )

protected

Definition at line 30 of file qgslightsource.cpp.

Member Function Documentation

clone()

virtual QgsLightSource * QgsLightSource::clone ( ) const

pure virtual

Returns a copy of the light source.

Implemented in QgsDirectionalLightSettings, QgsPointLightSettings, and QgsSunLightSettings.

createEntity()

virtual Qt3DCore::QEntity * QgsLightSource::createEntity ( const Qgs3DMapSettings & map, Qt3DCore::QEntity * parent ) const

pure virtual

Creates an entity representing the light source.

Implemented in QgsDirectionalLightSettings, QgsPointLightSettings, and QgsSunLightSettings.

createFromXml()

QgsLightSource * QgsLightSource::createFromXml ( const QDomElement & element, const QgsReadWriteContext & context )

static

Creates a new light source from an XML element.

Definition at line 39 of file qgslightsource.cpp.

id()

QString QgsLightSource::id ( ) const

inline

Returns the unique light ID string.

Since

QGIS 4.2

Definition at line 66 of file qgslightsource.h.

readXml()

virtual void QgsLightSource::readXml ( const QDomElement & elem, const QgsReadWriteContext & context = QgsReadWriteContext() )

pure virtual

Reads configuration from a DOM element previously written using writeXml().

See also

writeXml()

Implemented in QgsDirectionalLightSettings, QgsPointLightSettings, and QgsSunLightSettings.

resolveReferences()

void QgsLightSource::resolveReferences ( const QgsProject & project )

virtual

After reading from XML, resolve references to any layers that have been read as layer IDs.

Definition at line 36 of file qgslightsource.cpp.

type()

virtual Qgis::LightSourceType QgsLightSource::type ( ) const

pure virtual

Returns the light source type.

Implemented in QgsDirectionalLightSettings, QgsPointLightSettings, and QgsSunLightSettings.

writeXml()

virtual QDomElement QgsLightSource::writeXml ( QDomDocument & doc, const QgsReadWriteContext & context = QgsReadWriteContext() ) const

pure virtual

Writes the light source's configuration to a new DOM element and returns it.

See also

readXml()

Implemented in QgsDirectionalLightSettings, QgsPointLightSettings, and QgsSunLightSettings.

Member Data Documentation

mId

QString QgsLightSource::mId

protected

Unique light ID.

Definition at line 101 of file qgslightsource.h.

---

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

• /build/qgis-4.1.0+git20260604+ca2ac17535b+99sid/src/3d/lights/qgslightsource.h
• /build/qgis-4.1.0+git20260604+ca2ac17535b+99sid/src/3d/lights/qgslightsource.cpp