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

Convenience metadata class that uses static functions to create a 3D symbol and its widget. More...

#include <qgs3dsymbolregistry.h>

Inheritance diagram for Qgs3DSymbolMetadata:
Inheritance graph
[legend]

Public Member Functions

 Qgs3DSymbolMetadata (const QString &type, const QString &visibleName, Qgs3DSymbolCreateFunc pfCreate, Qgs3DSymbolWidgetFunc pfWidget=nullptr, Qgs3DSymbolFeatureHandlerFunc pfHandler=nullptr)
 Constructor for Qgs3DSymbolMetadata, with the specified type and visibleName. More...
 
QgsAbstract3DSymbolcreate () override
 Creates a new instance of this symbol type. More...
 
QgsFeature3DHandler * createFeatureHandler (QgsVectorLayer *layer, const QgsAbstract3DSymbol *symbol) override
 Creates a feature handler for a symbol of matching type, for the specified vector layer. More...
 
Qgs3DSymbolCreateFunc createFunction () const
 Returns the symbol type's creation function. More...
 
Qgs3DSymbolWidgetcreateSymbolWidget (QgsVectorLayer *vl) override
 Create a widget for configuring a symbol of this type. More...
 
void setFeatureHandlerFunction (Qgs3DSymbolFeatureHandlerFunc function)
 Sets the symbol type's feature handler creation function. More...
 
void setWidgetFunction (Qgs3DSymbolWidgetFunc function)
 Sets the symbol type's widget creation function. More...
 
Qgs3DSymbolWidgetFunc widgetFunction () const
 Returns the symbol type's widget creation function. More...
 

Detailed Description

Convenience metadata class that uses static functions to create a 3D symbol and its widget.

Note
Not available in Python bindings.
Since
QGIS 3.16

Definition at line 117 of file qgs3dsymbolregistry.h.

Constructor & Destructor Documentation

◆ Qgs3DSymbolMetadata()

Qgs3DSymbolMetadata::Qgs3DSymbolMetadata ( const QString &  type,
const QString &  visibleName,
Qgs3DSymbolCreateFunc  pfCreate,
Qgs3DSymbolWidgetFunc  pfWidget = nullptr,
Qgs3DSymbolFeatureHandlerFunc  pfHandler = nullptr 
)
inline

Constructor for Qgs3DSymbolMetadata, with the specified type and visibleName.

The pfCreate, pfWidget and pfHandler arguments are used to specify static functions for creating the symbol type and configuration widget.

Definition at line 127 of file qgs3dsymbolregistry.h.

Member Function Documentation

◆ create()

QgsAbstract3DSymbol* Qgs3DSymbolMetadata::create ( )
inlineoverridevirtual

Creates a new instance of this symbol type.

Caller takes ownership of the returned symbol.

Implements Qgs3DSymbolAbstractMetadata.

Definition at line 161 of file qgs3dsymbolregistry.h.

◆ createFeatureHandler()

QgsFeature3DHandler* Qgs3DSymbolMetadata::createFeatureHandler ( QgsVectorLayer layer,
const QgsAbstract3DSymbol symbol 
)
inlineoverridevirtual

Creates a feature handler for a symbol of matching type, for the specified vector layer.

Caller takes ownership of the returned handler.

Note
Not available in Python bindings

Reimplemented from Qgs3DSymbolAbstractMetadata.

Definition at line 163 of file qgs3dsymbolregistry.h.

◆ createFunction()

Qgs3DSymbolCreateFunc Qgs3DSymbolMetadata::createFunction ( ) const
inline

Returns the symbol type's creation function.

Definition at line 140 of file qgs3dsymbolregistry.h.

◆ createSymbolWidget()

Qgs3DSymbolWidget* Qgs3DSymbolMetadata::createSymbolWidget ( QgsVectorLayer )
inlineoverridevirtual

Create a widget for configuring a symbol of this type.

Can return nullptr if there's no GUI.

Note
Not available in Python bindings

Reimplemented from Qgs3DSymbolAbstractMetadata.

Definition at line 162 of file qgs3dsymbolregistry.h.

◆ setFeatureHandlerFunction()

void Qgs3DSymbolMetadata::setFeatureHandlerFunction ( Qgs3DSymbolFeatureHandlerFunc  function)
inline

Sets the symbol type's feature handler creation function.

Definition at line 159 of file qgs3dsymbolregistry.h.

◆ setWidgetFunction()

void Qgs3DSymbolMetadata::setWidgetFunction ( Qgs3DSymbolWidgetFunc  function)
inline

Sets the symbol type's widget creation function.

See also
widgetFunction()

Definition at line 154 of file qgs3dsymbolregistry.h.

◆ widgetFunction()

Qgs3DSymbolWidgetFunc Qgs3DSymbolMetadata::widgetFunction ( ) const
inline

Returns the symbol type's widget creation function.

See also
setWidgetFunction()

Definition at line 147 of file qgs3dsymbolregistry.h.


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