Qgs3DTerrainAbstractMetadata Class Reference

Stores metadata about one 3D terrain class. More...

#include <qgs3dterrainregistry.h>

Inheritance diagram for Qgs3DTerrainAbstractMetadata:

Public Member Functions
	Qgs3DTerrainAbstractMetadata (const QString &type, const QString &visibleName, const QIcon &icon=QIcon())
	Constructor for Qgs3DTerrainAbstractMetadata, with the specified type and visibleName.
virtual	~Qgs3DTerrainAbstractMetadata ()=default
virtual QgsTerrainGenerator *	createTerrainGenerator ()
	Creates a new instance of this terrain generator type.
virtual QgsAbstractTerrainSettings *	createTerrainSettings ()=0
	Creates a new instance of this terrain settings type.
QIcon	icon () const
	Returns an icon representing the terrain type, if available.
QString	type () const
	Returns the unique terrain type string.
QString	visibleName () const
	Returns the terrain's visible (translated) name.

Detailed Description

Stores metadata about one 3D terrain class.

Note

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

Since

QGIS 3.42

Definition at line 42 of file qgs3dterrainregistry.h.

Constructor & Destructor Documentation

Qgs3DTerrainAbstractMetadata()

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

inline

Constructor for Qgs3DTerrainAbstractMetadata, with the specified type and visibleName.

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

Definition at line 50 of file qgs3dterrainregistry.h.

~Qgs3DTerrainAbstractMetadata()

virtual Qgs3DTerrainAbstractMetadata::~Qgs3DTerrainAbstractMetadata ( )

virtualdefault

Member Function Documentation

createTerrainGenerator()

virtual QgsTerrainGenerator * Qgs3DTerrainAbstractMetadata::createTerrainGenerator ( )

inlinevirtual

Creates a new instance of this terrain generator type.

Caller takes ownership of the returned object.

Note

Not available in Python bindings

Reimplemented in Qgs3DTerrainMetadata.

Definition at line 87 of file qgs3dterrainregistry.h.

createTerrainSettings()

virtual QgsAbstractTerrainSettings * Qgs3DTerrainAbstractMetadata::createTerrainSettings ( )

pure virtual

Creates a new instance of this terrain settings type.

Caller takes ownership of the returned object.

Implemented in Qgs3DTerrainMetadata.

icon()

QIcon Qgs3DTerrainAbstractMetadata::icon ( ) const

inline

Returns an icon representing the terrain type, if available.

Definition at line 71 of file qgs3dterrainregistry.h.

type()

QString Qgs3DTerrainAbstractMetadata::type ( ) const

inline

Returns the unique terrain type string.

Definition at line 61 of file qgs3dterrainregistry.h.

visibleName()

QString Qgs3DTerrainAbstractMetadata::visibleName ( ) const

inline

Returns the terrain's visible (translated) name.

Definition at line 66 of file qgs3dterrainregistry.h.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/3d/terrain/qgs3dterrainregistry.h