16 #ifndef QGS3DMAPSETTINGS_H
17 #define QGS3DMAPSETTINGS_H
24 #include <Qt3DRender/QCamera>
74 void resolveReferences(
const QgsProject &project );
153 void setBackgroundColor(
const QColor &color );
155 QColor backgroundColor()
const;
158 void setSelectionColor(
const QColor &color );
160 QColor selectionColor()
const;
170 void setLayers(
const QList<QgsMapLayer *> &layers );
180 QList<QgsMapLayer *> layers()
const;
197 void setTerrainVerticalScale(
double zScale );
199 double terrainVerticalScale()
const;
205 void setMapTileResolution(
int res );
211 int mapTileResolution()
const;
217 void setMaxTerrainScreenError(
float error );
226 float maxTerrainScreenError()
const;
232 void setMaxTerrainGroundError(
float error );
240 float maxTerrainGroundError()
const;
247 void setTerrainElevationOffset(
float offset );
279 return mTerrainGenerator.get();
287 void setTerrainShadingEnabled(
bool enabled );
316 void setTerrainMapTheme(
const QString &theme );
331 void setRenderers(
const QList<QgsAbstract3DRenderer *> &renderers
SIP_TRANSFER );
333 QList<QgsAbstract3DRenderer *>
renderers()
const {
return mRenderers; }
336 void setShowTerrainBoundingBoxes(
bool enabled );
340 void setShowTerrainTilesInfo(
bool enabled );
348 void setShowCameraViewCenter(
bool enabled );
360 void setShowCameraRotationCenter(
bool enabled );
372 void setShowLightSourceOrigins(
bool enabled );
381 void setShowLabels(
bool enabled );
390 void setEyeDomeLightingEnabled(
bool enabled );
399 void setEyeDomeLightingStrength(
double strength );
408 void setEyeDomeLightingDistance(
int distance );
417 void setDebugShadowMapSettings(
bool enabled, Qt::Corner corner,
double size );
430 void setDebugDepthMapSettings(
bool enabled, Qt::Corner corner,
double size );
443 QList<QgsLightSource *> lightSources()
const;
453 void setLightSources(
const QList<QgsLightSource *> &lights
SIP_TRANSFER );
465 void setFieldOfView(
const float fieldOfView );
477 void setProjectionType(
const Qt3DRender::QCameraLens::ProjectionType projectionType )
SIP_SKIP;
504 void setCameraMovementSpeed(
double movementSpeed );
571 void setIsFpsCounterEnabled(
bool fpsCounterEnabled );
585 void setTerrainRenderingEnabled(
bool terrainRenderingEnabled );
615 void setViewSyncMode( Qgis::ViewSyncModeFlags mode );
629 void setViewFrustumVisualizationEnabled(
bool enabled );
658 void setIsDebugOverlayEnabled(
bool debugOverlayEnabled );
859 void connectChangedSignalsToSettingsChanged();
865 QColor mBackgroundColor = Qt::black;
866 QColor mSelectionColor;
867 double mTerrainVerticalScale = 1;
868 std::unique_ptr<QgsTerrainGenerator> mTerrainGenerator;
869 int mMapTileResolution = 512;
870 float mMaxTerrainScreenError = 3.f;
871 float mMaxTerrainGroundError = 1.f;
872 float mTerrainElevationOffset = 0.0f;
873 bool mTerrainShadingEnabled =
false;
875 QString mTerrainMapTheme;
876 bool mShowTerrainBoundingBoxes =
false;
877 bool mShowTerrainTileInfo =
false;
878 bool mShowCameraViewCenter =
false;
879 bool mShowCameraRotationCenter =
false;
880 bool mShowLightSources =
false;
881 bool mShowLabels =
false;
882 QList< QgsLightSource * > mLightSources;
883 float mFieldOfView = 45.0f;
884 Qt3DRender::QCameraLens::ProjectionType mProjectionType = Qt3DRender::QCameraLens::PerspectiveProjection;
886 double mCameraMovementSpeed = 5.0;
887 QList<QgsMapLayerRef> mLayers;
888 QList<QgsAbstract3DRenderer *> mRenderers;
894 bool mIsFpsCounterEnabled =
false;
896 bool mIsSkyboxEnabled =
false;
900 bool mEyeDomeLightingEnabled =
false;
901 double mEyeDomeLightingStrength = 1000.0;
902 int mEyeDomeLightingDistance = 1;
904 Qgis::ViewSyncModeFlags mViewSyncMode;
905 bool mVisualizeViewFrustum =
false;
907 bool mDebugShadowMapEnabled =
false;
908 Qt::Corner mDebugShadowMapCorner = Qt::Corner::TopLeftCorner;
909 double mDebugShadowMapSize = 0.2;
911 bool mDebugDepthMapEnabled =
false;
912 Qt::Corner mDebugDepthMapCorner = Qt::Corner::TopRightCorner;
913 double mDebugDepthMapSize = 0.2;
915 bool mTerrainRenderingEnabled =
true;
921 bool mIsDebugOverlayEnabled =
false;
RendererUsage
Usage of the renderer.
Contains the configuration of a 3d axis.
void mapTileResolutionChanged()
Emitted when the map tile resoulution has changed.
void terrainVerticalScaleChanged()
Emitted when the vertical scale of the terrain has changed.
bool isDebugOverlayEnabled() const
Returns whether debug overlay is enabled.
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.
QList< QgsAbstract3DRenderer * > renderers() const
Returns list of extra 3D renderers.
QgsTerrainGenerator * terrainGenerator() const
Returns the terrain generator.
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.
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.
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.
Qgs3DAxisSettings get3dAxisSettings() const
Returns the current configuration of 3d axis.
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.
Qgs3DMapSettings & operator=(Qgs3DMapSettings const &)=delete
void pointLightsChanged()
Emitted when the list of point lights changes.
double debugDepthMapSize() const
Returns the size of the shadow map preview.
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.
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)
const QgsPathResolver & pathResolver() const
Returns the path resolver for conversion between relative and absolute paths during rendering operati...
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.
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.
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...
bool showTerrainTilesInfo() const
Returns whether to display extra tile info on top of terrain tiles (for debugging)
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.
QgsMapThemeCollection * mapThemeCollection() const
Returns pointer to the collection of map themes.
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.
QgsCameraController::NavigationMode cameraNavigationMode() const
Returns the navigation mode used by the camera.
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.
NavigationMode
The navigation mode used by the camera.
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.
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,...
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.
const QgsCoordinateReferenceSystem & crs