#include <qgsterraingenerator.h>

Inheritance diagram for QgsTerrainGenerator:

[legend]

Public Types
enum	Type { Flat , Dem , Online , Mesh , QuantizedMesh }
	Enumeration of the available terrain generators. More...

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

Public Member Functions
virtual QgsTerrainGenerator *	clone () const =0SIP_FACTORY
	Makes a copy of the current instance.

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

virtual QgsRectangle	extent () const
	extent of the terrain in terrain's CRS, might be non-square and smaller than rootChunkExtent()

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

bool	isValid () const
	Returns whether the terrain generator is valid.

virtual void	readXml (const QDomElement &elem)=0
	Read terrain generator's configuration from XML.

virtual void	resolveReferences (const QgsProject &project)
	After read of XML, resolve references to any layers that have been read as layer IDs.

virtual QgsAABB	rootChunkBbox (const Qgs3DMapSettings &map) const
	Returns bounding box of the root chunk.

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

virtual QgsRectangle	rootChunkExtent () const =0
	extent of the terrain's root chunk in terrain's CRS

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

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

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.

virtual Type	type () const =0
	What texture generator implementation is this.

virtual void	writeXml (QDomElement &elem) const =0
	Write terrain generator's configuration to XML.

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

Protected Attributes
QgsRectangle	mExtent

bool	mIsValid = true

QgsTerrainEntity *	mTerrain = nullptr

QgsTilingScheme	mTerrainTilingScheme
	Tiling scheme of the terrain.

Detailed Description

3

Base class for generators of terrain.

All terrain generators are tile based to support hierarchical level of detail. Tiling scheme of a generator is defined by the generator itself. Terrain generators are asked to produce new terrain tiles whenever that is deemed necessary by the terrain controller (that caches generated tiles).

Note: Not available in Python bindings

Definition at line 49 of file qgsterraingenerator.h.

Member Enumeration Documentation

◆ Type

enum QgsTerrainGenerator::Type

Enumeration of the available terrain generators.

Enumerator
Flat	The whole terrain is flat area.
Dem	Terrain is built from raster layer with digital elevation model.
Online	Terrain is built from downloaded tiles with digital elevation model.
Mesh	Terrain is built from mesh layer with z value on vertices.
QuantizedMesh	Terrain is built from quantized mesh tiles.

Definition at line 55 of file qgsterraingenerator.h.

Member Function Documentation

◆ clone()

virtual QgsTerrainGenerator * QgsTerrainGenerator::clone ( ) const

pure virtual

Makes a copy of the current instance.

Implemented in QgsDemTerrainGenerator, QgsQuantizedMeshTerrainGenerator, QgsFlatTerrainGenerator, and QgsOnlineTerrainGenerator.

◆ crs()

virtual QgsCoordinateReferenceSystem QgsTerrainGenerator::crs ( ) const

inlinevirtual

Returns CRS of the terrain.

Reimplemented in QgsDemTerrainGenerator, QgsFlatTerrainGenerator, and QgsOnlineTerrainGenerator.

Definition at line 110 of file qgsterraingenerator.h.

◆ extent()

virtual QgsRectangle QgsTerrainGenerator::extent ( ) const

inlinevirtual

extent of the terrain in terrain's CRS, might be non-square and smaller than rootChunkExtent()

Definition at line 74 of file qgsterraingenerator.h.

◆ heightAt()

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

virtual

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

Reimplemented in QgsDemTerrainGenerator, QgsOnlineTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

Definition at line 47 of file qgsterraingenerator.cpp.

◆ isValid()

bool QgsTerrainGenerator::isValid ( ) const

Returns whether the terrain generator is valid.

Definition at line 73 of file qgsterraingenerator.cpp.

◆ readXml()

virtual void QgsTerrainGenerator::readXml ( const QDomElement & elem )

pure virtual

Read terrain generator's configuration from XML.

Implemented in QgsDemTerrainGenerator, QgsFlatTerrainGenerator, QgsOnlineTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

◆ resolveReferences()

virtual void QgsTerrainGenerator::resolveReferences ( const QgsProject & project )

inlinevirtual

After read of XML, resolve references to any layers that have been read as layer IDs.

Reimplemented in QgsDemTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

Definition at line 101 of file qgsterraingenerator.h.

◆ rootChunkBbox()

QgsAABB QgsTerrainGenerator::rootChunkBbox ( const Qgs3DMapSettings & map ) const

