QGIS API Documentation 4.3.0-Master (16eddb2670e)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
QgsFlatTerrainGenerator Class Reference
3D library

Terrain generator that creates a simple square flat area. More...

#include <qgsflatterraingenerator.h>

Inheritance diagram for QgsFlatTerrainGenerator:
Inheritance graph
[legend]

Public Member Functions

 QgsFlatTerrainGenerator ()=default
QgsTerrainGenerator * clone () const override
 Makes a copy of the current instance.
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.
QFuture< QgsChunkLoaderResult > loadChunk (QgsChunkNode *node) override
QgsRectangle rootChunkExtent () const override
 extent of the terrain's root chunk in terrain's CRS
void rootChunkHeightRange (float &hMin, float &hMax) const override
 Returns height range of the root chunk in world coordinates.
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
Type type () const override
 What texture generator implementation is this.
Public Member Functions inherited from QgsTerrainGenerator
 QgsTerrainGenerator ()
 Create new terrain generator.
 ~QgsTerrainGenerator () override
virtual QgsTerrainGenerator::Capabilities capabilities () const
 Returns flags containing the supported capabilities.
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 setTerrain (QgsTerrainEntity *t)
 Sets terrain entity for the generator (does not transfer ownership).
const QgsTilingScheme & tilingScheme () const
 Returns tiling scheme of the terrain.
QFuture< QgsChunkLoaderResult > updateChunk (QgsChunkNode *node) override

Static Public Member Functions

static QgsTerrainGenerator * create ()
 Creates a new instance of a QgsFlatTerrainGenerator 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
typedef QFlags< Capability > Capabilities
enum class  Capability : int { NoCapabilities = 1 << 0 , SupportsTileResolution = 1 << 1 }
 Specific capabilities of the terrain generator. More...
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 Member Functions inherited from QgsTerrainGenerator
void applyMaterial (const TerrainTextureResources &resources, QgsTerrainTileEntity *entity, bool isShadingEnabled, const QgsPhongMaterialSettings &shadingMaterial, bool useTexture, const Qgs3DRenderContext &context)
 Creates material component for the entity with the rendered map as a texture.
Qt3DRender::QTexture2D * applyTexture (QgsTerrainTileEntity *entity, const QgsMaterialContext &context, const TerrainTextureResources &resources) const
 Creates a new texture that is linked to the entity.
QFuture< TerrainTextureResources > loadTextureResources (QgsChunkNode *node)
 Asynchronously loads resources for creating texture.
Protected Attributes inherited from QgsTerrainGenerator
QgsRectangle mExtent
bool mIsValid = true
QgsTerrainEntity * mTerrain = nullptr
QgsTilingScheme mTerrainTilingScheme
 Tiling scheme of the terrain.

Detailed Description

Terrain generator that creates a simple square flat area.

Definition at line 31 of file qgsflatterraingenerator.h.

Constructor & Destructor Documentation

◆ QgsFlatTerrainGenerator()

QgsFlatTerrainGenerator::QgsFlatTerrainGenerator ( )
default

Member Function Documentation

◆ clone()

QgsTerrainGenerator * QgsFlatTerrainGenerator::clone ( ) const
overridevirtual

Makes a copy of the current instance.

Implements QgsTerrainGenerator.

Definition at line 96 of file qgsflatterraingenerator.cpp.

◆ create()

QgsTerrainGenerator * QgsFlatTerrainGenerator::create ( )
static

Creates a new instance of a QgsFlatTerrainGenerator object.

Definition at line 31 of file qgsflatterraingenerator.cpp.

◆ crs()

QgsCoordinateReferenceSystem QgsFlatTerrainGenerator::crs ( ) const
inlineoverridevirtual

Returns CRS of the terrain.

Reimplemented from QgsTerrainGenerator.

Definition at line 52 of file qgsflatterraingenerator.h.

◆ heightAt()

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

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

Implements QgsTerrainGenerator.

Definition at line 136 of file qgsflatterraingenerator.cpp.

◆ loadChunk()

QFuture< QgsChunkLoaderResult > QgsFlatTerrainGenerator::loadChunk ( QgsChunkNode * node)
override

Definition at line 36 of file qgsflatterraingenerator.cpp.

◆ rootChunkExtent()

QgsRectangle QgsFlatTerrainGenerator::rootChunkExtent ( ) const
overridevirtual

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

Implements QgsTerrainGenerator.

Definition at line 110 of file qgsflatterraingenerator.cpp.

◆ rootChunkHeightRange()

void QgsFlatTerrainGenerator::rootChunkHeightRange ( float & hMin,
float & hMax ) const
overridevirtual

Returns height range of the root chunk in world coordinates.

Reimplemented from QgsTerrainGenerator.

Definition at line 115 of file qgsflatterraingenerator.cpp.

◆ setCrs()

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

Sets the CRS associated with the terrain.

See also
crs()

Reimplemented from QgsTerrainGenerator.

Definition at line 121 of file qgsflatterraingenerator.cpp.

◆ setExtent()

void QgsFlatTerrainGenerator::setExtent ( const QgsRectangle & extent)
overridevirtual

sets the extent of the terrain in terrain's CRS

Reimplemented from QgsTerrainGenerator.

Definition at line 127 of file qgsflatterraingenerator.cpp.

◆ type()

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

What texture generator implementation is this.

Implements QgsTerrainGenerator.

Definition at line 105 of file qgsflatterraingenerator.cpp.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.17.0