QgsMaterialSettingsAbstractMetadata Class Reference

Stores metadata about one 3D material settings class. More...

#include <qgsmaterialregistry.h>

Inheritance diagram for QgsMaterialSettingsAbstractMetadata:

Public Member Functions
	QgsMaterialSettingsAbstractMetadata (const QString &type, const QString &visibleName, const QIcon &icon=QIcon())
	Constructor for QgsMaterialSettingsAbstractMetadata, with the specified type and visibleName.
virtual	~QgsMaterialSettingsAbstractMetadata ()=default
virtual QgsAbstractMaterialSettings *	create ()=0
	Creates a new instance of this material settings type.
virtual QgsMaterialSettingsWidget *	createWidget ()
	Create a widget for configuring a material of this type.
QIcon	icon () const
	Returns an icon representing the material type, if available.
virtual const QgsAbstractMaterial3DHandler *	material3DHandler ()
	Returns 3D handler relating to the material.
virtual bool	supportsTechnique (Qgis::MaterialRenderingTechnique technique) const =0
	Returns true if the material type supports the specified rendering technique.
QString	type () const
	Returns the unique material type string.
QString	visibleName () const
	Returns the material's visible (translated) name.

Detailed Description

Stores metadata about one 3D material settings class.

Note

It's necessary to implement createMaterialSettings() function. In C++ you can use QgsMaterialSettingsMetadata convenience class.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.

Since

QGIS 3.16

Definition at line 46 of file qgsmaterialregistry.h.

Constructor & Destructor Documentation

QgsMaterialSettingsAbstractMetadata()

QgsMaterialSettingsAbstractMetadata::QgsMaterialSettingsAbstractMetadata ( const QString & type, const QString & visibleName, const QIcon & icon = QIcon() )

inline

Constructor for QgsMaterialSettingsAbstractMetadata, with the specified type and visibleName.

An optional icon can be specified to represent the material type.

Definition at line 54 of file qgsmaterialregistry.h.

~QgsMaterialSettingsAbstractMetadata()

virtual QgsMaterialSettingsAbstractMetadata::~QgsMaterialSettingsAbstractMetadata ( )

virtualdefault

Member Function Documentation

create()

virtual QgsAbstractMaterialSettings * QgsMaterialSettingsAbstractMetadata::create ( )

pure virtual

Creates a new instance of this material settings type.

Caller takes ownership of the returned object.

Implemented in QgsMaterialSettingsMetadata.

createWidget()

virtual QgsMaterialSettingsWidget * QgsMaterialSettingsAbstractMetadata::createWidget ( )

inlinevirtual

Create a widget for configuring a material of this type.

Can return nullptr if there's no GUI.

Note

Not available in Python bindings

Reimplemented in QgsMaterialSettingsMetadata.

Definition at line 98 of file qgsmaterialregistry.h.

icon()

QIcon QgsMaterialSettingsAbstractMetadata::icon ( ) const

inline

Returns an icon representing the material type, if available.

Definition at line 75 of file qgsmaterialregistry.h.

material3DHandler()

virtual const QgsAbstractMaterial3DHandler * QgsMaterialSettingsAbstractMetadata::material3DHandler ( )

inlinevirtual

Returns 3D handler relating to the material.

Note

Not available in Python bindings

Definition at line 105 of file qgsmaterialregistry.h.

supportsTechnique()

virtual bool QgsMaterialSettingsAbstractMetadata::supportsTechnique ( Qgis::MaterialRenderingTechnique technique ) const

pure virtual

Returns true if the material type supports the specified rendering technique.

Implemented in QgsMaterialSettingsMetadata.

type()

QString QgsMaterialSettingsAbstractMetadata::type ( ) const

inline

Returns the unique material type string.

Definition at line 65 of file qgsmaterialregistry.h.

visibleName()

QString QgsMaterialSettingsAbstractMetadata::visibleName ( ) const

inline

Returns the material's visible (translated) name.

Definition at line 70 of file qgsmaterialregistry.h.

---

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

• /build/qgis-4.1.0+git20260430+01362494303+99sid/src/core/3d/materials/qgsmaterialregistry.h