Convenience metadata class that uses static functions to create point cloud renderer and its widget. More...

#include <qgspointcloudrendererregistry.h>

Inheritance diagram for QgsPointCloudRendererMetadata:

Public Member Functions
	QgsPointCloudRendererMetadata (const QString &name, const QString &visibleName, QgsPointCloudRendererCreateFunc pfCreate, const QIcon &icon=QIcon(), QgsPointCloudRendererWidgetFunc pfWidget=nullptr)
	Construct metadata.

QgsPointCloudRendererCreateFunc	createFunction () const

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

QgsPointCloudRendererWidget *	createRendererWidget (QgsPointCloudLayer layer, QgsStyle style, QgsPointCloudRenderer *renderer) override
	Returns new instance of settings widget for the renderer.

void	setWidgetFunction (QgsPointCloudRendererWidgetFunc f)

QgsPointCloudRendererWidgetFunc	widgetFunction () const

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

virtual	~QgsPointCloudRendererAbstractMetadata ()=default

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
QgsPointCloudRendererCreateFunc	mCreateFunc
	pointer to function that creates an instance of the renderer when loading project / style

QgsPointCloudRendererWidgetFunc	mWidgetFunc
	pointer to function that creates a widget for configuration of renderer's params

Protected Attributes inherited from QgsPointCloudRendererAbstractMetadata
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

Convenience metadata class that uses static functions to create point cloud renderer and its widget.

Since: QGIS 3.18

Definition at line 126 of file qgspointcloudrendererregistry.h.

Constructor & Destructor Documentation

◆ QgsPointCloudRendererMetadata()

QgsPointCloudRendererMetadata::QgsPointCloudRendererMetadata	(	const QString &	name,
		const QString &	visibleName,
		QgsPointCloudRendererCreateFunc	pfCreate,
		const QIcon &	icon = `QIcon()`,
		QgsPointCloudRendererWidgetFunc	pfWidget = `nullptr`
	)

inline

Construct metadata.

Note: not available in Python bindings

Definition at line 134 of file qgspointcloudrendererregistry.h.

Member Function Documentation

◆ createFunction()

QgsPointCloudRendererCreateFunc QgsPointCloudRendererMetadata::createFunction ( ) const

inline

Note: not available in Python bindings

Definition at line 153 of file qgspointcloudrendererregistry.h.

◆ createRenderer()

QgsPointCloudRenderer * QgsPointCloudRendererMetadata::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 QgsPointCloudRendererAbstractMetadata.

Definition at line 144 of file qgspointcloudrendererregistry.h.

◆ createRendererWidget()

QgsPointCloudRendererWidget * QgsPointCloudRendererMetadata::createRendererWidget	(	QgsPointCloudLayer *	layer,
		QgsStyle *	style,
		QgsPointCloudRenderer *	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().