QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Member Functions | Protected Attributes | List of all members
QgsPointCloudRendererMetadata Class Reference

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

#include <qgspointcloudrendererregistry.h>

Inheritance diagram for QgsPointCloudRendererMetadata:
Inheritance graph
[legend]

Public Member Functions

 QgsPointCloudRendererMetadata (const QString &name, const QString &visibleName, QgsPointCloudRendererCreateFunc pfCreate, const QIcon &icon=QIcon(), QgsPointCloudRendererWidgetFunc pfWidget=nullptr)
 Construct metadata. More...
 
QgsPointCloudRendererCreateFunc createFunction () const
 
QgsPointCloudRenderercreateRenderer (QDomElement &elem, const QgsReadWriteContext &context) override
 Returns new instance of the renderer given the DOM element. More...
 
QgsPointCloudRendererWidgetcreateRendererWidget (QgsPointCloudLayer *layer, QgsStyle *style, QgsPointCloudRenderer *renderer) override
 Returns new instance of settings widget for the renderer. More...
 
void setWidgetFunction (QgsPointCloudRendererWidgetFunc f)
 
QgsPointCloudRendererWidgetFunc widgetFunction () const
 

Protected Attributes

QgsPointCloudRendererCreateFunc mCreateFunc
 pointer to function that creates an instance of the renderer when loading project / style More...
 
QgsPointCloudRendererWidgetFunc mWidgetFunc
 pointer to function that creates a widget for configuration of renderer's params More...
 

Detailed Description

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

Since
QGIS 3.18

Definition at line 125 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 133 of file qgspointcloudrendererregistry.h.

Member Function Documentation

◆ createFunction()

QgsPointCloudRendererCreateFunc QgsPointCloudRendererMetadata::createFunction ( ) const
inline
Note
not available in Python bindings

Definition at line 152 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 143 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().

Note
Not available in Python bindings

Reimplemented from QgsPointCloudRendererAbstractMetadata.

Definition at line 147 of file qgspointcloudrendererregistry.h.

◆ setWidgetFunction()

void QgsPointCloudRendererMetadata::setWidgetFunction ( QgsPointCloudRendererWidgetFunc  f)
inline
Note
not available in Python bindings

Definition at line 157 of file qgspointcloudrendererregistry.h.

◆ widgetFunction()

QgsPointCloudRendererWidgetFunc QgsPointCloudRendererMetadata::widgetFunction ( ) const
inline
Note
not available in Python bindings

Definition at line 154 of file qgspointcloudrendererregistry.h.

Member Data Documentation

◆ mCreateFunc

QgsPointCloudRendererCreateFunc QgsPointCloudRendererMetadata::mCreateFunc
protected

pointer to function that creates an instance of the renderer when loading project / style

Definition at line 161 of file qgspointcloudrendererregistry.h.

◆ mWidgetFunc

QgsPointCloudRendererWidgetFunc QgsPointCloudRendererMetadata::mWidgetFunc
protected

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

Definition at line 163 of file qgspointcloudrendererregistry.h.


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