QGIS API Documentation 3.99.0-Master (e9821da5c6b)
Loading...
Searching...
No Matches
qgsterraingenerator.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsterraingenerator.h
3 --------------------------------------
4 Date : July 2017
5 Copyright : (C) 2017 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSTERRAINGENERATOR_H
17#define QGSTERRAINGENERATOR_H
18
19#include "qgis_3d.h"
20#include "qgschunkloader.h"
21#include "qgstilingscheme.h"
22
23class QgsAABB;
26class QgsRectangle;
27class QgsTerrainEntity;
29
30class QDomElement;
31class QDomDocument;
32class QgsProject;
33
34#define SIP_NO_FILE
35
48class _3D_EXPORT QgsTerrainGenerator : public QgsQuadtreeChunkLoaderFactory
49{
50 Q_OBJECT
51 public:
61
67 enum class Capability : int
68 {
69 NoCapabilities = 1 << 0,
70 SupportsTileResolution = 1 << 1,
71 };
72
73 Q_ENUM( Capability )
74 Q_DECLARE_FLAGS( Capabilities, Capability )
75 Q_FLAG( Capabilities )
76
83
85 virtual void setTerrain( QgsTerrainEntity *t ) { mTerrain = t; }
86
89
91 virtual Type type() const = 0;
92
94 virtual void setExtent( const QgsRectangle &extent ) { Q_UNUSED( extent ) }
95
97 virtual QgsRectangle rootChunkExtent() const = 0;
98
100 virtual QgsBox3D rootChunkBox3D( const Qgs3DMapSettings &map ) const;
101
103 virtual float rootChunkError( const Qgs3DMapSettings &map ) const;
104
106 virtual void rootChunkHeightRange( float &hMin, float &hMax ) const;
107
109 virtual float heightAt( double x, double y, const Qgs3DRenderContext &context ) const;
110
112 static QString typeToString( Type type );
113
116
122 virtual void setCrs( const QgsCoordinateReferenceSystem &crs, const QgsCoordinateTransformContext &context );
123
125 virtual QgsCoordinateReferenceSystem crs() const { return mTerrainTilingScheme.crs(); }
126
128 bool isValid() const;
129
130 signals:
131
134
135 protected:
137 QgsTerrainEntity *mTerrain = nullptr;
139
140 bool mIsValid = true;
141};
142
143
144#endif // QGSTERRAINGENERATOR_H
Definition of the world.
Rendering context for preparation of 3D entities.
Axis-aligned bounding box - in world coords.
Definition qgsaabb.h:35
A 3-dimensional box composed of x, y, z coordinates.
Definition qgsbox3d.h:45
Represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:113
A rectangle specified with double values.
Base class for generators of terrain.
Type
Enumeration of the available terrain generators.
@ QuantizedMesh
Terrain is built from quantized mesh tiles.
@ 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.
@ Flat
The whole terrain is flat area.
QgsTilingScheme mTerrainTilingScheme
Tiling scheme of the terrain.
void terrainChanged()
Emitted when the terrain changed (for example, raster DEM or mesh have data changed).
virtual Type type() const =0
What texture generator implementation is this.
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 setExtent(const QgsRectangle &extent)
sets the extent of the terrain in terrain's CRS
static QString typeToString(Type type)
Converts terrain generator type enumeration into a string.
virtual QgsRectangle rootChunkExtent() const =0
extent of the terrain's root chunk in terrain's CRS
QgsTerrainEntity * mTerrain
virtual void rootChunkHeightRange(float &hMin, float &hMax) const
Returns height range of the root chunk in world coordinates.
virtual float heightAt(double x, double y, const Qgs3DRenderContext &context) const
Returns height at (x,y) in map's CRS.
QFlags< Capability > Capabilities
Capability
Specific capabilities of the terrain generator.
virtual void setTerrain(QgsTerrainEntity *t)
Sets terrain entity for the generator (does not transfer ownership).
virtual QgsCoordinateReferenceSystem crs() const
Returns CRS of the terrain.
const QgsTilingScheme & tilingScheme() const
Returns tiling scheme of the terrain.
virtual QgsTerrainGenerator::Capabilities capabilities() const
Returns flags containing the supported capabilities.
virtual QgsTerrainGenerator * clone() const =0SIP_FACTORY
Makes a copy of the current instance.
Encapsulates tiling schemes (just like with WMTS / TMS / XYZ layers).
#define SIP_FACTORY
Definition qgis_sip.h:84