Convenience metadata class that uses static functions to create tiled scene renderer and its widget. More...

#include <qgstiledscenerendererregistry.h>

Inheritance diagram for QgsTiledSceneRendererMetadata:

Public Member Functions
	QgsTiledSceneRendererMetadata (const QString &name, const QString &visibleName, QgsTiledSceneRendererCreateFunc pfCreate, const QIcon &icon=QIcon(), QgsTiledSceneRendererWidgetFunc pfWidget=nullptr)
	Construct metadata. More...

QgsTiledSceneRendererCreateFunc	createFunction () const

QgsTiledSceneRenderer *	createRenderer (QDomElement &elem, const QgsReadWriteContext &context) override
	Returns new instance of the renderer given the DOM element. More...

QgsTiledSceneRendererWidget *	createRendererWidget (QgsTiledSceneLayer layer, QgsStyle style, QgsTiledSceneRenderer *renderer) override
	Returns new instance of settings widget for the renderer. More...

void	setWidgetFunction (QgsTiledSceneRendererWidgetFunc f)

QgsTiledSceneRendererWidgetFunc	widgetFunction () const

Public Member Functions inherited from QgsTiledSceneRendererAbstractMetadata
	QgsTiledSceneRendererAbstractMetadata (const QString &name, const QString &visibleName, const QIcon &icon=QIcon())
	Constructor for QgsTiledSceneRendererAbstractMetadata, with the specified name. More...

virtual	~QgsTiledSceneRendererAbstractMetadata ()=default

virtual QgsTiledSceneRenderer *	createRenderer (QDomElement &elem, const QgsReadWriteContext &context)=0
	Returns new instance of the renderer given the DOM element. More...

virtual QgsTiledSceneRendererWidget *	createRendererWidget (QgsTiledSceneLayer layer, QgsStyle style, QgsTiledSceneRenderer *oldRenderer)
	Returns new instance of settings widget for the renderer. More...

QIcon	icon () const
	Returns an icon representing the renderer. More...

QString	name () const
	Returns the unique name of the renderer. More...

void	setIcon (const QIcon &icon)
	Sets an icon representing the renderer. More...

QString	visibleName () const
	Returns a friendly display name of the renderer. More...

Protected Attributes
QgsTiledSceneRendererCreateFunc	mCreateFunc
	pointer to function that creates an instance of the renderer when loading project / style More...

QgsTiledSceneRendererWidgetFunc	mWidgetFunc
	pointer to function that creates a widget for configuration of renderer's params More...

Protected Attributes inherited from QgsTiledSceneRendererAbstractMetadata
QIcon	mIcon
	icon to be shown in the renderer properties dialog More...

QString	mName
	name used within QGIS for identification (the same what renderer's type() returns) More...

QString	mVisibleName
	name visible for users (translatable) More...

Detailed Description

Convenience metadata class that uses static functions to create tiled scene renderer and its widget.

Since: QGIS 3.34

Definition at line 123 of file qgstiledscenerendererregistry.h.

Constructor & Destructor Documentation

◆ QgsTiledSceneRendererMetadata()

QgsTiledSceneRendererMetadata::QgsTiledSceneRendererMetadata	(	const QString &	name,
		const QString &	visibleName,
		QgsTiledSceneRendererCreateFunc	pfCreate,
		const QIcon &	icon = `QIcon()`,
		QgsTiledSceneRendererWidgetFunc	pfWidget = `nullptr`
	)

inline

Construct metadata.

Note: not available in Python bindings

Definition at line 131 of file qgstiledscenerendererregistry.h.

Member Function Documentation

◆ createFunction()

QgsTiledSceneRendererCreateFunc QgsTiledSceneRendererMetadata::createFunction ( ) const

inline

Note: not available in Python bindings

Definition at line 150 of file qgstiledscenerendererregistry.h.

◆ createRenderer()

QgsTiledSceneRenderer * QgsTiledSceneRendererMetadata::createRenderer	(	QDomElement &	elem,
		const QgsReadWriteContext &	context
	)

inlineoverridevirtual

Returns new instance of the renderer given the DOM element.

Returns nullptr on error. Pure virtual function: must be implemented in derived classes.

Implements QgsTiledSceneRendererAbstractMetadata.

Definition at line 141 of file qgstiledscenerendererregistry.h.

◆ createRendererWidget()

QgsTiledSceneRendererWidget * QgsTiledSceneRendererMetadata::createRendererWidget	(	QgsTiledSceneLayer *	layer,
		QgsStyle *	style,
		QgsTiledSceneRenderer *	oldRenderer
	)

inlineoverridevirtual

Returns new instance of settings widget for the renderer.

Returns nullptr on error.

The oldRenderer argument may refer to previously used renderer (or it is nullptr). If not nullptr, it may be used to initialize GUI of the widget from the previous settings. The old renderer does not have to be of the same type as returned by createRenderer().