QGIS API Documentation 4.1.0-Master (01362494303)
Loading...
Searching...
No Matches
QgsMaterialRegistry Class Reference

Registry of available 3d material settings classes. More...

#include <qgsmaterialregistry.h>

Public Member Functions

 QgsMaterialRegistry ()
 QgsMaterialRegistry (const QgsMaterialRegistry &rh)=delete
 ~QgsMaterialRegistry ()
bool addMaterialSettingsType (QgsMaterialSettingsAbstractMetadata *metadata)
 Registers a new material settings type. Takes ownership of the metadata instance.
std::unique_ptr< QgsAbstractMaterialSettingscreateMaterialSettings (const QString &type) const
 Creates a new instance of the material settings of the specified type.
QgsMaterialSettingsAbstractMetadatamaterialSettingsMetadata (const QString &type) const
 Returns metadata for specified material settings type. Returns nullptr if not found.
QStringList materialSettingsTypes () const
 Returns a list of all available material settings types.
QgsMaterialRegistryoperator= (const QgsMaterialRegistry &rh)=delete
bool populate ()
 Populates the registry with standard material types.

Detailed Description

Registry of available 3d material settings classes.

QgsMaterialRegistry is not usually directly created, but rather accessed through QgsApplication::materialRegistry().

Since
QGIS 3.16

Definition at line 213 of file qgsmaterialregistry.h.

Constructor & Destructor Documentation

◆ QgsMaterialRegistry() [1/2]

QgsMaterialRegistry::QgsMaterialRegistry ( )

Definition at line 32 of file qgsmaterialregistry.cpp.

◆ ~QgsMaterialRegistry()

QgsMaterialRegistry::~QgsMaterialRegistry ( )

Definition at line 35 of file qgsmaterialregistry.cpp.

◆ QgsMaterialRegistry() [2/2]

QgsMaterialRegistry::QgsMaterialRegistry ( const QgsMaterialRegistry & rh)
delete

Member Function Documentation

◆ addMaterialSettingsType()

bool QgsMaterialRegistry::addMaterialSettingsType ( QgsMaterialSettingsAbstractMetadata * metadata)

Registers a new material settings type. Takes ownership of the metadata instance.

Definition at line 74 of file qgsmaterialregistry.cpp.

◆ createMaterialSettings()

std::unique_ptr< QgsAbstractMaterialSettings > QgsMaterialRegistry::createMaterialSettings ( const QString & type) const

Creates a new instance of the material settings of the specified type.

The caller takes ownership of the returned object.

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

Definition at line 84 of file qgsmaterialregistry.cpp.

◆ materialSettingsMetadata()

QgsMaterialSettingsAbstractMetadata * QgsMaterialRegistry::materialSettingsMetadata ( const QString & type) const

Returns metadata for specified material settings type. Returns nullptr if not found.

Definition at line 92 of file qgsmaterialregistry.cpp.

◆ materialSettingsTypes()

QStringList QgsMaterialRegistry::materialSettingsTypes ( ) const

Returns a list of all available material settings types.

Definition at line 97 of file qgsmaterialregistry.cpp.

◆ operator=()

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

◆ populate()

bool QgsMaterialRegistry::populate ( )

Populates the registry with standard material types.

If called on a non-empty registry then this will have no effect and will return false.

Definition at line 40 of file qgsmaterialregistry.cpp.


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