QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
QgsTiledSceneRendererMetadata Class Reference

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

#include <qgstiledscenerendererregistry.h>

Inheritance diagram for QgsTiledSceneRendererMetadata:
Inheritance graph
[legend]

Public Member Functions

 QgsTiledSceneRendererMetadata (const QString &name, const QString &visibleName, QgsTiledSceneRendererCreateFunc pfCreate, const QIcon &icon=QIcon(), QgsTiledSceneRendererWidgetFunc pfWidget=nullptr)
 Construct metadata.
 
QgsTiledSceneRendererCreateFunc createFunction () const
 
QgsTiledSceneRenderercreateRenderer (QDomElement &elem, const QgsReadWriteContext &context) override
 Returns new instance of the renderer given the DOM element.
 
QgsTiledSceneRendererWidgetcreateRendererWidget (QgsTiledSceneLayer *layer, QgsStyle *style, QgsTiledSceneRenderer *renderer) override
 Returns new instance of settings widget for the renderer.
 
void setWidgetFunction (QgsTiledSceneRendererWidgetFunc f)
 
QgsTiledSceneRendererWidgetFunc widgetFunction () const
 

Protected Attributes

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

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

Note
Not available in Python bindings

Reimplemented from QgsTiledSceneRendererAbstractMetadata.

Definition at line 145 of file qgstiledscenerendererregistry.h.

◆ setWidgetFunction()

void QgsTiledSceneRendererMetadata::setWidgetFunction ( QgsTiledSceneRendererWidgetFunc  f)
inline
Note
not available in Python bindings

Definition at line 155 of file qgstiledscenerendererregistry.h.

◆ widgetFunction()

QgsTiledSceneRendererWidgetFunc QgsTiledSceneRendererMetadata::widgetFunction ( ) const
inline
Note
not available in Python bindings

Definition at line 152 of file qgstiledscenerendererregistry.h.

Member Data Documentation

◆ mCreateFunc

QgsTiledSceneRendererCreateFunc QgsTiledSceneRendererMetadata::mCreateFunc
protected

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

Definition at line 159 of file qgstiledscenerendererregistry.h.

◆ mWidgetFunc

QgsTiledSceneRendererWidgetFunc QgsTiledSceneRendererMetadata::mWidgetFunc
protected

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

Definition at line 161 of file qgstiledscenerendererregistry.h.


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