QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
qgs3dmapsettings.h
Go to the documentation of this file.
1/***************************************************************************
2 qgs3dmapsettings.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 QGS3DMAPSETTINGS_H
17#define QGS3DMAPSETTINGS_H
18
19#include "qgis_3d.h"
20
21#include <memory>
22#include <QColor>
23#include <QMatrix4x4>
24#include <Qt3DRender/QCamera>
25
27#include "qgsmaplayerref.h"
29#include "qgsterraingenerator.h"
30#include "qgsvector3d.h"
31#include "qgs3daxissettings.h"
32#include "qgsskyboxsettings.h"
33#include "qgsshadowsettings.h"
36
37class QgsMapLayer;
38class QgsRasterLayer;
39class QgsLightSource;
42class QgsProject;
43
44class QDomElement;
45
51class _3D_EXPORT Qgs3DMapSettings : public QObject, public QgsTemporalRangeObject
52{
53 Q_OBJECT
54 public:
58 Qgs3DMapSettings( const Qgs3DMapSettings &other );
59 ~Qgs3DMapSettings() override;
60
62
64 void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
66 QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
68 void resolveReferences( const QgsProject &project );
69
76 QgsRectangle extent() const { return mExtent; }
77
87 void setExtent( const QgsRectangle &extent );
88
100 void setOrigin( const QgsVector3D &origin ) { mOrigin = origin; }
102 QgsVector3D origin() const { return mOrigin; }
103
105 QgsVector3D mapToWorldCoordinates( const QgsVector3D &mapCoords ) const;
107 QgsVector3D worldToMapCoordinates( const QgsVector3D &worldCoords ) const;
108
110 void setCrs( const QgsCoordinateReferenceSystem &crs );
112 QgsCoordinateReferenceSystem crs() const { return mCrs; }
113
121 QgsCoordinateTransformContext transformContext() const;
122
130 void setTransformContext( const QgsCoordinateTransformContext &context );
131
138 const QgsPathResolver &pathResolver() const { return mPathResolver; }
139
146 void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }
147
154 QgsMapThemeCollection *mapThemeCollection() const { return mMapThemes; }
155
161 void setMapThemeCollection( QgsMapThemeCollection *mapThemes ) { mMapThemes = mapThemes; }
162
164 void setBackgroundColor( const QColor &color );
166 QColor backgroundColor() const;
167
169 void setSelectionColor( const QColor &color );
171 QColor selectionColor() const;
172
181 void setLayers( const QList<QgsMapLayer *> &layers );
182
191 QList<QgsMapLayer *> layers() const;
192
193 //
194 // terrain related config
195 //
196
202 void configureTerrainFromProject( QgsProjectElevationProperties *properties, const QgsRectangle &fullExtent ) SIP_SKIP;
203
208 void setTerrainVerticalScale( double zScale );
210 double terrainVerticalScale() const;
211
216 void setMapTileResolution( int res );
217
222 int mapTileResolution() const;
223
228 void setMaxTerrainScreenError( float error );
229
237 float maxTerrainScreenError() const;
238
243 void setMaxTerrainGroundError( float error );
244
251 float maxTerrainGroundError() const;
252
258 void setTerrainElevationOffset( float offset );
259
263 float terrainElevationOffset() const { return mTerrainElevationOffset; }
264
277 void setTerrainGenerator( QgsTerrainGenerator *gen SIP_TRANSFER ) SIP_SKIP;
278
290 {
291 return mTerrainGenerator.get();
292 }
293
299 void setTerrainShadingEnabled( bool enabled );
300
307 bool isTerrainShadingEnabled() const { return mTerrainShadingEnabled; }
308
314 void setTerrainShadingMaterial( const QgsPhongMaterialSettings &material );
315
321 QgsPhongMaterialSettings terrainShadingMaterial() const { return mTerrainShadingMaterial; }
322
328 void setTerrainMapTheme( const QString &theme );
329
336 QString terrainMapTheme() const { return mTerrainMapTheme; }
337
338 //
339 // misc configuration
340 //
341
343 void setShowTerrainBoundingBoxes( bool enabled );
345 bool showTerrainBoundingBoxes() const { return mShowTerrainBoundingBoxes; }
347 void setShowTerrainTilesInfo( bool enabled );
349 bool showTerrainTilesInfo() const { return mShowTerrainTileInfo; }
350
355 void setShowCameraViewCenter( bool enabled );
356
361 bool showCameraViewCenter() const { return mShowCameraViewCenter; }
362
367 void setShowCameraRotationCenter( bool enabled );
368
373 bool showCameraRotationCenter() const { return mShowCameraRotationCenter; }
374
379 void setShowLightSourceOrigins( bool enabled );
380
385 bool showLightSourceOrigins() const { return mShowLightSources; }
386
388 void setShowLabels( bool enabled );
390 bool showLabels() const { return mShowLabels; }
391
397 void setEyeDomeLightingEnabled( bool enabled );
399 bool eyeDomeLightingEnabled() const { return mEyeDomeLightingEnabled; }
400
406 void setEyeDomeLightingStrength( double strength );
408 double eyeDomeLightingStrength() const { return mEyeDomeLightingStrength; }
409
415 void setEyeDomeLightingDistance( int distance );
417 int eyeDomeLightingDistance() const { return mEyeDomeLightingDistance; }
418
424 void setDebugShadowMapSettings( bool enabled, Qt::Corner corner, double size );
426 bool debugShadowMapEnabled() const { return mDebugShadowMapEnabled; }
428 Qt::Corner debugShadowMapCorner() const { return mDebugShadowMapCorner; }
430 double debugShadowMapSize() const { return mDebugShadowMapSize; }
431
437 void setDebugDepthMapSettings( bool enabled, Qt::Corner corner, double size );
439 bool debugDepthMapEnabled() const { return mDebugDepthMapEnabled; }
441 Qt::Corner debugDepthMapCorner() const { return mDebugDepthMapCorner; }
443 double debugDepthMapSize() const { return mDebugDepthMapSize; }
444
450 QList<QgsLightSource *> lightSources() const;
451
460 void setLightSources( const QList<QgsLightSource *> &lights SIP_TRANSFER );
461
466 float fieldOfView() const { return mFieldOfView; }
467
472 void setFieldOfView( const float fieldOfView );
473
478 Qt3DRender::QCameraLens::ProjectionType projectionType() const SIP_SKIP { return mProjectionType; }
479
484 void setProjectionType( const Qt3DRender::QCameraLens::ProjectionType projectionType ) SIP_SKIP;
485
486#ifndef SIP_RUN
487
492 Qgis::NavigationMode cameraNavigationMode() const { return mCameraNavigationMode; }
493
498 void setCameraNavigationMode( Qgis::NavigationMode navigationMode );
499#endif
500
505 double cameraMovementSpeed() const { return mCameraMovementSpeed; }
506
511 void setCameraMovementSpeed( double movementSpeed );
512
518 void setOutputDpi( const double dpi ) {mDpi = dpi;}
519
520
526 double outputDpi() const { return mDpi; }
527
532 QgsSkyboxSettings skyboxSettings() const SIP_SKIP { return mSkyboxSettings; }
533
538 QgsShadowSettings shadowSettings() const SIP_SKIP { return mShadowSettings; }
539
544 QgsAmbientOcclusionSettings ambientOcclusionSettings() const SIP_SKIP { return mAmbientOcclusionSettings; }
545
550 void setSkyboxSettings( const QgsSkyboxSettings &skyboxSettings ) SIP_SKIP;
551
556 void setShadowSettings( const QgsShadowSettings &shadowSettings ) SIP_SKIP;
557
562 void setAmbientOcclusionSettings( const QgsAmbientOcclusionSettings &ambientOcclusionSettings ) SIP_SKIP;
563
569 bool isSkyboxEnabled() const { return mIsSkyboxEnabled; }
570
576 void setIsSkyboxEnabled( bool enabled ) { mIsSkyboxEnabled = enabled; }
577
583 bool isFpsCounterEnabled() const { return mIsFpsCounterEnabled; }
584
590 void setIsFpsCounterEnabled( bool fpsCounterEnabled );
591
597 bool terrainRenderingEnabled() const { return mTerrainRenderingEnabled; }
598
604 void setTerrainRenderingEnabled( bool terrainRenderingEnabled );
605
612 Qgis::RendererUsage rendererUsage() const;
613
620 void setRendererUsage( Qgis::RendererUsage rendererUsage );
621
627 Qgis::ViewSyncModeFlags viewSyncMode() const { return mViewSyncMode; }
628
634 void setViewSyncMode( Qgis::ViewSyncModeFlags mode );
635
641 bool viewFrustumVisualizationEnabled() const { return mVisualizeViewFrustum; }
642
648 void setViewFrustumVisualizationEnabled( bool enabled );
649
654 Qgs3DAxisSettings get3DAxisSettings() const SIP_SKIP { return m3dAxisSettings; }
655
660 void set3DAxisSettings( const Qgs3DAxisSettings &axisSettings, bool force = false ) SIP_SKIP;
661
667 bool isDebugOverlayEnabled() const { return mIsDebugOverlayEnabled; }
668
677 void setIsDebugOverlayEnabled( bool debugOverlayEnabled );
678
684 bool showExtentIn2DView() const { return mShowExtentIn2DView; }
685
690 void setShowExtentIn2DView( bool show );
691
692 signals:
693
700
705
713
724
729 void terrainElevationOffsetChanged( float newElevation );
730
736
742
748
753
759
765
771
774
780
786
792
798
804
810
816
822
828
834
840
846
852
858
859
865
870 void fpsCounterEnabledChanged( bool fpsCounterEnabled );
871
878
884
889 void debugOverlayEnabledChanged( bool debugOverlayEnabled );
890
897
904
905 private:
906#ifdef SIP_RUN
907 Qgs3DMapSettings &operator=( const Qgs3DMapSettings & );
908#endif
909
910 private:
912 void connectChangedSignalsToSettingsChanged();
913
914 private:
916 QgsVector3D mOrigin;
918 QColor mBackgroundColor = Qt::black;
919 QColor mSelectionColor;
920 double mTerrainVerticalScale = 1;
921 std::unique_ptr<QgsTerrainGenerator> mTerrainGenerator;
922 int mMapTileResolution = 512;
923 float mMaxTerrainScreenError = 3.f;
924 float mMaxTerrainGroundError = 1.f;
925 float mTerrainElevationOffset = 0.0f;
926 bool mTerrainShadingEnabled = false;
927 QgsPhongMaterialSettings mTerrainShadingMaterial;
928 QString mTerrainMapTheme;
929 bool mShowTerrainBoundingBoxes = false;
930 bool mShowTerrainTileInfo = false;
931 bool mShowCameraViewCenter = false;
932 bool mShowCameraRotationCenter = false;
933 bool mShowLightSources = false;
934 bool mShowLabels = false;
935 QList< QgsLightSource * > mLightSources;
936 float mFieldOfView = 45.0f; //<! Camera lens field of view value
937 Qt3DRender::QCameraLens::ProjectionType mProjectionType = Qt3DRender::QCameraLens::PerspectiveProjection; //<! Camera lens projection type
939 double mCameraMovementSpeed = 5.0;
940 QList<QgsMapLayerRef> mLayers;
942 QgsCoordinateTransformContext mTransformContext;
943 QgsPathResolver mPathResolver;
944 QgsMapThemeCollection *mMapThemes = nullptr;
945 double mDpi = 96;
946 bool mIsFpsCounterEnabled = false;
947
948 bool mIsSkyboxEnabled = false;
949 QgsSkyboxSettings mSkyboxSettings;
950 QgsShadowSettings mShadowSettings;
951 QgsAmbientOcclusionSettings mAmbientOcclusionSettings;
952
953 bool mEyeDomeLightingEnabled = false;
954 double mEyeDomeLightingStrength = 1000.0;
955 int mEyeDomeLightingDistance = 1;
956
957 Qgis::ViewSyncModeFlags mViewSyncMode;
958 bool mVisualizeViewFrustum = false;
959
960 bool mDebugShadowMapEnabled = false;
961 Qt::Corner mDebugShadowMapCorner = Qt::Corner::TopLeftCorner;
962 double mDebugShadowMapSize = 0.2;
963
964 bool mDebugDepthMapEnabled = false;
965 Qt::Corner mDebugDepthMapCorner = Qt::Corner::TopRightCorner;
966 double mDebugDepthMapSize = 0.2;
967
968 bool mTerrainRenderingEnabled = true;
969
970 Qgis::RendererUsage mRendererUsage;
971
972 Qgs3DAxisSettings m3dAxisSettings;
973
974 bool mIsDebugOverlayEnabled = false;
975
976 QgsRectangle mExtent;
977
978 bool mShowExtentIn2DView = false;
979
980};
981
982
983#endif // QGS3DMAPSETTINGS_H
QFlags< ViewSyncModeFlag > ViewSyncModeFlags
Definition qgis.h:3043
NavigationMode
The navigation mode used by 3D cameras.
Definition qgis.h:3681
@ TerrainBased
The default navigation based on the terrain.
RendererUsage
Usage of the renderer.
Definition qgis.h:3025
Contains the configuration of a 3d axis.
void extentChanged()
Emitted when the 3d view's 2d extent has changed.
void mapTileResolutionChanged()
Emitted when the map tile resoulution has changed.
void terrainVerticalScaleChanged()
Emitted when the vertical scale of the terrain has changed.
Qt::Corner debugDepthMapCorner() const
Returns the corner where the shadow map preview is displayed.
void settingsChanged()
Emitted when one of the configuration settings has changed.
void renderersChanged()
Emitted when the list of map's extra renderers have been modified.
void eyeDomeLightingDistanceChanged()
Emitted when the eye dome lighting distance has changed.
void terrainShadingChanged()
Emitted when terrain shading enabled flag or terrain shading material has changed.
const QgsPathResolver & pathResolver() const
Returns the path resolver for conversion between relative and absolute paths during rendering operati...
bool showExtentIn2DView() const
Returns whether the extent is displayed on the main 2D map canvas.
double cameraMovementSpeed() const
Returns the camera movement speed.
Qt3DRender::QCameraLens::ProjectionType projectionType() const
Returns the camera lens' projection type.
bool debugDepthMapEnabled() const
Returns whether the shadow map debugging is enabled.
bool isSkyboxEnabled() const
Returns whether the skybox is enabled.
void debugDepthMapSettingsChanged()
Emitted when depth map debugging has changed.
double outputDpi() const
Returns DPI used for conversion between real world units (e.g.
Qgis::NavigationMode cameraNavigationMode() const
Returns the navigation mode used by the camera.
double eyeDomeLightingStrength() const
Returns the eye dome lighting strength value.
void backgroundColorChanged()
Emitted when the background color has changed.
void showTerrainBoundingBoxesChanged()
Emitted when the flag whether terrain's bounding boxes are shown has changed.
Qt::Corner debugShadowMapCorner() const
Returns the corner where the shadow map preview is displayed.
void setMapThemeCollection(QgsMapThemeCollection *mapThemes)
Sets pointer to the collection of map themes.
bool showCameraViewCenter() const
Returns whether to show camera's view center as a sphere (for debugging)
void showCameraRotationCenterChanged()
Emitted when the flag whether camera's rotation center is shown has changed.
void directionalLightsChanged()
Emitted when the list of directional lights changes.
void cameraNavigationModeChanged()
Emitted when the camera navigation mode was changed.
void shadowSettingsChanged()
Emitted when shadow rendering settings are changed.
void eyeDomeLightingEnabledChanged()
Emitted when the flag whether eye dome lighting is used has changed.
void debugOverlayEnabledChanged(bool debugOverlayEnabled)
Emitted when the debug overaly is enabled or disabled.
void setOutputDpi(const double dpi)
Sets DPI used for conversion between real world units (e.g.
void setIsSkyboxEnabled(bool enabled)
Sets whether the skybox is enabled.
void setOrigin(const QgsVector3D &origin)
Sets coordinates in map CRS at which our 3D world has origin (0,0,0)
void skyboxSettingsChanged()
Emitted when skybox settings are changed.
QgsShadowSettings shadowSettings() const
Returns the current configuration of shadows.
void terrainMapThemeChanged()
Emitted when terrain's map theme has changed.
void pointLightsChanged()
Emitted when the list of point lights changes.
double debugDepthMapSize() const
Returns the size of the shadow map preview.
Qgs3DAxisSettings get3DAxisSettings() const
Returns the current configuration of 3d axis.
bool viewFrustumVisualizationEnabled() const
Returns whether the camera's view frustum is visualized on the 2D map canvas.
void projectionTypeChanged()
Emitted when the camera lens projection type changes.
float fieldOfView() const
Returns the camera lens' field of view.
void selectionColorChanged()
Emitted when the selection color has changed.
QgsAmbientOcclusionSettings ambientOcclusionSettings() const
Returns the current configuration of screen space ambient occlusion.
QgsRectangle extent() const
Returns the 3D scene's 2D extent in the 3D scene's CRS.
Qgis::ViewSyncModeFlags viewSyncMode() const
Returns the view sync mode (used to synchronize the 2D main map canvas and the 3D camera navigation)
float terrainElevationOffset() const
Returns the elevation offset of the terrain (used to move the terrain up or down)
int eyeDomeLightingDistance() const
Returns the eye dome lighting distance value (contributes to the contrast of the image)
void lightSourcesChanged()
Emitted when any of the light source settings in the map changes.
void showLightSourceOriginsChanged()
Emitted when the flag whether light source origins are shown has changed.
QgsTerrainGenerator * terrainGenerator() const
Returns the terrain generator.
double debugShadowMapSize() const
Returns the size of the shadow map preview.
void setPathResolver(const QgsPathResolver &resolver)
Sets the path resolver for conversion between relative and absolute paths during rendering operations...
bool showTerrainBoundingBoxes() const
Returns whether to display bounding boxes of terrain tiles (for debugging)
void showLabelsChanged()
Emitted when the flag whether labels are displayed on terrain tiles has changed.
Qgs3DMapSettings & operator=(Qgs3DMapSettings const &)=delete
void maxTerrainScreenErrorChanged()
Emitted when the maximum terrain screen error has changed.
bool showLabels() const
Returns whether to display labels on terrain tiles.
void terrainElevationOffsetChanged(float newElevation)
Emitted when the terrain elevation offset is changed.
bool debugShadowMapEnabled() const
Returns whether the shadow map debugging is enabled.
bool terrainRenderingEnabled() const
Returns whether the 2D terrain surface will be rendered.
void fpsCounterEnabledChanged(bool fpsCounterEnabled)
Emitted when the FPS counter is enabled or disabled.
void axisSettingsChanged()
Emitted when 3d axis rendering settings are changed.
void viewFrustumVisualizationEnabledChanged()
Emitted when the camera's view frustum visualization on the main 2D map canvas is enabled or disabled...
void ambientOcclusionSettingsChanged()
Emitted when ambient occlusion rendering settings are changed.
bool showTerrainTilesInfo() const
Returns whether to display extra tile info on top of terrain tiles (for debugging)
void showExtentIn2DViewChanged()
Emitted when the parameter to display 3d view's extent in the 2D canvas has changed.
void layersChanged()
Emitted when the list of map layers for 3d rendering has changed.
void showTerrainTilesInfoChanged()
Emitted when the flag whether terrain's tile info is shown has changed.
void eyeDomeLightingStrengthChanged()
Emitted when the eye dome lighting strength has changed.
QgsSkyboxSettings skyboxSettings() const
Returns the current configuration of the skybox.
bool isTerrainShadingEnabled() const
Returns whether terrain shading is enabled.
void cameraMovementSpeedChanged()
Emitted when the camera movement speed was changed.
QgsCoordinateReferenceSystem crs() const
Returns coordinate reference system used in the 3D scene.
bool eyeDomeLightingEnabled() const
Returns whether eye dome lighting is used.
QgsPhongMaterialSettings terrainShadingMaterial() const
Returns terrain shading material.
bool isFpsCounterEnabled() const
Returns whether FPS counter label is enabled.
QString terrainMapTheme() const
Returns name of the map theme (from the active project) that will be used for terrain's texture.
void fieldOfViewChanged()
Emitted when the camera lens field of view changes.
QgsMapThemeCollection * mapThemeCollection() const
Returns pointer to the collection of map themes.
void terrainGeneratorChanged()
Emitted when the terrain generator has changed.
bool showLightSourceOrigins() const
Returns whether to show light source origins as a sphere (for debugging)
void debugShadowMapSettingsChanged()
Emitted when shadow map debugging has changed.
void showCameraViewCenterChanged()
Emitted when the flag whether camera's view center is shown has changed.
void maxTerrainGroundErrorChanged()
Emitted when the maximum terrain ground error has changed.
QgsVector3D origin() const
Returns coordinates in map CRS at which 3D scene has origin (0,0,0)
bool showCameraRotationCenter() const
Returns whether to show camera's rotation center as a sphere (for debugging)
Base class for all renderers that may to participate in 3D view.
class containing the configuration of ambient occlusion rendering 3
This class represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Base class for all map layer types.
Definition qgsmaplayer.h:75
Container class that allows storage of map themes consisting of visible map layers and layer styles.
Resolves relative paths into absolute paths and vice versa.
Contains elevation properties for a QgsProject.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
Represents a raster layer.
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
class containing the configuration of shadows rendering 3
Contains the configuration of a skybox entity.
Base class for objects with an associated (optional) temporal range.
Class for storage of 3D vectors similar to QVector3D, with the difference that it uses double precisi...
Definition qgsvector3d.h:31
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_TRANSFER
Definition qgis_sip.h:36
const QgsCoordinateReferenceSystem & crs