Class: Qgs3DTerrainAbstractMetadata

Stores metadata about one 3D terrain class.

Note

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

Added in version 3.42.

Note

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

The following methods must be implemented: createTerrainSettings()

Abstract Methods

createTerrainSettings

Creates a new instance of this terrain settings type.

Methods

icon

Returns an icon representing the terrain type, if available.

type

Returns the unique terrain type string.

visibleName

Returns the terrain's visible (translated) name.
class qgis._3d.Qgs3DTerrainAbstractMetadata[source]

Bases: object

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

Constructor for Qgs3DTerrainAbstractMetadata, 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: Qgs3DTerrainAbstractMetadata)
Parameters:

a0 (Qgs3DTerrainAbstractMetadata)

abstract createTerrainSettings(self) → QgsAbstractTerrainSettings | None[source]

Creates a new instance of this terrain settings type.

Caller takes ownership of the returned object.

Return type:

Optional[QgsAbstractTerrainSettings]

icon(self) → QIcon[source]

Returns an icon representing the terrain type, if available.

Return type:

QIcon

type(self) → str[source]

Returns the unique terrain type string.

Return type:

str

visibleName(self) → str[source]

Returns the terrain’s visible (translated) name.

Return type:

str