Qgs3DTerrainMetadata Class Reference

Convenience metadata class that uses static functions to create 3D terrain objects. More...

#include <qgs3dterrainregistry.h>

Inheritance diagram for Qgs3DTerrainMetadata:

Public Member Functions
	Qgs3DTerrainMetadata (const QString &type, const QString &visibleName, QgsTerrainSettingsCreateFunc pfSettingsCreate, QgsTerrainGeneratorCreateFunc pfGeneratorCreate, const QIcon &icon=QIcon())
	Constructor for Qgs3DTerrainMetadata, with the specified type and visibleName.
QgsTerrainGeneratorCreateFunc	createGeneratorFunction () const
	Returns the terrain generator creation function.
QgsTerrainSettingsCreateFunc	createSettingsFunction () const
	Returns the terrain setting's creation function.
QgsTerrainGenerator *	createTerrainGenerator () override
	Creates a new instance of this terrain generator type.
QgsAbstractTerrainSettings *	createTerrainSettings () override
	Creates a new instance of this terrain settings type.
Public Member Functions inherited from Qgs3DTerrainAbstractMetadata
	Qgs3DTerrainAbstractMetadata (const QString &type, const QString &visibleName, const QIcon &icon=QIcon())
	Constructor for Qgs3DTerrainAbstractMetadata, with the specified type and visibleName.
virtual	~Qgs3DTerrainAbstractMetadata ()=default
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

Convenience metadata class that uses static functions to create 3D terrain objects.

Note

Not available in Python bindings.

Since

QGIS 3.42

Definition at line 110 of file qgs3dterrainregistry.h.

Constructor & Destructor Documentation

Qgs3DTerrainMetadata()

Qgs3DTerrainMetadata::Qgs3DTerrainMetadata ( const QString &  type, const QString &  visibleName, QgsTerrainSettingsCreateFunc  pfSettingsCreate, QgsTerrainGeneratorCreateFunc  pfGeneratorCreate, const QIcon &  icon = QIcon()  )

inline

Constructor for Qgs3DTerrainMetadata, with the specified type and visibleName.

The pfSettingsCreate and pfGeneratorCreate arguments are used to specify static functions for creating the terrain objects.

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

Definition at line 121 of file qgs3dterrainregistry.h.

Member Function Documentation

createGeneratorFunction()

QgsTerrainGeneratorCreateFunc Qgs3DTerrainMetadata::createGeneratorFunction ( ) const

inline

Returns the terrain generator creation function.

Definition at line 135 of file qgs3dterrainregistry.h.

createSettingsFunction()

QgsTerrainSettingsCreateFunc Qgs3DTerrainMetadata::createSettingsFunction ( ) const

inline

Returns the terrain setting's creation function.

Definition at line 130 of file qgs3dterrainregistry.h.

createTerrainGenerator()

QgsTerrainGenerator * Qgs3DTerrainMetadata::createTerrainGenerator ( )

inlineoverridevirtual

Creates a new instance of this terrain generator type.

Caller takes ownership of the returned object.

Note

Not available in Python bindings

Reimplemented from Qgs3DTerrainAbstractMetadata.

Definition at line 138 of file qgs3dterrainregistry.h.

createTerrainSettings()

QgsAbstractTerrainSettings * Qgs3DTerrainMetadata::createTerrainSettings ( )

inlineoverridevirtual

Creates a new instance of this terrain settings type.

Caller takes ownership of the returned object.

Implements Qgs3DTerrainAbstractMetadata.

Definition at line 137 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