virtual

Returns bounding box of the root chunk.

Definition at line 23 of file qgsterraingenerator.cpp.

◆ rootChunkError()

float QgsTerrainGenerator::rootChunkError ( const Qgs3DMapSettings & map ) const

virtual

Returns error of the root chunk in world coordinates.

Reimplemented in QgsQuantizedMeshTerrainGenerator.

Definition at line 32 of file qgsterraingenerator.cpp.

◆ rootChunkExtent()

virtual QgsRectangle QgsTerrainGenerator::rootChunkExtent ( ) const

pure virtual

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

Implemented in QgsDemTerrainGenerator, QgsFlatTerrainGenerator, QgsOnlineTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

◆ rootChunkHeightRange()

void QgsTerrainGenerator::rootChunkHeightRange	(	float &	hMin,
		float &	hMax
	)		const

virtual

Returns height range of the root chunk in world coordinates.

Reimplemented in QgsFlatTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

Definition at line 40 of file qgsterraingenerator.cpp.

◆ setExtent()

virtual void QgsTerrainGenerator::setExtent ( const QgsRectangle & extent )

inlinevirtual

sets the extent of the terrain in terrain's CRS

Reimplemented in QgsDemTerrainGenerator, QgsFlatTerrainGenerator, QgsOnlineTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

Definition at line 77 of file qgsterraingenerator.h.

◆ setTerrain()

virtual void QgsTerrainGenerator::setTerrain ( QgsTerrainEntity * t )

inlinevirtual

Sets terrain entity for the generator (does not transfer ownership)

Reimplemented in QgsQuantizedMeshTerrainGenerator.

Definition at line 65 of file qgsterraingenerator.h.

◆ terrainChanged

void QgsTerrainGenerator::terrainChanged ( )

signal

Emitted when the terrain changed (for example, raster DEM or mesh have data changed)

◆ tilingScheme()

const QgsTilingScheme & QgsTerrainGenerator::tilingScheme ( ) const

inline

Returns tiling scheme of the terrain.

Definition at line 107 of file qgsterraingenerator.h.

◆ type()

virtual Type QgsTerrainGenerator::type ( ) const

pure virtual

What texture generator implementation is this.

Implemented in QgsDemTerrainGenerator, QgsFlatTerrainGenerator, QgsOnlineTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

◆ typeToString()

QString QgsTerrainGenerator::typeToString ( QgsTerrainGenerator::Type type )

static

Converts terrain generator type enumeration into a string.

Definition at line 55 of file qgsterraingenerator.cpp.

◆ writeXml()

virtual void QgsTerrainGenerator::writeXml ( QDomElement & elem ) const

pure virtual

Write terrain generator's configuration to XML.

Implemented in QgsDemTerrainGenerator, QgsFlatTerrainGenerator, QgsOnlineTerrainGenerator, and QgsQuantizedMeshTerrainGenerator.

Member Data Documentation

◆ mExtent

QgsRectangle QgsTerrainGenerator::mExtent

protected

Definition at line 124 of file qgsterraingenerator.h.

◆ mIsValid

bool QgsTerrainGenerator::mIsValid = true

protected

Definition at line 126 of file qgsterraingenerator.h.

◆ mTerrain

QgsTerrainEntity* QgsTerrainGenerator::mTerrain = nullptr

protected

Definition at line 123 of file qgsterraingenerator.h.

◆ mTerrainTilingScheme

QgsTilingScheme QgsTerrainGenerator::mTerrainTilingScheme

protected

Tiling scheme of the terrain.

Definition at line 122 of file qgsterraingenerator.h.

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

/build/qgis-3.40.0+99sid/src/3d/terrain/qgsterraingenerator.h
/build/qgis-3.40.0+99sid/src/3d/terrain/qgsterraingenerator.cpp

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Member Function Documentation

◆ clone()

◆ crs()

◆ extent()

◆ heightAt()

◆ isValid()

◆ readXml()

◆ resolveReferences()

◆ rootChunkBbox()

◆ rootChunkError()

◆ rootChunkExtent()

◆ rootChunkHeightRange()

◆ setExtent()

◆ setTerrain()

◆ terrainChanged

◆ tilingScheme()

◆ type()

◆ typeToString()

◆ writeXml()

Member Data Documentation

◆ mExtent

◆ mIsValid

◆ mTerrain

◆ mTerrainTilingScheme