QGIS API Documentation 3.39.0-Master (93ce9bf5c90)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsDemTerrainGenerator Class Reference

3 More...

#include <qgsdemterraingenerator.h>

Inheritance diagram for QgsDemTerrainGenerator:
Inheritance graph
[legend]

Public Member Functions

 QgsDemTerrainGenerator ()=default
 
 ~QgsDemTerrainGenerator () override
 
QgsTerrainGeneratorclone () 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)
 
QgsRasterLayerlayer () const
 Returns raster layer with elevation model to be used for terrain generation.
 
void readXml (const QDomElement &elem) override
 Read terrain generator's configuration from XML.
 
int resolution () const
 Returns resolution of the generator (how many elevation samples on one side of a terrain tile)
 
void resolveReferences (const QgsProject &project) override
 After read of XML, resolve references to any layers that have been read as layer IDs.
 
QgsRectangle rootChunkExtent () const override
 extent of the terrain's root chunk in terrain's CRS
 
void setCrs (const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context)
 Sets CRS of 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.
 
void writeXml (QDomElement &elem) const override
 Write terrain generator's configuration to XML.
 
- Public Member Functions inherited from QgsTerrainGenerator
virtual QgsRectangle extent () const
 extent of the terrain in terrain's CRS, might be non-square and smaller than rootChunkExtent()
 
bool isValid () const
 Returns whether the terrain generator is valid.
 
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 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 QgsTilingSchemetilingScheme () const
 Returns tiling scheme of the terrain.
 

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)
 
- Static Public Member Functions inherited from QgsTerrainGenerator
static QString typeToString (Type type)
 Converts terrain generator type enumeration into a string.
 
- Protected Attributes inherited from QgsTerrainGenerator
QgsRectangle mExtent
 
bool mIsValid = true
 
QgsTerrainEntity * mTerrain = nullptr
 
QgsTilingScheme mTerrainTilingScheme
 Tiling scheme of the terrain.
 

Detailed Description

3

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 24 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 47 of file qgsdemterraingenerator.cpp.

◆ createChunkLoader()

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

Definition at line 104 of file qgsdemterraingenerator.cpp.

◆ crs()

QgsCoordinateReferenceSystem QgsDemTerrainGenerator::crs ( ) const
inlineoverridevirtual

Returns CRS of the terrain.

Reimplemented from QgsTerrainGenerator.

Definition at line 52 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 70 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 65 of file qgsdemterraingenerator.h.

◆ layer()

QgsRasterLayer * QgsDemTerrainGenerator::layer ( ) const

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

Definition at line 35 of file qgsdemterraingenerator.cpp.

◆ readXml()

void QgsDemTerrainGenerator::readXml ( const QDomElement &  elem)
overridevirtual

Read terrain generator's configuration from XML.

Implements QgsTerrainGenerator.

Definition at line 88 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 57 of file qgsdemterraingenerator.h.

◆ resolveReferences()

void QgsDemTerrainGenerator::resolveReferences ( const QgsProject project)
overridevirtual

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

Reimplemented from QgsTerrainGenerator.

Definition at line 97 of file qgsdemterraingenerator.cpp.

◆ rootChunkExtent()

QgsRectangle QgsDemTerrainGenerator::rootChunkExtent ( ) const
overridevirtual

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

Implements QgsTerrainGenerator.

Definition at line 65 of file qgsdemterraingenerator.cpp.

◆ setCrs()

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

Sets CRS of the terrain.

Definition at line 40 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 110 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 29 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 55 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 60 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 62 of file qgsdemterraingenerator.h.

◆ type()

QgsTerrainGenerator::Type QgsDemTerrainGenerator::type ( ) const
overridevirtual

What texture generator implementation is this.

Implements QgsTerrainGenerator.

Definition at line 60 of file qgsdemterraingenerator.cpp.

◆ writeXml()

void QgsDemTerrainGenerator::writeXml ( QDomElement &  elem) const
overridevirtual

Write terrain generator's configuration to XML.

Implements QgsTerrainGenerator.

Definition at line 79 of file qgsdemterraingenerator.cpp.


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