QGIS API Documentation  3.21.0-Master (909859188c)
Public Member Functions | List of all members
Qgs3DSymbolRegistry Class Reference

Registry of available 3D symbol classes. More...

#include <qgs3dsymbolregistry.h>

Public Member Functions

 Qgs3DSymbolRegistry ()
 
 Qgs3DSymbolRegistry (const Qgs3DSymbolRegistry &rh)=delete
 Qgs3DSymbolRegistry cannot be copied. More...
 
 ~Qgs3DSymbolRegistry ()
 
bool addSymbolType (Qgs3DSymbolAbstractMetadata *metadata)
 Registers a new symbol type. Takes ownership of the metadata instance. More...
 
QgsFeature3DHandler * createHandlerForSymbol (QgsVectorLayer *layer, const QgsAbstract3DSymbol *symbol)
 Creates a feature handler for a symbol, for the specified vector layer. More...
 
QgsAbstract3DSymbolcreateSymbol (const QString &type) const
 Creates a new instance of a symbol of the specified type. More...
 
QgsAbstract3DSymboldefaultSymbolForGeometryType (QgsWkbTypes::GeometryType type)
 Creates a new instance of the default 3D symbol for the specified geometry type. More...
 
Qgs3DSymbolRegistryoperator= (const Qgs3DSymbolRegistry &rh)=delete
 Qgs3DSymbolRegistry cannot be copied. More...
 
Qgs3DSymbolAbstractMetadatasymbolMetadata (const QString &type) const
 Returns metadata for specified symbol type. Returns nullptr if not found. More...
 
QStringList symbolTypes () const
 Returns a list of all available symbol types. More...
 

Detailed Description

Registry of available 3D symbol classes.

Qgs3DSymbolRegistry is not usually directly created, but rather accessed through QgsApplication::symbol3DRegistry().

Since
QGIS 3.16

Definition at line 183 of file qgs3dsymbolregistry.h.

Constructor & Destructor Documentation

◆ Qgs3DSymbolRegistry() [1/2]

Qgs3DSymbolRegistry::Qgs3DSymbolRegistry ( )

Definition at line 19 of file qgs3dsymbolregistry.cpp.

◆ ~Qgs3DSymbolRegistry()

Qgs3DSymbolRegistry::~Qgs3DSymbolRegistry ( )

Definition at line 23 of file qgs3dsymbolregistry.cpp.

◆ Qgs3DSymbolRegistry() [2/2]

Qgs3DSymbolRegistry::Qgs3DSymbolRegistry ( const Qgs3DSymbolRegistry rh)
delete

Qgs3DSymbolRegistry cannot be copied.

Member Function Documentation

◆ addSymbolType()

bool Qgs3DSymbolRegistry::addSymbolType ( Qgs3DSymbolAbstractMetadata metadata)

Registers a new symbol type. Takes ownership of the metadata instance.

Definition at line 28 of file qgs3dsymbolregistry.cpp.

◆ createHandlerForSymbol()

QgsFeature3DHandler * Qgs3DSymbolRegistry::createHandlerForSymbol ( QgsVectorLayer layer,
const QgsAbstract3DSymbol symbol 
)

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

Caller takes ownership of the returned handler.

Note
Not available in Python bindings

Definition at line 60 of file qgs3dsymbolregistry.cpp.

◆ createSymbol()

QgsAbstract3DSymbol * Qgs3DSymbolRegistry::createSymbol ( const QString &  type) const

Creates a new instance of a symbol of the specified type.

The caller takes ownership of the returned symbol.

Returns nullptr if the specified type is not found in the registry.

Definition at line 37 of file qgs3dsymbolregistry.cpp.

◆ defaultSymbolForGeometryType()

QgsAbstract3DSymbol * Qgs3DSymbolRegistry::defaultSymbolForGeometryType ( QgsWkbTypes::GeometryType  type)

Creates a new instance of the default 3D symbol for the specified geometry type.

The caller takes ownership of the returned symbol.

Definition at line 45 of file qgs3dsymbolregistry.cpp.

◆ operator=()

Qgs3DSymbolRegistry& Qgs3DSymbolRegistry::operator= ( const Qgs3DSymbolRegistry rh)
delete

Qgs3DSymbolRegistry cannot be copied.

◆ symbolMetadata()

Qgs3DSymbolAbstractMetadata * Qgs3DSymbolRegistry::symbolMetadata ( const QString &  type) const

Returns metadata for specified symbol type. Returns nullptr if not found.

Definition at line 71 of file qgs3dsymbolregistry.cpp.

◆ symbolTypes()

QStringList Qgs3DSymbolRegistry::symbolTypes ( ) const

Returns a list of all available symbol types.

Definition at line 76 of file qgs3dsymbolregistry.cpp.


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