Class: QgsMaterialSettingsAbstractMetadata

Stores metadata about one 3D material settings class.

Note

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

Added in version 3.16.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: create(), supportsTechnique()

Abstract Methods

create

Creates a new instance of this material settings type.

supportsTechnique

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

Methods

icon

Returns an icon representing the material type, if available.

type

Returns the unique material type string.

visibleName

Returns the material's visible (translated) name.

class qgis._3d.QgsMaterialSettingsAbstractMetadata[source]

Bases: object

__init__(type: str | None, visibleName: str | None, icon: QIcon = QIcon())

Constructor for QgsMaterialSettingsAbstractMetadata, with the specified type and visibleName.

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

Parameters:
  • type (Optional[str])

  • visibleName (Optional[str])

  • icon (QIcon = QIcon())

__init__(a0: QgsMaterialSettingsAbstractMetadata)
Parameters:

a0 (QgsMaterialSettingsAbstractMetadata)

abstract create(self) QgsAbstractMaterialSettings | None[source]

Creates a new instance of this material settings type.

Caller takes ownership of the returned object.

Return type:

Optional[QgsAbstractMaterialSettings]

icon(self) QIcon[source]

Returns an icon representing the material type, if available.

Return type:

QIcon

abstract supportsTechnique(self, technique: QgsMaterialSettingsRenderingTechnique) bool[source]

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

Parameters:

technique (QgsMaterialSettingsRenderingTechnique)

Return type:

bool

type(self) str[source]

Returns the unique material type string.

Return type:

str

visibleName(self) str[source]

Returns the material’s visible (translated) name.

Return type:

str