Registry of available 3d terrain classes. More...

#include <qgs3dterrainregistry.h>

Public Member Functions
	Qgs3DTerrainRegistry ()

	Qgs3DTerrainRegistry (const Qgs3DTerrainRegistry &rh)=delete

	~Qgs3DTerrainRegistry ()

bool	addType (Qgs3DTerrainAbstractMetadata *metadata)
	Registers a new terrain type. Takes ownership of the metadata instance.

QgsAbstractTerrainSettings *	configureTerrainFromProject (QgsProjectElevationProperties *properties)
	Create terrain settings directly from a project's elevation properties.

QgsTerrainGenerator *	createTerrainGenerator (const QString &type) const
	Creates a new instance of the terrain generator of the specified type.

QgsAbstractTerrainSettings *	createTerrainSettings (const QString &type) const
	Creates a new instance of the terrain settings of the specified type.

Qgs3DTerrainRegistry &	operator= (const Qgs3DTerrainRegistry &rh)=delete

Qgs3DTerrainAbstractMetadata *	terrainMetadata (const QString &type) const
	Returns metadata for specified terrain type. Returns `nullptr` if not found.

QStringList	types () const
	Returns a list of all available terrain types.

Detailed Description

Registry of available 3d terrain classes.

Qgs3DTerrainRegistry is not usually directly created, but rather accessed through Qgs3D::terrainRegistry().

Since: QGIS 3.42

Definition at line 156 of file qgs3dterrainregistry.h.

Constructor & Destructor Documentation

◆ Qgs3DTerrainRegistry() [1/2]

Qgs3DTerrainRegistry::Qgs3DTerrainRegistry ( )

Definition at line 35 of file qgs3dterrainregistry.cpp.

◆ ~Qgs3DTerrainRegistry()

Qgs3DTerrainRegistry::~Qgs3DTerrainRegistry ( )

Definition at line 44 of file qgs3dterrainregistry.cpp.

◆ Qgs3DTerrainRegistry() [2/2]

Qgs3DTerrainRegistry::Qgs3DTerrainRegistry ( const Qgs3DTerrainRegistry & rh )

delete

Member Function Documentation

◆ addType()

bool Qgs3DTerrainRegistry::addType ( Qgs3DTerrainAbstractMetadata * metadata )

Registers a new terrain type. Takes ownership of the metadata instance.

Definition at line 49 of file qgs3dterrainregistry.cpp.

◆ configureTerrainFromProject()

QgsAbstractTerrainSettings * Qgs3DTerrainRegistry::configureTerrainFromProject ( QgsProjectElevationProperties * properties )

Create terrain settings directly from a project's elevation properties.

Definition at line 75 of file qgs3dterrainregistry.cpp.

◆ createTerrainGenerator()

QgsTerrainGenerator * Qgs3DTerrainRegistry::createTerrainGenerator ( const QString & type ) const

Creates a new instance of the terrain generator of the specified type.

The caller takes ownership of the returned object.

Returns nullptr if the specified type is not found in the registry.

Note: Not available in Python bindings

Definition at line 67 of file qgs3dterrainregistry.cpp.

◆ createTerrainSettings()

QgsAbstractTerrainSettings * Qgs3DTerrainRegistry::createTerrainSettings ( const QString & type ) const

Creates a new instance of the terrain settings of the specified type.

The caller takes ownership of the returned object.

Returns nullptr if the specified type is not found in the registry.

Definition at line 59 of file qgs3dterrainregistry.cpp.

◆ operator=()

Qgs3DTerrainRegistry & Qgs3DTerrainRegistry::operator= ( const Qgs3DTerrainRegistry & rh )

delete

◆ terrainMetadata()

Qgs3DTerrainAbstractMetadata * Qgs3DTerrainRegistry::terrainMetadata ( const QString & type ) const

Returns metadata for specified terrain type. Returns nullptr if not found.

Definition at line 110 of file qgs3dterrainregistry.cpp.

◆ types()

QStringList Qgs3DTerrainRegistry::types ( ) const

Returns a list of all available terrain types.

Definition at line 115 of file qgs3dterrainregistry.cpp.

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

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

Public Member Functions