Implementation of terrain generator that uses a raster layer with DEM to build terrain. More...

#include <qgsdemterraingenerator.h>

Inheritance diagram for QgsDemTerrainGenerator:

[legend]

Public Member Functions
	QgsDemTerrainGenerator ()=default

	~QgsDemTerrainGenerator () override

QgsTerrainGenerator *	clone () const override
	Makes a copy of the current instance.

QgsChunkLoader *	createChunkLoader (QgsChunkNode *node) const override

QgsCoordinateReferenceSystem	crs () const override
	Returns CRS of the terrain.

float	heightAt (double x, double y, const Qgs3DRenderContext &context) const override
	Returns height at (x,y) in map's CRS.

QgsDemHeightMapGenerator *	heightMapGenerator ()
	Returns height map generator object - takes care of extraction of elevations from the layer)

QgsRasterLayer *	layer () const
	Returns raster layer with elevation model to be used for terrain generation.

int	resolution () const
	Returns resolution of the generator (how many elevation samples on one side of a terrain tile)

QgsRectangle	rootChunkExtent () const override
	extent of the terrain's root chunk in terrain's CRS

void	setCrs (const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context) override
	Sets the CRS associated with the terrain.

void	setExtent (const QgsRectangle &extent) override
	sets the extent of the terrain in terrain's CRS

void	setLayer (QgsRasterLayer *layer)
	Sets raster layer with elevation model to be used for terrain generation.

void	setResolution (int resolution)
	Sets resolution of the generator (how many elevation samples on one side of a terrain tile)

void	setSkirtHeight (float skirtHeight)
	Sets skirt height (in world units). Skirts at the edges of terrain tiles help hide cracks between adjacent tiles.

float	skirtHeight () const
	Returns skirt height (in world units). Skirts at the edges of terrain tiles help hide cracks between adjacent tiles.

Type	type () const override
	What texture generator implementation is this.

Public Member Functions inherited from QgsTerrainGenerator
bool	isValid () const
	Returns whether the terrain generator is valid.

virtual QgsBox3D	rootChunkBox3D (const Qgs3DMapSettings &map) const
	Returns 3D box (in map coordinates) of the root chunk.

virtual float	rootChunkError (const Qgs3DMapSettings &map) const
	Returns error of the root chunk in world coordinates.

virtual void	rootChunkHeightRange (float &hMin, float &hMax) const
	Returns height range of the root chunk in world coordinates.

virtual void	setTerrain (QgsTerrainEntity *t)
	Sets terrain entity for the generator (does not transfer ownership)

const QgsTilingScheme &	tilingScheme () const
	Returns tiling scheme of the terrain.

Static Public Member Functions
static QgsTerrainGenerator *	create ()
	Creates a new instance of a QgsDemTerrainGenerator object.

Static Public Member Functions inherited from QgsTerrainGenerator
static QString	typeToString (Type type)
	Converts terrain generator type enumeration into a string.

Additional Inherited Members
Public Types inherited from QgsTerrainGenerator
enum	Type { Flat , Dem , Online , Mesh , QuantizedMesh }
	Enumeration of the available terrain generators. More...

Signals inherited from QgsTerrainGenerator
void	terrainChanged ()
	Emitted when the terrain changed (for example, raster DEM or mesh have data changed)

Protected Attributes inherited from QgsTerrainGenerator
QgsRectangle	mExtent

bool	mIsValid = true

QgsTerrainEntity *	mTerrain = nullptr

QgsTilingScheme	mTerrainTilingScheme
	Tiling scheme of the terrain.

Detailed Description

Implementation of terrain generator that uses a raster layer with DEM to build terrain.

Note: Not available in Python bindings

Definition at line 37 of file qgsdemterraingenerator.h.

Constructor & Destructor Documentation

◆ QgsDemTerrainGenerator()

QgsDemTerrainGenerator::QgsDemTerrainGenerator ( )

default

◆ ~QgsDemTerrainGenerator()

QgsDemTerrainGenerator::~QgsDemTerrainGenerator ( )

override

Definition at line 30 of file qgsdemterraingenerator.cpp.

Member Function Documentation

◆ clone()

QgsTerrainGenerator * QgsDemTerrainGenerator::clone ( ) const

overridevirtual

Makes a copy of the current instance.

Implements QgsTerrainGenerator.

Definition at line 53 of file qgsdemterraingenerator.cpp.

◆ create()

QgsTerrainGenerator * QgsDemTerrainGenerator::create ( )

static

Creates a new instance of a QgsDemTerrainGenerator object.

