QgsFlatTerrainSettings Class Reference

Terrain settings for a simple flat area terrain. More...

#include <qgsflatterrainsettings.h>

Inheritance diagram for QgsFlatTerrainSettings:

Public Member Functions
QgsFlatTerrainSettings *	clone () const final
	Returns a copy of the terrain settings.
std::unique_ptr< QgsTerrainGenerator >	createTerrainGenerator (const Qgs3DRenderContext &context) const override
	Creates a new instance of a terrain generator which matches the terrain settings.
bool	equals (const QgsAbstractTerrainSettings *other) const final
	Returns true if this settings is exactly equal to another other settings.
void	readXml (const QDomElement &element, const QgsReadWriteContext &context) final
	Reads settings from a DOM element.
QString	type () const final
	Returns the unique type name for the terrain generator.
void	writeXml (QDomElement &element, const QgsReadWriteContext &context) const final
	Writes settings to a DOM element.
Public Member Functions inherited from QgsAbstractTerrainSettings
virtual	~QgsAbstractTerrainSettings ()
double	elevationOffset () const
	Returns the elevation offset of the terrain (used to move the terrain up or down).
int	mapTileResolution () const
	Returns the resolution (in pixels) of the texture of a terrain tile.
double	maximumGroundError () const
	Returns the maximum ground error of terrain tiles in world units.
double	maximumScreenError () const
	Returns the maximum allowed screen error of terrain tiles in pixels.
virtual void	resolveReferences (const QgsProject *project)
	After reading settings from XML, resolves references to any layers in a project that have been read as layer IDs.
void	setElevationOffset (double offset)
	Sets the terrain elevation offset (used to move the terrain up or down).
void	setMapTileResolution (int resolution)
	Sets the resolution (in pixels) of the texture of a terrain tile.
void	setMaximumGroundError (double error)
	Sets the maximum ground error of terrain tiles in world units.
void	setMaximumScreenError (double error)
	Sets the maximum allowed screen error of terrain tiles in pixels.
void	setVerticalScale (double scale)
	Sets the vertical scale (exaggeration) for terrain.
double	verticalScale () const
	Returns the vertical scale (exaggeration) for terrain.

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

Additional Inherited Members
Protected Member Functions inherited from QgsAbstractTerrainSettings
void	copyCommonProperties (const QgsAbstractTerrainSettings *source)
	Copies common properties from a source object.
bool	equalsCommon (const QgsAbstractTerrainSettings *other) const
	Returns true if common base class settings from other match this object.
void	readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context)
	Reads common properties from the base class from the given DOM element.
void	writeCommonProperties (QDomElement &element, const QgsReadWriteContext &context) const
	Writes common properties from the base class into an XML element.

Detailed Description

Terrain settings for a simple flat area terrain.

Warning

This is not considered stable API, and may change in future QGIS releases. It is exposed to the Python bindings as a tech preview only.

Since

QGIS 3.42

Definition at line 37 of file qgsflatterrainsettings.h.

Member Function Documentation

clone()

QgsFlatTerrainSettings * QgsFlatTerrainSettings::clone ( ) const

finalvirtual

Returns a copy of the terrain settings.

Implements QgsAbstractTerrainSettings.

Definition at line 27 of file qgsflatterrainsettings.cpp.

create()

QgsAbstractTerrainSettings * QgsFlatTerrainSettings::create ( )

static

Creates a new instance of a QgsFlatTerrainSettings object.

Definition at line 22 of file qgsflatterrainsettings.cpp.

createTerrainGenerator()

std::unique_ptr< QgsTerrainGenerator > QgsFlatTerrainSettings::createTerrainGenerator ( const Qgs3DRenderContext & context ) const

overridevirtual

Creates a new instance of a terrain generator which matches the terrain settings.

Note

Not available in Python bindings

Implements QgsAbstractTerrainSettings.

Definition at line 56 of file qgsflatterrainsettings.cpp.

equals()

bool QgsFlatTerrainSettings::equals ( const QgsAbstractTerrainSettings * other ) const

finalvirtual

Returns true if this settings is exactly equal to another other settings.

Implements QgsAbstractTerrainSettings.

Definition at line 47 of file qgsflatterrainsettings.cpp.

readXml()

void QgsFlatTerrainSettings::readXml ( const QDomElement & element, const QgsReadWriteContext & context )

finalvirtual

Reads settings from a DOM element.

Subclasses should take care to call readCommonProperties() to read common properties from the element.

See also

resolveReferences()

writeXml()

Implements QgsAbstractTerrainSettings.

Definition at line 37 of file qgsflatterrainsettings.cpp.

type()

QString QgsFlatTerrainSettings::type ( ) const

finalvirtual

Returns the unique type name for the terrain generator.

Implements QgsAbstractTerrainSettings.

Definition at line 32 of file qgsflatterrainsettings.cpp.

writeXml()

void QgsFlatTerrainSettings::writeXml ( QDomElement & element, const QgsReadWriteContext & context ) const

finalvirtual

Writes settings to a DOM element.

Subclasses should take care to call writeCommonProperties() to write common properties to the element.

See also

readXml()

Implements QgsAbstractTerrainSettings.

Definition at line 42 of file qgsflatterrainsettings.cpp.

---

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

• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/terrain/qgsflatterrainsettings.h
• /build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/3d/terrain/qgsflatterrainsettings.cpp