QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsQuantizedMeshTerrainSettings Class Reference

3 More...

#include <qgsquantizedmeshterrainsettings.h>

Inheritance diagram for QgsQuantizedMeshTerrainSettings:
Inheritance graph
[legend]

Public Member Functions

QgsQuantizedMeshTerrainSettingsclone () const final
 Returns a copy of the terrain settings.
 
std::unique_ptr< QgsTerrainGeneratorcreateTerrainGenerator (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.
 
QgsTiledSceneLayerlayer () const
 Returns the quantized mesh tile layer with elevation model to be used for terrain generation.
 
void readXml (const QDomElement &element, const QgsReadWriteContext &context) final
 Reads settings from a DOM element.
 
void resolveReferences (const QgsProject *project) final
 After reading settings from XML, resolves references to any layers in a project that have been read as layer IDs.
 
void setLayer (QgsTiledSceneLayer *layer)
 Sets the quantized mesh tile layer with elevation model to be used for terrain generation.
 
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.
 
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 QgsAbstractTerrainSettingscreate ()
 Creates a new instance of a QgsQuantizedMeshTerrainSettings 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

3

Terrain settings for a terrain generator that uses uses a quantized mesh tile layer to build a 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 38 of file qgsquantizedmeshterrainsettings.h.

Member Function Documentation

◆ clone()

QgsQuantizedMeshTerrainSettings * QgsQuantizedMeshTerrainSettings::clone ( ) const
finalvirtual

Returns a copy of the terrain settings.

Implements QgsAbstractTerrainSettings.

Definition at line 26 of file qgsquantizedmeshterrainsettings.cpp.

◆ create()

QgsAbstractTerrainSettings * QgsQuantizedMeshTerrainSettings::create ( )
static

Creates a new instance of a QgsQuantizedMeshTerrainSettings object.

Definition at line 21 of file qgsquantizedmeshterrainsettings.cpp.

◆ createTerrainGenerator()

std::unique_ptr< QgsTerrainGenerator > QgsQuantizedMeshTerrainSettings::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 75 of file qgsquantizedmeshterrainsettings.cpp.

◆ equals()

bool QgsQuantizedMeshTerrainSettings::equals ( const QgsAbstractTerrainSettings other) const
finalvirtual

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

Implements QgsAbstractTerrainSettings.

Definition at line 63 of file qgsquantizedmeshterrainsettings.cpp.

◆ layer()

QgsTiledSceneLayer * QgsQuantizedMeshTerrainSettings::layer ( ) const

Returns the quantized mesh tile layer with elevation model to be used for terrain generation.

See also
setLayer()

Definition at line 89 of file qgsquantizedmeshterrainsettings.cpp.

◆ readXml()

void QgsQuantizedMeshTerrainSettings::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 36 of file qgsquantizedmeshterrainsettings.cpp.

◆ resolveReferences()

void QgsQuantizedMeshTerrainSettings::resolveReferences ( const QgsProject project)
finalvirtual

After reading settings from XML, resolves references to any layers in a project that have been read as layer IDs.

See also
readXml()

Reimplemented from QgsAbstractTerrainSettings.

Definition at line 58 of file qgsquantizedmeshterrainsettings.cpp.

◆ setLayer()

void QgsQuantizedMeshTerrainSettings::setLayer ( QgsTiledSceneLayer layer)

Sets the quantized mesh tile layer with elevation model to be used for terrain generation.

See also
layer()

Definition at line 84 of file qgsquantizedmeshterrainsettings.cpp.

◆ type()

QString QgsQuantizedMeshTerrainSettings::type ( ) const
finalvirtual

Returns the unique type name for the terrain generator.

Implements QgsAbstractTerrainSettings.

Definition at line 31 of file qgsquantizedmeshterrainsettings.cpp.

◆ writeXml()

void QgsQuantizedMeshTerrainSettings::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 52 of file qgsquantizedmeshterrainsettings.cpp.


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