Definition at line 25 of file qgsdemterraingenerator.cpp.

◆ createChunkLoader()

QgsChunkLoader * QgsDemTerrainGenerator::createChunkLoader ( QgsChunkNode * node ) const

override

Definition at line 85 of file qgsdemterraingenerator.cpp.

◆ crs()

QgsCoordinateReferenceSystem QgsDemTerrainGenerator::crs ( ) const

inlineoverridevirtual

Returns CRS of the terrain.

Reimplemented from QgsTerrainGenerator.

Definition at line 56 of file qgsdemterraingenerator.h.

◆ heightAt()

float QgsDemTerrainGenerator::heightAt	(	double	x,
		double	y,
		const Qgs3DRenderContext &	context
	)		const

overridevirtual

Returns height at (x,y) in map's CRS.

Reimplemented from QgsTerrainGenerator.

Definition at line 76 of file qgsdemterraingenerator.cpp.

◆ heightMapGenerator()

QgsDemHeightMapGenerator * QgsDemTerrainGenerator::heightMapGenerator ( )

inline

Returns height map generator object - takes care of extraction of elevations from the layer)

Definition at line 73 of file qgsdemterraingenerator.h.

◆ layer()

QgsRasterLayer * QgsDemTerrainGenerator::layer ( ) const

Returns raster layer with elevation model to be used for terrain generation.

Definition at line 41 of file qgsdemterraingenerator.cpp.

◆ resolution()

int QgsDemTerrainGenerator::resolution ( ) const

inline

Returns resolution of the generator (how many elevation samples on one side of a terrain tile)

Definition at line 65 of file qgsdemterraingenerator.h.

◆ rootChunkExtent()

QgsRectangle QgsDemTerrainGenerator::rootChunkExtent ( ) const

overridevirtual

extent of the terrain's root chunk in terrain's CRS

Implements QgsTerrainGenerator.

Definition at line 71 of file qgsdemterraingenerator.cpp.

◆ setCrs()

void QgsDemTerrainGenerator::setCrs	(	const QgsCoordinateReferenceSystem &	crs,
		const QgsCoordinateTransformContext &	context
	)

overridevirtual

Sets the CRS associated with the terrain.

See also: crs()

Reimplemented from QgsTerrainGenerator.

Definition at line 46 of file qgsdemterraingenerator.cpp.

◆ setExtent()

void QgsDemTerrainGenerator::setExtent ( const QgsRectangle & extent )

overridevirtual

sets the extent of the terrain in terrain's CRS

Reimplemented from QgsTerrainGenerator.

Definition at line 91 of file qgsdemterraingenerator.cpp.

◆ setLayer()

void QgsDemTerrainGenerator::setLayer ( QgsRasterLayer * layer )

Sets raster layer with elevation model to be used for terrain generation.

Definition at line 35 of file qgsdemterraingenerator.cpp.

◆ setResolution()

void QgsDemTerrainGenerator::setResolution ( int resolution )

inline

Sets resolution of the generator (how many elevation samples on one side of a terrain tile)

Definition at line 59 of file qgsdemterraingenerator.h.

◆ setSkirtHeight()

void QgsDemTerrainGenerator::setSkirtHeight ( float skirtHeight )

inline

Sets skirt height (in world units). Skirts at the edges of terrain tiles help hide cracks between adjacent tiles.

Definition at line 68 of file qgsdemterraingenerator.h.

◆ skirtHeight()

float QgsDemTerrainGenerator::skirtHeight ( ) const

inline

Returns skirt height (in world units). Skirts at the edges of terrain tiles help hide cracks between adjacent tiles.

Definition at line 70 of file qgsdemterraingenerator.h.

◆ type()

QgsTerrainGenerator::Type QgsDemTerrainGenerator::type ( ) const

overridevirtual

What texture generator implementation is this.

Implements QgsTerrainGenerator.

Definition at line 66 of file qgsdemterraingenerator.cpp.

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

/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/terrain/qgsdemterraingenerator.h
/build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/3d/terrain/qgsdemterraingenerator.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsDemTerrainGenerator()

◆ ~QgsDemTerrainGenerator()

Member Function Documentation

◆ clone()

◆ create()

◆ createChunkLoader()

◆ crs()

◆ heightAt()

◆ heightMapGenerator()

◆ layer()

◆ resolution()

◆ rootChunkExtent()

◆ setCrs()

◆ setExtent()

◆ setLayer()

◆ setResolution()

◆ setSkirtHeight()

◆ skirtHeight()

◆ type()