Stores metadata about one tiled scene renderer class. More...

#include <qgstiledscenerendererregistry.h>

Inheritance diagram for QgsTiledSceneRendererAbstractMetadata:

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

virtual	~QgsTiledSceneRendererAbstractMetadata ()=default

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

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

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

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

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

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

Protected Attributes
QIcon	mIcon
	icon to be shown in the renderer properties dialog

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

QString	mVisibleName
	name visible for users (translatable)

Detailed Description

Stores metadata about one tiled scene renderer class.

Note: It's necessary to implement createRenderer() function. In C++ you can use QgsTiledSceneRendererMetadata convenience class.

Since: QGIS 3.34

Definition at line 43 of file qgstiledscenerendererregistry.h.

Constructor & Destructor Documentation

◆ QgsTiledSceneRendererAbstractMetadata()

QgsTiledSceneRendererAbstractMetadata::QgsTiledSceneRendererAbstractMetadata	(	const QString &	name,
		const QString &	visibleName,
		const QIcon &	icon = `QIcon()`
	)

inline

Constructor for QgsTiledSceneRendererAbstractMetadata, with the specified name.

The visibleName argument gives a translated, user friendly string identifying the renderer type.

The icon argument can be used to specify an icon representing the renderer.

Definition at line 54 of file qgstiledscenerendererregistry.h.

◆ ~QgsTiledSceneRendererAbstractMetadata()

virtual QgsTiledSceneRendererAbstractMetadata::~QgsTiledSceneRendererAbstractMetadata ( )

virtualdefault

Member Function Documentation

◆ createRenderer()

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

pure virtual

Returns new instance of the renderer given the DOM element.

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

Implemented in QgsTiledSceneRendererMetadata.

◆ createRendererWidget()

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

inlinevirtual

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().