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

Stores metadata about one 3D symbol class. More...

#include <qgs3dsymbolregistry.h>

Inheritance diagram for Qgs3DSymbolAbstractMetadata:
Inheritance graph
[legend]

Public Member Functions

 Qgs3DSymbolAbstractMetadata (const QString &type, const QString &visibleName)
 Constructor for Qgs3DSymbolAbstractMetadata, with the specified type and visibleName. More...
 
virtual ~Qgs3DSymbolAbstractMetadata ()=default
 
virtual QgsAbstract3DSymbolcreate ()=0
 Creates a new instance of this symbol type. More...
 
virtual QgsFeature3DHandler * createFeatureHandler (QgsVectorLayer *layer, const QgsAbstract3DSymbol *symbol)
 Creates a feature handler for a symbol of matching type, for the specified vector layer. More...
 
virtual Qgs3DSymbolWidgetcreateSymbolWidget (QgsVectorLayer *)
 Create a widget for configuring a symbol of this type. More...
 
QString type () const
 Returns the unique symbol type string. More...
 
QString visibleName () const
 Returns the symbol's visible (translated) name. More...
 

Detailed Description

Stores metadata about one 3D symbol class.

Note
It's necessary to implement createSymbol() function. In C++ you can use Qgs3DSymbolMetadata convenience class.
Since
QGIS 3.16

Definition at line 41 of file qgs3dsymbolregistry.h.

Constructor & Destructor Documentation

◆ Qgs3DSymbolAbstractMetadata()

Qgs3DSymbolAbstractMetadata::Qgs3DSymbolAbstractMetadata ( const QString &  type,
const QString &  visibleName 
)
inline

Constructor for Qgs3DSymbolAbstractMetadata, with the specified type and visibleName.

Definition at line 48 of file qgs3dsymbolregistry.h.

◆ ~Qgs3DSymbolAbstractMetadata()

virtual Qgs3DSymbolAbstractMetadata::~Qgs3DSymbolAbstractMetadata ( )
virtualdefault

Member Function Documentation

◆ create()

virtual QgsAbstract3DSymbol* Qgs3DSymbolAbstractMetadata::create ( )
pure virtual

Creates a new instance of this symbol type.

Caller takes ownership of the returned symbol.

Implemented in Qgs3DSymbolMetadata.

◆ createFeatureHandler()

virtual QgsFeature3DHandler* Qgs3DSymbolAbstractMetadata::createFeatureHandler ( QgsVectorLayer layer,
const QgsAbstract3DSymbol symbol 
)
inlinevirtual

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 in Qgs3DSymbolMetadata.

Definition at line 90 of file qgs3dsymbolregistry.h.

◆ createSymbolWidget()

virtual Qgs3DSymbolWidget* Qgs3DSymbolAbstractMetadata::createSymbolWidget ( QgsVectorLayer )
inlinevirtual

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 in Qgs3DSymbolMetadata.

Definition at line 81 of file qgs3dsymbolregistry.h.

◆ type()

QString Qgs3DSymbolAbstractMetadata::type ( ) const
inline

Returns the unique symbol type string.

Definition at line 58 of file qgs3dsymbolregistry.h.

◆ visibleName()

QString Qgs3DSymbolAbstractMetadata::visibleName ( ) const
inline

Returns the symbol's visible (translated) name.

Definition at line 63 of file qgs3dsymbolregistry.h.


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