QGIS API Documentation 3.27.0-Master (a46f227e17)
Signals | Public Member Functions | List of all members
Qgs3DMapSettings Class Reference

3 More...

#include <qgs3dmapsettings.h>

Inheritance diagram for Qgs3DMapSettings:
Inheritance graph
[legend]

Signals

void ambientOcclusionSettingsChanged ()
 Emitted when ambient occlusion rendering settings are changed. More...
 
void axisSettingsChanged ()
 Emitted when 3d axis rendering settings are changed. More...
 
void backgroundColorChanged ()
 Emitted when the background color has changed. More...
 
void cameraMovementSpeedChanged ()
 Emitted when the camera movement speed was changed. More...
 
void cameraNavigationModeChanged ()
 Emitted when the camera navigation mode was changed. More...
 
void debugDepthMapSettingsChanged ()
 Emitted when depth map debugging has changed. More...
 
void debugOverlayEnabledChanged (bool debugOverlayEnabled)
 Emitted when the debug overaly is enabled or disabled. More...
 
void debugShadowMapSettingsChanged ()
 Emitted when shadow map debugging has changed. More...
 
void directionalLightsChanged ()
 Emitted when the list of directional lights changes. More...
 
void eyeDomeLightingDistanceChanged ()
 Emitted when the eye dome lighting distance has changed. More...
 
void eyeDomeLightingEnabledChanged ()
 Emitted when the flag whether eye dome lighting is used has changed. More...
 
void eyeDomeLightingStrengthChanged ()
 Emitted when the eye dome lighting strength has changed. More...
 
void fieldOfViewChanged ()
 Emitted when the camera lens field of view changes. More...
 
void fpsCounterEnabledChanged (bool fpsCounterEnabled)
 Emitted when the FPS counter is enabled or disabled. More...
 
void layersChanged ()
 Emitted when the list of map layers for 3d rendering has changed. More...
 
void lightSourcesChanged ()
 Emitted when any of the light source settings in the map changes. More...
 
void mapTileResolutionChanged ()
 Emitted when the map tile resoulution has changed. More...
 
void maxTerrainGroundErrorChanged ()
 Emitted when the maximum terrain ground error has changed. More...
 
void maxTerrainScreenErrorChanged ()
 Emitted when the maximum terrain screen error has changed. More...
 
void pointLightsChanged ()
 Emitted when the list of point lights changes. More...
 
void projectionTypeChanged ()
 Emitted when the camera lens projection type changes. More...
 
void renderersChanged ()
 Emitted when the list of map's extra renderers have been modified. More...
 
void selectionColorChanged ()
 Emitted when the selection color has changed. More...
 
void settingsChanged ()
 Emitted when one of the configuration settings has changed. More...
 
void shadowSettingsChanged ()
 Emitted when shadow rendering settings are changed. More...
 
void showCameraRotationCenterChanged ()
 Emitted when the flag whether camera's rotation center is shown has changed. More...
 
void showCameraViewCenterChanged ()
 Emitted when the flag whether camera's view center is shown has changed. More...
 
void showLabelsChanged ()
 Emitted when the flag whether labels are displayed on terrain tiles has changed. More...
 
void showLightSourceOriginsChanged ()
 Emitted when the flag whether light source origins are shown has changed. More...
 
void showTerrainBoundingBoxesChanged ()
 Emitted when the flag whether terrain's bounding boxes are shown has changed. More...
 
void showTerrainTilesInfoChanged ()
 Emitted when the flag whether terrain's tile info is shown has changed. More...
 
void skyboxSettingsChanged ()
 Emitted when skybox settings are changed. More...
 
void terrainElevationOffsetChanged (float newElevation)
 Emitted when the terrain elevation offset is changed. More...
 
void terrainGeneratorChanged ()
 Emitted when the terrain generator has changed. More...
 
void terrainMapThemeChanged ()
 Emitted when terrain's map theme has changed. More...
 
void terrainShadingChanged ()
 Emitted when terrain shading enabled flag or terrain shading material has changed. More...
 
void terrainVerticalScaleChanged ()
 Emitted when the vertical scale of the terrain has changed. More...
 
void viewFrustumVisualizationEnabledChanged ()
 Emitted when the camera's view frustum visualization on the main 2D map canvas is enabled or disabled. More...
 

Public Member Functions

 Qgs3DMapSettings ()
 Constructor for Qgs3DMapSettings. More...
 
 Qgs3DMapSettings (const Qgs3DMapSettings &other)
 Copy constructor. More...
 
 ~Qgs3DMapSettings () override
 
QgsAmbientOcclusionSettings ambientOcclusionSettings () const
 Returns the current configuration of screen space ambient occlusion. More...
 
QColor backgroundColor () const
 Returns background color of the 3D map view. More...
 
double cameraMovementSpeed () const
 Returns the camera movement speed. More...
 
QgsCameraController::NavigationMode cameraNavigationMode () const
 Returns the navigation mode used by the camera. More...
 
void configureTerrainFromProject (QgsProjectElevationProperties *properties, const QgsRectangle &fullExtent)
 Configures the map's terrain settings directly from a project's elevation properties. More...
 
QgsCoordinateReferenceSystem crs () const
 Returns coordinate reference system used in the 3D scene. More...
 
Qt::Corner debugDepthMapCorner () const
 Returns the corner where the shadow map preview is displayed. More...
 
bool debugDepthMapEnabled () const
 Returns whether the shadow map debugging is enabled. More...
 
double debugDepthMapSize () const
 Returns the size of the shadow map preview. More...
 
Qt::Corner debugShadowMapCorner () const
 Returns the corner where the shadow map preview is displayed. More...
 
bool debugShadowMapEnabled () const
 Returns whether the shadow map debugging is enabled. More...
 
double debugShadowMapSize () const
 Returns the size of the shadow map preview. More...
 
int eyeDomeLightingDistance () const
 Returns the eye dome lighting distance value (contributes to the contrast of the image) More...
 
bool eyeDomeLightingEnabled () const
 Returns whether eye dome lighting is used. More...
 
double eyeDomeLightingStrength () const
 Returns the eye dome lighting strength value. More...
 
float fieldOfView () const
 Returns the camera lens' field of view. More...
 
Qgs3DAxisSettings get3DAxisSettings () const
 Returns the current configuration of 3d axis. More...
 
bool isDebugOverlayEnabled () const
 Returns whether debug overlay is enabled. More...
 
bool isFpsCounterEnabled () const
 Returns whether FPS counter label is enabled. More...
 
bool isSkyboxEnabled () const
 Returns whether the skybox is enabled. More...
 
bool isTerrainShadingEnabled () const
 Returns whether terrain shading is enabled. More...
 
QList< QgsMapLayer * > layers () const
 Returns the list of 3D map layers to be rendered in the scene. More...
 
QList< QgsLightSource * > lightSources () const
 Returns list of directional light sources defined in the scene. More...
 
QgsMapThemeCollectionmapThemeCollection () const
 Returns pointer to the collection of map themes. More...
 
int mapTileResolution () const
 Returns resolution (in pixels) of the texture of a terrain tile. More...
 
QgsVector3D mapToWorldCoordinates (const QgsVector3D &mapCoords) const
 Converts map coordinates to 3D world coordinates (applies offset and turns (x,y,z) into (x,-z,y)) More...
 
float maxTerrainGroundError () const
 Returns maximum ground error of terrain tiles in world units. More...
 
float maxTerrainScreenError () const
 Returns maximum allowed screen error of terrain tiles in pixels. More...
 
Qgs3DMapSettingsoperator= (Qgs3DMapSettings const &)=delete
 
QgsVector3D origin () const
 Returns coordinates in map CRS at which 3D scene has origin (0,0,0) More...
 
double outputDpi () const
 Returns DPI used for conversion between real world units (e.g. More...
 
const QgsPathResolverpathResolver () const
 Returns the path resolver for conversion between relative and absolute paths during rendering operations, e.g. More...
 
Qt3DRender::QCameraLens::ProjectionType projectionType () const
 Returns the camera lens' projection type. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context)
 Reads configuration from a DOM element previously written by writeXml() More...
 
QList< QgsAbstract3DRenderer * > renderers () const
 Returns list of extra 3D renderers. More...
 
Qgis::RendererUsage rendererUsage () const
 Returns the renderer usage. More...
 
void resolveReferences (const QgsProject &project)
 Resolves references to other objects (map layers) after the call to readXml() More...
 
QColor selectionColor () const
 Returns color used for selected features. More...
 
void set3DAxisSettings (const Qgs3DAxisSettings &axisSettings, bool force=false)
 Sets the current configuration of 3d axis. More...
 
void setAmbientOcclusionSettings (const QgsAmbientOcclusionSettings &ambientOcclusionSettings)
 Sets the current configuration of screen space ambient occlusion. More...
 
void setBackgroundColor (const QColor &color)
 Sets background color of the 3D map view. More...
 
void setCameraMovementSpeed (double movementSpeed)
 Sets the camera movement speed. More...
 
void setCameraNavigationMode (QgsCameraController::NavigationMode navigationMode)
 Sets the navigation mode for the camera. More...
 
void setCrs (const QgsCoordinateReferenceSystem &crs)
 Sets coordinate reference system used in the 3D scene. More...
 
void setDebugDepthMapSettings (bool enabled, Qt::Corner corner, double size)
 Sets the debugging settings of the depth map. More...
 
void setDebugShadowMapSettings (bool enabled, Qt::Corner corner, double size)
 Sets the debugging settings of the shadow map. More...
 
void setEyeDomeLightingDistance (int distance)
 Sets the eye dome lighting distance value (contributes to the contrast of the image. More...
 
void setEyeDomeLightingEnabled (bool enabled)
 Sets whether eye dome lighting will be used. More...
 
void setEyeDomeLightingStrength (double strength)
 Sets the eye dome lighting strength value. More...
 
void setFieldOfView (const float fieldOfView)
 Sets the camera lens' field of view. More...
 
void setIsDebugOverlayEnabled (bool debugOverlayEnabled)
 Sets whether debug overlay is enabled The debug overlay displays some debugging and profiling information. More...
 
void setIsFpsCounterEnabled (bool fpsCounterEnabled)
 Sets whether FPS counter label is enabled. More...
 
void setIsSkyboxEnabled (bool enabled)
 Sets whether the skybox is enabled. More...
 
void setLayers (const QList< QgsMapLayer * > &layers)
 Sets the list of 3D map layers to be rendered in the scene. More...
 
void setLightSources (const QList< QgsLightSource * > &lights)
 Sets the list of light sources defined in the scene. More...
 
void setMapThemeCollection (QgsMapThemeCollection *mapThemes)
 Sets pointer to the collection of map themes. More...
 
void setMapTileResolution (int res)
 Sets resolution (in pixels) of the texture of a terrain tile. More...
 
void setMaxTerrainGroundError (float error)
 Returns maximum ground error of terrain tiles in world units. More...
 
void setMaxTerrainScreenError (float error)
 Sets maximum allowed screen error of terrain tiles in pixels. More...
 
void setOrigin (const QgsVector3D &origin)
 Sets coordinates in map CRS at which our 3D world has origin (0,0,0) More...
 
void setOutputDpi (const double dpi)
 Sets DPI used for conversion between real world units (e.g. More...
 
void setPathResolver (const QgsPathResolver &resolver)
 Sets the path resolver for conversion between relative and absolute paths during rendering operations, e.g. More...
 
void setProjectionType (const Qt3DRender::QCameraLens::ProjectionType projectionType)
 Sets the camera lens' projection type. More...
 
void setRenderers (const QList< QgsAbstract3DRenderer * > &renderers)
 Sets list of extra 3D renderers to use in the scene. Takes ownership of the objects. More...
 
void setRendererUsage (Qgis::RendererUsage rendererUsage)
 Sets the renderer usage. More...
 
void setSelectionColor (const QColor &color)
 Sets color used for selected features. More...
 
void setShadowSettings (const QgsShadowSettings &shadowSettings)
 Sets the current configuration of shadow rendering. More...
 
void setShowCameraRotationCenter (bool enabled)
 Sets whether to show camera's rotation center as a sphere (for debugging) More...
 
void setShowCameraViewCenter (bool enabled)
 Sets whether to show camera's view center as a sphere (for debugging) More...
 
void setShowLabels (bool enabled)
 Sets whether to display labels on terrain tiles. More...
 
void setShowLightSourceOrigins (bool enabled)
 Sets whether to show light source origins as a sphere (for debugging) More...
 
void setShowTerrainBoundingBoxes (bool enabled)
 Sets whether to display bounding boxes of terrain tiles (for debugging) More...
 
void setShowTerrainTilesInfo (bool enabled)
 Sets whether to display extra tile info on top of terrain tiles (for debugging) More...
 
void setSkyboxSettings (const QgsSkyboxSettings &skyboxSettings)
 Sets the current configuration of the skybox. More...
 
void setTerrainElevationOffset (float offset)
 Sets the terrain elevation offset (used to move the terrain up or down) More...
 
void setTerrainGenerator (QgsTerrainGenerator *gen)
 Sets terrain generator. More...
 
void setTerrainMapTheme (const QString &theme)
 Sets name of the map theme. More...
 
void setTerrainRenderingEnabled (bool terrainRenderingEnabled)
 Sets whether the 2D terrain surface will be rendered in. More...
 
void setTerrainShadingEnabled (bool enabled)
 Sets whether terrain shading is enabled. More...
 
void setTerrainShadingMaterial (const QgsPhongMaterialSettings &material)
 Sets terrain shading material. More...
 
void setTerrainVerticalScale (double zScale)
 Sets vertical scale (exaggeration) of terrain (1 = true scale, > 1 = hills get more pronounced) More...
 
void setTransformContext (const QgsCoordinateTransformContext &context)
 Sets the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system. More...
 
void setViewFrustumVisualizationEnabled (bool enabled)
 Sets whether the camera's view frustum is visualized on the 2D map canvas. More...
 
void setViewSyncMode (Qgis::ViewSyncModeFlags mode)
 Sets the view sync mode (used to synchronize the 2D main map canvas and the 3D camera navigation) More...
 
QgsShadowSettings shadowSettings () const
 Returns the current configuration of shadows. More...
 
bool showCameraRotationCenter () const
 Returns whether to show camera's rotation center as a sphere (for debugging) More...
 
bool showCameraViewCenter () const
 Returns whether to show camera's view center as a sphere (for debugging) More...
 
bool showLabels () const
 Returns whether to display labels on terrain tiles. More...
 
bool showLightSourceOrigins () const
 Returns whether to show light source origins as a sphere (for debugging) More...
 
bool showTerrainBoundingBoxes () const
 Returns whether to display bounding boxes of terrain tiles (for debugging) More...
 
bool showTerrainTilesInfo () const
 Returns whether to display extra tile info on top of terrain tiles (for debugging) More...
 
QgsSkyboxSettings skyboxSettings () const
 Returns the current configuration of the skybox. More...
 
float terrainElevationOffset () const
 Returns the elevation offset of the terrain (used to move the terrain up or down) More...
 
QgsTerrainGeneratorterrainGenerator () const
 Returns the terrain generator. More...
 
QString terrainMapTheme () const
 Returns name of the map theme (from the active project) that will be used for terrain's texture. More...
 
bool terrainRenderingEnabled () const
 Returns whether the 2D terrain surface will be rendered. More...
 
QgsPhongMaterialSettings terrainShadingMaterial () const
 Returns terrain shading material. More...
 
double terrainVerticalScale () const
 Returns vertical scale (exaggeration) of terrain. More...
 
QgsCoordinateTransformContext transformContext () const
 Returns the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system. More...
 
bool viewFrustumVisualizationEnabled () const
 Returns whether the camera's view frustum is visualized on the 2D map canvas. More...
 
Qgis::ViewSyncModeFlags viewSyncMode () const
 Returns the view sync mode (used to synchronize the 2D main map canvas and the 3D camera navigation) More...
 
QgsVector3D worldToMapCoordinates (const QgsVector3D &worldCoords) const
 Converts 3D world coordinates to map coordinates (applies offset and turns (x,y,z) into (x,-z,y)) More...
 
QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const
 Writes configuration to a DOM element, to be used later with readXml() More...
 
- Public Member Functions inherited from QgsTemporalRangeObject
 QgsTemporalRangeObject (bool enabled=false)
 Constructor QgsTemporalRangeObject. More...
 
virtual ~QgsTemporalRangeObject ()=default
 
bool isTemporal () const
 Returns true if the object's temporal range is enabled, and the object will be filtered when rendering maps with a specific time range set. More...
 
void setIsTemporal (bool enabled)
 Sets whether the temporal range is enabled (i.e. More...
 
void setTemporalRange (const QgsDateTimeRange &range)
 Sets the temporal range for the object. More...
 
const QgsDateTimeRange & temporalRange () const
 Returns the datetime range for the object. More...
 

Detailed Description

3

Definition of the world.

Since
QGIS 3.0

Definition at line 58 of file qgs3dmapsettings.h.

Constructor & Destructor Documentation

◆ Qgs3DMapSettings() [1/2]

Qgs3DMapSettings::Qgs3DMapSettings ( )

Constructor for Qgs3DMapSettings.

Definition at line 35 of file qgs3dmapsettings.cpp.

◆ Qgs3DMapSettings() [2/2]

Qgs3DMapSettings::Qgs3DMapSettings ( const Qgs3DMapSettings other)

Copy constructor.

Definition at line 45 of file qgs3dmapsettings.cpp.

◆ ~Qgs3DMapSettings()

Qgs3DMapSettings::~Qgs3DMapSettings ( )
override

Definition at line 116 of file qgs3dmapsettings.cpp.

Member Function Documentation

◆ ambientOcclusionSettings()

QgsAmbientOcclusionSettings Qgs3DMapSettings::ambientOcclusionSettings ( ) const
inline

Returns the current configuration of screen space ambient occlusion.

Since
QGIS 3.28

Definition at line 538 of file qgs3dmapsettings.h.

◆ ambientOcclusionSettingsChanged

void Qgs3DMapSettings::ambientOcclusionSettingsChanged ( )
signal

Emitted when ambient occlusion rendering settings are changed.

Since
QGIS 3.28

◆ axisSettingsChanged

void Qgs3DMapSettings::axisSettingsChanged ( )
signal

Emitted when 3d axis rendering settings are changed.

Since
QGIS 3.26

◆ backgroundColor()

QColor Qgs3DMapSettings::backgroundColor ( ) const

Returns background color of the 3D map view.

Definition at line 521 of file qgs3dmapsettings.cpp.

◆ backgroundColorChanged

void Qgs3DMapSettings::backgroundColorChanged ( )
signal

Emitted when the background color has changed.

◆ cameraMovementSpeed()

double Qgs3DMapSettings::cameraMovementSpeed ( ) const
inline

Returns the camera movement speed.

Since
QGIS 3.18

Definition at line 499 of file qgs3dmapsettings.h.

◆ cameraMovementSpeedChanged

void Qgs3DMapSettings::cameraMovementSpeedChanged ( )
signal

Emitted when the camera movement speed was changed.

Since
QGIS 3.18

◆ cameraNavigationMode()

QgsCameraController::NavigationMode Qgs3DMapSettings::cameraNavigationMode ( ) const
inline

Returns the navigation mode used by the camera.

Since
QGIS 3.18

Definition at line 486 of file qgs3dmapsettings.h.

◆ cameraNavigationModeChanged

void Qgs3DMapSettings::cameraNavigationModeChanged ( )
signal

Emitted when the camera navigation mode was changed.

Since
QGIS 3.18

◆ configureTerrainFromProject()

void Qgs3DMapSettings::configureTerrainFromProject ( QgsProjectElevationProperties properties,
const QgsRectangle fullExtent 
)

Configures the map's terrain settings directly from a project's elevation properties.

Since
QGIS 3.26

Definition at line 582 of file qgs3dmapsettings.cpp.

◆ crs()

QgsCoordinateReferenceSystem Qgs3DMapSettings::crs ( ) const
inline

Returns coordinate reference system used in the 3D scene.

Definition at line 100 of file qgs3dmapsettings.h.

◆ debugDepthMapCorner()

Qt::Corner Qgs3DMapSettings::debugDepthMapCorner ( ) const
inline

Returns the corner where the shadow map preview is displayed.

Definition at line 435 of file qgs3dmapsettings.h.

◆ debugDepthMapEnabled()

bool Qgs3DMapSettings::debugDepthMapEnabled ( ) const
inline

Returns whether the shadow map debugging is enabled.

Definition at line 433 of file qgs3dmapsettings.h.

◆ debugDepthMapSettingsChanged

void Qgs3DMapSettings::debugDepthMapSettingsChanged ( )
signal

Emitted when depth map debugging has changed.

Since
QGIS 3.18

◆ debugDepthMapSize()

double Qgs3DMapSettings::debugDepthMapSize ( ) const
inline

Returns the size of the shadow map preview.

Definition at line 437 of file qgs3dmapsettings.h.

◆ debugOverlayEnabledChanged

void Qgs3DMapSettings::debugOverlayEnabledChanged ( bool  debugOverlayEnabled)
signal

Emitted when the debug overaly is enabled or disabled.

Since
QGIS 3.26

◆ debugShadowMapCorner()

Qt::Corner Qgs3DMapSettings::debugShadowMapCorner ( ) const
inline

Returns the corner where the shadow map preview is displayed.

Definition at line 422 of file qgs3dmapsettings.h.

◆ debugShadowMapEnabled()

bool Qgs3DMapSettings::debugShadowMapEnabled ( ) const
inline

Returns whether the shadow map debugging is enabled.

Definition at line 420 of file qgs3dmapsettings.h.

◆ debugShadowMapSettingsChanged

void Qgs3DMapSettings::debugShadowMapSettingsChanged ( )
signal

Emitted when shadow map debugging has changed.

Since
QGIS 3.18

◆ debugShadowMapSize()

double Qgs3DMapSettings::debugShadowMapSize ( ) const
inline

Returns the size of the shadow map preview.

Definition at line 424 of file qgs3dmapsettings.h.

◆ directionalLightsChanged

void Qgs3DMapSettings::directionalLightsChanged ( )
signal

Emitted when the list of directional lights changes.

Since
QGIS 3.16

◆ eyeDomeLightingDistance()

int Qgs3DMapSettings::eyeDomeLightingDistance ( ) const
inline

Returns the eye dome lighting distance value (contributes to the contrast of the image)

Definition at line 411 of file qgs3dmapsettings.h.

◆ eyeDomeLightingDistanceChanged

void Qgs3DMapSettings::eyeDomeLightingDistanceChanged ( )
signal

Emitted when the eye dome lighting distance has changed.

Since
QGIS 3.18

◆ eyeDomeLightingEnabled()

bool Qgs3DMapSettings::eyeDomeLightingEnabled ( ) const
inline

Returns whether eye dome lighting is used.

Definition at line 393 of file qgs3dmapsettings.h.

◆ eyeDomeLightingEnabledChanged

void Qgs3DMapSettings::eyeDomeLightingEnabledChanged ( )
signal

Emitted when the flag whether eye dome lighting is used has changed.

Since
QGIS 3.18

◆ eyeDomeLightingStrength()

double Qgs3DMapSettings::eyeDomeLightingStrength ( ) const
inline

Returns the eye dome lighting strength value.

Definition at line 402 of file qgs3dmapsettings.h.

◆ eyeDomeLightingStrengthChanged

void Qgs3DMapSettings::eyeDomeLightingStrengthChanged ( )
signal

Emitted when the eye dome lighting strength has changed.

Since
QGIS 3.18

◆ fieldOfView()

float Qgs3DMapSettings::fieldOfView ( ) const
inline

Returns the camera lens' field of view.

Since
QGIS 3.8

Definition at line 460 of file qgs3dmapsettings.h.

◆ fieldOfViewChanged

void Qgs3DMapSettings::fieldOfViewChanged ( )
signal

Emitted when the camera lens field of view changes.

Since
QGIS 3.8

◆ fpsCounterEnabledChanged

void Qgs3DMapSettings::fpsCounterEnabledChanged ( bool  fpsCounterEnabled)
signal

Emitted when the FPS counter is enabled or disabled.

Since
QGIS 3.18

◆ get3DAxisSettings()

Qgs3DAxisSettings Qgs3DMapSettings::get3DAxisSettings ( ) const
inline

Returns the current configuration of 3d axis.

Returns
QGIS 3.26

Definition at line 648 of file qgs3dmapsettings.h.

◆ isDebugOverlayEnabled()

bool Qgs3DMapSettings::isDebugOverlayEnabled ( ) const
inline

Returns whether debug overlay is enabled.

See also
setIsDebugOverlayEnabled()
Since
QGIS 3.26

Definition at line 661 of file qgs3dmapsettings.h.

◆ isFpsCounterEnabled()

bool Qgs3DMapSettings::isFpsCounterEnabled ( ) const
inline

Returns whether FPS counter label is enabled.

See also
setIsFpsCounterEnabled()
Since
QGIS 3.18

Definition at line 577 of file qgs3dmapsettings.h.

◆ isSkyboxEnabled()

bool Qgs3DMapSettings::isSkyboxEnabled ( ) const
inline

Returns whether the skybox is enabled.

See also
setIsSkyboxEnabled()
Since
QGIS 3.16

Definition at line 563 of file qgs3dmapsettings.h.

◆ isTerrainShadingEnabled()

bool Qgs3DMapSettings::isTerrainShadingEnabled ( ) const
inline

Returns whether terrain shading is enabled.

When enabled, in addition to the terrain texture generated from the map, the terrain rendering will take into account position of the lights, terrain normals and terrain shading material (ambient and specular colors, shininess).

Since
QGIS 3.6

Definition at line 296 of file qgs3dmapsettings.h.

◆ layers()

QList< QgsMapLayer * > Qgs3DMapSettings::layers ( ) const

Returns the list of 3D map layers to be rendered in the scene.

This setting dictates which layers are to be rendered using their 3D rendering configuration, if available.

See also
setLayers()
layersChanged()

Definition at line 570 of file qgs3dmapsettings.cpp.

◆ layersChanged

void Qgs3DMapSettings::layersChanged ( )
signal

Emitted when the list of map layers for 3d rendering has changed.

See also
setLayers()
layers()

◆ lightSources()

QList< QgsLightSource * > Qgs3DMapSettings::lightSources ( ) const

Returns list of directional light sources defined in the scene.

See also
setLightSources()
Since
QGIS 3.26

Definition at line 809 of file qgs3dmapsettings.cpp.

◆ lightSourcesChanged

void Qgs3DMapSettings::lightSourcesChanged ( )
signal

Emitted when any of the light source settings in the map changes.

Since
QGIS 3.26

◆ mapThemeCollection()

QgsMapThemeCollection * Qgs3DMapSettings::mapThemeCollection ( ) const
inline

Returns pointer to the collection of map themes.

Normally this would be QgsProject::mapThemeCollection() of the currently used project. Without a valid map theme collection object it is not possible to resolve map themes from their names.

Since
QGIS 3.6

Definition at line 144 of file qgs3dmapsettings.h.

◆ mapTileResolution()

int Qgs3DMapSettings::mapTileResolution ( ) const

Returns resolution (in pixels) of the texture of a terrain tile.

This parameter influences how many zoom levels for terrain tiles there will be (together with maxTerrainGroundError())

Definition at line 638 of file qgs3dmapsettings.cpp.

◆ mapTileResolutionChanged

void Qgs3DMapSettings::mapTileResolutionChanged ( )
signal

Emitted when the map tile resoulution has changed.

◆ mapToWorldCoordinates()

QgsVector3D Qgs3DMapSettings::mapToWorldCoordinates ( const QgsVector3D mapCoords) const

Converts map coordinates to 3D world coordinates (applies offset and turns (x,y,z) into (x,-z,y))

Definition at line 487 of file qgs3dmapsettings.cpp.

◆ maxTerrainGroundError()

float Qgs3DMapSettings::maxTerrainGroundError ( ) const

Returns maximum ground error of terrain tiles in world units.

This parameter influences how many zoom levels there will be (together with mapTileResolution()). This value tells that when the given ground error is reached (e.g. 10 meters), it makes no sense to further split terrain tiles into finer ones because they will not add extra details anymore.

Definition at line 674 of file qgs3dmapsettings.cpp.

◆ maxTerrainGroundErrorChanged

void Qgs3DMapSettings::maxTerrainGroundErrorChanged ( )
signal

Emitted when the maximum terrain ground error has changed.

◆ maxTerrainScreenError()

float Qgs3DMapSettings::maxTerrainScreenError ( ) const

Returns maximum allowed screen error of terrain tiles in pixels.

This parameter decides how aggressively less detailed terrain tiles are swapped to more detailed ones as camera gets closer. Each tile has its error defined in world units - this error gets projected to screen pixels according to camera view and if the tile's error is greater than the allowed error, it will be swapped by more detailed tiles with lower error.

Definition at line 652 of file qgs3dmapsettings.cpp.

◆ maxTerrainScreenErrorChanged

void Qgs3DMapSettings::maxTerrainScreenErrorChanged ( )
signal

Emitted when the maximum terrain screen error has changed.

◆ operator=()

Qgs3DMapSettings & Qgs3DMapSettings::operator= ( Qgs3DMapSettings const &  )
delete

◆ origin()

QgsVector3D Qgs3DMapSettings::origin ( ) const
inline

Returns coordinates in map CRS at which 3D scene has origin (0,0,0)

Definition at line 90 of file qgs3dmapsettings.h.

◆ outputDpi()

double Qgs3DMapSettings::outputDpi ( ) const
inline

Returns DPI used for conversion between real world units (e.g.

mm) and pixels Default value is 96

Since
QGIS 3.10

Definition at line 520 of file qgs3dmapsettings.h.

◆ pathResolver()

const QgsPathResolver & Qgs3DMapSettings::pathResolver ( ) const
inline

Returns the path resolver for conversion between relative and absolute paths during rendering operations, e.g.

for resolving relative symbol paths.

See also
setPathResolver()
Since
QGIS 3.0

Definition at line 127 of file qgs3dmapsettings.h.

◆ pointLightsChanged

void Qgs3DMapSettings::pointLightsChanged ( )
signal

Emitted when the list of point lights changes.

Since
QGIS 3.6

◆ projectionType()

Qt3DRender::QCameraLens::ProjectionType Qgs3DMapSettings::projectionType ( ) const
inline

Returns the camera lens' projection type.

Since
QGIS 3.18

Definition at line 472 of file qgs3dmapsettings.h.

◆ projectionTypeChanged

void Qgs3DMapSettings::projectionTypeChanged ( )
signal

Emitted when the camera lens projection type changes.

Since
QGIS 3.18

◆ readXml()

void Qgs3DMapSettings::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)

Reads configuration from a DOM element previously written by writeXml()

Definition at line 122 of file qgs3dmapsettings.cpp.

◆ renderers()

QList< QgsAbstract3DRenderer * > Qgs3DMapSettings::renderers ( ) const
inline

Returns list of extra 3D renderers.

Definition at line 334 of file qgs3dmapsettings.h.

◆ renderersChanged

void Qgs3DMapSettings::renderersChanged ( )
signal

Emitted when the list of map's extra renderers have been modified.

Since
QGIS 3.10

◆ rendererUsage()

Qgis::RendererUsage Qgs3DMapSettings::rendererUsage ( ) const

Returns the renderer usage.

See also
rendererUsage()
Since
QGIS 3.24

Definition at line 910 of file qgs3dmapsettings.cpp.

◆ resolveReferences()

void Qgs3DMapSettings::resolveReferences ( const QgsProject project)

Resolves references to other objects (map layers) after the call to readXml()

Definition at line 470 of file qgs3dmapsettings.cpp.

◆ selectionColor()

QColor Qgs3DMapSettings::selectionColor ( ) const

Returns color used for selected features.

Definition at line 535 of file qgs3dmapsettings.cpp.

◆ selectionColorChanged

void Qgs3DMapSettings::selectionColorChanged ( )
signal

Emitted when the selection color has changed.

◆ set3DAxisSettings()

void Qgs3DMapSettings::set3DAxisSettings ( const Qgs3DAxisSettings axisSettings,
bool  force = false 
)

Sets the current configuration of 3d axis.

Since
QGIS 3.26

Definition at line 980 of file qgs3dmapsettings.cpp.

◆ setAmbientOcclusionSettings()

void Qgs3DMapSettings::setAmbientOcclusionSettings ( const QgsAmbientOcclusionSettings ambientOcclusionSettings)

Sets the current configuration of screen space ambient occlusion.

Since
QGIS 3.28

Definition at line 872 of file qgs3dmapsettings.cpp.

◆ setBackgroundColor()

void Qgs3DMapSettings::setBackgroundColor ( const QColor &  color)

Sets background color of the 3D map view.

Definition at line 512 of file qgs3dmapsettings.cpp.

◆ setCameraMovementSpeed()

void Qgs3DMapSettings::setCameraMovementSpeed ( double  movementSpeed)

Sets the camera movement speed.

Since
QGIS 3.18

Definition at line 851 of file qgs3dmapsettings.cpp.

◆ setCameraNavigationMode()

void Qgs3DMapSettings::setCameraNavigationMode ( QgsCameraController::NavigationMode  navigationMode)

Sets the navigation mode for the camera.

Since
QGIS 3.18

Definition at line 842 of file qgs3dmapsettings.cpp.

◆ setCrs()

void Qgs3DMapSettings::setCrs ( const QgsCoordinateReferenceSystem crs)

Sets coordinate reference system used in the 3D scene.

Definition at line 497 of file qgs3dmapsettings.cpp.

◆ setDebugDepthMapSettings()

void Qgs3DMapSettings::setDebugDepthMapSettings ( bool  enabled,
Qt::Corner  corner,
double  size 
)

Sets the debugging settings of the depth map.

See also
debugDepthMapEnabled() debugDepthMapCorner() debugDepthMapSize()
Since
QGIS 3.18

Definition at line 886 of file qgs3dmapsettings.cpp.

◆ setDebugShadowMapSettings()

void Qgs3DMapSettings::setDebugShadowMapSettings ( bool  enabled,
Qt::Corner  corner,
double  size 
)

Sets the debugging settings of the shadow map.

See also
debugShadowMapEnabled() debugShadowMapCorner() debugShadowMapSize()
Since
QGIS 3.18

Definition at line 878 of file qgs3dmapsettings.cpp.

◆ setEyeDomeLightingDistance()

void Qgs3DMapSettings::setEyeDomeLightingDistance ( int  distance)

Sets the eye dome lighting distance value (contributes to the contrast of the image.

See also
eyeDomeLightingDistance()
Since
QGIS 3.18

Definition at line 801 of file qgs3dmapsettings.cpp.

◆ setEyeDomeLightingEnabled()

void Qgs3DMapSettings::setEyeDomeLightingEnabled ( bool  enabled)

Sets whether eye dome lighting will be used.

See also
eyeDomeLightingEnabled()
Since
QGIS 3.18

Definition at line 785 of file qgs3dmapsettings.cpp.

◆ setEyeDomeLightingStrength()

void Qgs3DMapSettings::setEyeDomeLightingStrength ( double  strength)

Sets the eye dome lighting strength value.

See also
eyeDomeLightingStrength()
Since
QGIS 3.18

Definition at line 793 of file qgs3dmapsettings.cpp.

◆ setFieldOfView()

void Qgs3DMapSettings::setFieldOfView ( const float  fieldOfView)

Sets the camera lens' field of view.

Since
QGIS 3.8

Definition at line 824 of file qgs3dmapsettings.cpp.

◆ setIsDebugOverlayEnabled()

void Qgs3DMapSettings::setIsDebugOverlayEnabled ( bool  debugOverlayEnabled)

Sets whether debug overlay is enabled The debug overlay displays some debugging and profiling information.

It has been introduced in Qt version 5.15. This parameter is transient. It is not saved in the project parameters.

See also
isDebugOverlayEnabled()
Since
QGIS 3.26

Definition at line 934 of file qgs3dmapsettings.cpp.

◆ setIsFpsCounterEnabled()

void Qgs3DMapSettings::setIsFpsCounterEnabled ( bool  fpsCounterEnabled)

Sets whether FPS counter label is enabled.

See also
isFpsCounterEnabled()
Since
QGIS 3.18

Definition at line 894 of file qgs3dmapsettings.cpp.

◆ setIsSkyboxEnabled()

void Qgs3DMapSettings::setIsSkyboxEnabled ( bool  enabled)
inline

Sets whether the skybox is enabled.

See also
isSkyboxEnabled()
Since
QGIS 3.16

Definition at line 570 of file qgs3dmapsettings.h.

◆ setLayers()

void Qgs3DMapSettings::setLayers ( const QList< QgsMapLayer * > &  layers)

Sets the list of 3D map layers to be rendered in the scene.

This setting dictates which layers are to be rendered using their 3D rendering configuration, if available.

See also
layers()
layersChanged()

Definition at line 554 of file qgs3dmapsettings.cpp.

◆ setLightSources()

void Qgs3DMapSettings::setLightSources ( const QList< QgsLightSource * > &  lights)

Sets the list of light sources defined in the scene.

Ownership of the lights is transferred to the settings.

See also
lightSources()
Since
QGIS 3.26

Definition at line 814 of file qgs3dmapsettings.cpp.

◆ setMapThemeCollection()

void Qgs3DMapSettings::setMapThemeCollection ( QgsMapThemeCollection mapThemes)
inline

Sets pointer to the collection of map themes.

See also
mapThemeCollection()
Since
QGIS 3.6

Definition at line 151 of file qgs3dmapsettings.h.

◆ setMapTileResolution()

void Qgs3DMapSettings::setMapTileResolution ( int  res)

Sets resolution (in pixels) of the texture of a terrain tile.

See also
mapTileResolution()

Definition at line 629 of file qgs3dmapsettings.cpp.

◆ setMaxTerrainGroundError()

void Qgs3DMapSettings::setMaxTerrainGroundError ( float  error)

Returns maximum ground error of terrain tiles in world units.

See also
maxTerrainGroundError()

Definition at line 657 of file qgs3dmapsettings.cpp.

◆ setMaxTerrainScreenError()

void Qgs3DMapSettings::setMaxTerrainScreenError ( float  error)

Sets maximum allowed screen error of terrain tiles in pixels.

See also
maxTerrainScreenError()

Definition at line 643 of file qgs3dmapsettings.cpp.

◆ setOrigin()

void Qgs3DMapSettings::setOrigin ( const QgsVector3D origin)
inline

Sets coordinates in map CRS at which our 3D world has origin (0,0,0)

We move the 3D world origin to the center of the extent of our terrain: this is done to minimize the impact of numerical errors when operating with 32-bit floats. Unfortunately this is not enough when working with a large area (still results in jitter with scenes spanning hundreds of kilometers and zooming in a lot).

Need to look into more advanced techniques like "relative to center" or "relative to eye" to improve the precision.

Definition at line 88 of file qgs3dmapsettings.h.

◆ setOutputDpi()

void Qgs3DMapSettings::setOutputDpi ( const double  dpi)
inline

Sets DPI used for conversion between real world units (e.g.

mm) and pixels

Parameters
dpithe number of dot per inch
Since
QGIS 3.10

Definition at line 512 of file qgs3dmapsettings.h.

◆ setPathResolver()

void Qgs3DMapSettings::setPathResolver ( const QgsPathResolver resolver)
inline

Sets the path resolver for conversion between relative and absolute paths during rendering operations, e.g.

for resolving relative symbol paths.

See also
pathResolver()
Since
QGIS 3.0

Definition at line 136 of file qgs3dmapsettings.h.

◆ setProjectionType()

void Qgs3DMapSettings::setProjectionType ( const Qt3DRender::QCameraLens::ProjectionType  projectionType)

Sets the camera lens' projection type.

Since
QGIS 3.18

Definition at line 833 of file qgs3dmapsettings.cpp.

◆ setRenderers()

void Qgs3DMapSettings::setRenderers ( const QList< QgsAbstract3DRenderer * > &  renderers)

Sets list of extra 3D renderers to use in the scene. Takes ownership of the objects.

Definition at line 721 of file qgs3dmapsettings.cpp.

◆ setRendererUsage()

void Qgs3DMapSettings::setRendererUsage ( Qgis::RendererUsage  rendererUsage)

Sets the renderer usage.

See also
rendererUsage()
Since
QGIS 3.24

Definition at line 915 of file qgs3dmapsettings.cpp.

◆ setSelectionColor()

void Qgs3DMapSettings::setSelectionColor ( const QColor &  color)

Sets color used for selected features.

Definition at line 526 of file qgs3dmapsettings.cpp.

◆ setShadowSettings()

void Qgs3DMapSettings::setShadowSettings ( const QgsShadowSettings shadowSettings)

Sets the current configuration of shadow rendering.

Since
QGIS 3.16

Definition at line 866 of file qgs3dmapsettings.cpp.

◆ setShowCameraRotationCenter()

void Qgs3DMapSettings::setShowCameraRotationCenter ( bool  enabled)

Sets whether to show camera's rotation center as a sphere (for debugging)

Since
QGIS 3.24

Definition at line 757 of file qgs3dmapsettings.cpp.

◆ setShowCameraViewCenter()

void Qgs3DMapSettings::setShowCameraViewCenter ( bool  enabled)

Sets whether to show camera's view center as a sphere (for debugging)

Since
QGIS 3.4

Definition at line 748 of file qgs3dmapsettings.cpp.

◆ setShowLabels()

void Qgs3DMapSettings::setShowLabels ( bool  enabled)

Sets whether to display labels on terrain tiles.

Definition at line 776 of file qgs3dmapsettings.cpp.

◆ setShowLightSourceOrigins()

void Qgs3DMapSettings::setShowLightSourceOrigins ( bool  enabled)

Sets whether to show light source origins as a sphere (for debugging)

Since
QGIS 3.16

Definition at line 767 of file qgs3dmapsettings.cpp.

◆ setShowTerrainBoundingBoxes()

void Qgs3DMapSettings::setShowTerrainBoundingBoxes ( bool  enabled)

Sets whether to display bounding boxes of terrain tiles (for debugging)

Definition at line 730 of file qgs3dmapsettings.cpp.

◆ setShowTerrainTilesInfo()

void Qgs3DMapSettings::setShowTerrainTilesInfo ( bool  enabled)

Sets whether to display extra tile info on top of terrain tiles (for debugging)

Definition at line 739 of file qgs3dmapsettings.cpp.

◆ setSkyboxSettings()

void Qgs3DMapSettings::setSkyboxSettings ( const QgsSkyboxSettings skyboxSettings)

Sets the current configuration of the skybox.

Since
QGIS 3.16

Definition at line 860 of file qgs3dmapsettings.cpp.

◆ setTerrainElevationOffset()

void Qgs3DMapSettings::setTerrainElevationOffset ( float  offset)

Sets the terrain elevation offset (used to move the terrain up or down)

See also
terrainElevationOffset()
Since
QGIS 3.18

Definition at line 666 of file qgs3dmapsettings.cpp.

◆ setTerrainGenerator()

void Qgs3DMapSettings::setTerrainGenerator ( QgsTerrainGenerator gen)

Sets terrain generator.

It takes care of producing terrain tiles from the input data. Takes ownership of the generator.

Note
Terrain generation will only occur if terrainRenderingEnabled() is true.
See also
terrainGenerator()
setTerrainRenderingEnabled()

Definition at line 679 of file qgs3dmapsettings.cpp.

◆ setTerrainMapTheme()

void Qgs3DMapSettings::setTerrainMapTheme ( const QString &  theme)

Sets name of the map theme.

See also
terrainMapTheme()
Since
QGIS 3.6

Definition at line 712 of file qgs3dmapsettings.cpp.

◆ setTerrainRenderingEnabled()

void Qgs3DMapSettings::setTerrainRenderingEnabled ( bool  terrainRenderingEnabled)

Sets whether the 2D terrain surface will be rendered in.

See also
terrainRenderingEnabled()
Since
QGIS 3.22

Definition at line 902 of file qgs3dmapsettings.cpp.

◆ setTerrainShadingEnabled()

void Qgs3DMapSettings::setTerrainShadingEnabled ( bool  enabled)

Sets whether terrain shading is enabled.

See also
isTerrainShadingEnabled()
Since
QGIS 3.6

Definition at line 694 of file qgs3dmapsettings.cpp.

◆ setTerrainShadingMaterial()

void Qgs3DMapSettings::setTerrainShadingMaterial ( const QgsPhongMaterialSettings material)

Sets terrain shading material.

See also
terrainShadingMaterial()
Since
QGIS 3.6

Definition at line 703 of file qgs3dmapsettings.cpp.

◆ setTerrainVerticalScale()

void Qgs3DMapSettings::setTerrainVerticalScale ( double  zScale)

Sets vertical scale (exaggeration) of terrain (1 = true scale, > 1 = hills get more pronounced)

Definition at line 540 of file qgs3dmapsettings.cpp.

◆ settingsChanged

void Qgs3DMapSettings::settingsChanged ( )
signal

Emitted when one of the configuration settings has changed.

Since
QGIS 3.24

◆ setTransformContext()

void Qgs3DMapSettings::setTransformContext ( const QgsCoordinateTransformContext context)

Sets the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system.

See also
transformContext()

Definition at line 507 of file qgs3dmapsettings.cpp.

◆ setViewFrustumVisualizationEnabled()

void Qgs3DMapSettings::setViewFrustumVisualizationEnabled ( bool  enabled)

Sets whether the camera's view frustum is visualized on the 2D map canvas.

Since
QGIS 3.26

Definition at line 925 of file qgs3dmapsettings.cpp.

◆ setViewSyncMode()

void Qgs3DMapSettings::setViewSyncMode ( Qgis::ViewSyncModeFlags  mode)

Sets the view sync mode (used to synchronize the 2D main map canvas and the 3D camera navigation)

Since
QGIS 3.26

Definition at line 920 of file qgs3dmapsettings.cpp.

◆ shadowSettings()

QgsShadowSettings Qgs3DMapSettings::shadowSettings ( ) const
inline

Returns the current configuration of shadows.

Returns
QGIS 3.16

Definition at line 532 of file qgs3dmapsettings.h.

◆ shadowSettingsChanged

void Qgs3DMapSettings::shadowSettingsChanged ( )
signal

Emitted when shadow rendering settings are changed.

Since
QGIS 3.16

◆ showCameraRotationCenter()

bool Qgs3DMapSettings::showCameraRotationCenter ( ) const
inline

Returns whether to show camera's rotation center as a sphere (for debugging)

Since
QGIS 3.24

Definition at line 367 of file qgs3dmapsettings.h.

◆ showCameraRotationCenterChanged

void Qgs3DMapSettings::showCameraRotationCenterChanged ( )
signal

Emitted when the flag whether camera's rotation center is shown has changed.

Since
QGIS 3.24

◆ showCameraViewCenter()

bool Qgs3DMapSettings::showCameraViewCenter ( ) const
inline

Returns whether to show camera's view center as a sphere (for debugging)

Since
QGIS 3.4

Definition at line 355 of file qgs3dmapsettings.h.

◆ showCameraViewCenterChanged

void Qgs3DMapSettings::showCameraViewCenterChanged ( )
signal

Emitted when the flag whether camera's view center is shown has changed.

Since
QGIS 3.4

◆ showLabels()

bool Qgs3DMapSettings::showLabels ( ) const
inline

Returns whether to display labels on terrain tiles.

Definition at line 384 of file qgs3dmapsettings.h.

◆ showLabelsChanged

void Qgs3DMapSettings::showLabelsChanged ( )
signal

Emitted when the flag whether labels are displayed on terrain tiles has changed.

◆ showLightSourceOrigins()

bool Qgs3DMapSettings::showLightSourceOrigins ( ) const
inline

Returns whether to show light source origins as a sphere (for debugging)

Since
QGIS 3.16

Definition at line 379 of file qgs3dmapsettings.h.

◆ showLightSourceOriginsChanged

void Qgs3DMapSettings::showLightSourceOriginsChanged ( )
signal

Emitted when the flag whether light source origins are shown has changed.

Since
QGIS 3.15

◆ showTerrainBoundingBoxes()

bool Qgs3DMapSettings::showTerrainBoundingBoxes ( ) const
inline

Returns whether to display bounding boxes of terrain tiles (for debugging)

Definition at line 339 of file qgs3dmapsettings.h.

◆ showTerrainBoundingBoxesChanged

void Qgs3DMapSettings::showTerrainBoundingBoxesChanged ( )
signal

Emitted when the flag whether terrain's bounding boxes are shown has changed.

◆ showTerrainTilesInfo()

bool Qgs3DMapSettings::showTerrainTilesInfo ( ) const
inline

Returns whether to display extra tile info on top of terrain tiles (for debugging)

Definition at line 343 of file qgs3dmapsettings.h.

◆ showTerrainTilesInfoChanged

void Qgs3DMapSettings::showTerrainTilesInfoChanged ( )
signal

Emitted when the flag whether terrain's tile info is shown has changed.

◆ skyboxSettings()

QgsSkyboxSettings Qgs3DMapSettings::skyboxSettings ( ) const
inline

Returns the current configuration of the skybox.

Since
QGIS 3.16

Definition at line 526 of file qgs3dmapsettings.h.

◆ skyboxSettingsChanged

void Qgs3DMapSettings::skyboxSettingsChanged ( )
signal

Emitted when skybox settings are changed.

Since
QGIS 3.16

◆ terrainElevationOffset()

float Qgs3DMapSettings::terrainElevationOffset ( ) const
inline

Returns the elevation offset of the terrain (used to move the terrain up or down)

Definition at line 253 of file qgs3dmapsettings.h.

◆ terrainElevationOffsetChanged

void Qgs3DMapSettings::terrainElevationOffsetChanged ( float  newElevation)
signal

Emitted when the terrain elevation offset is changed.

Since
QGIS 3.16

◆ terrainGenerator()

QgsTerrainGenerator * Qgs3DMapSettings::terrainGenerator ( ) const
inline

Returns the terrain generator.

It takes care of producing terrain tiles from the input data.

Note
Terrain generation will only occur if terrainRenderingEnabled() is true.
See also
setTerrainGenerator()
terrainRenderingEnabled()

Definition at line 278 of file qgs3dmapsettings.h.

◆ terrainGeneratorChanged

void Qgs3DMapSettings::terrainGeneratorChanged ( )
signal

Emitted when the terrain generator has changed.

◆ terrainMapTheme()

QString Qgs3DMapSettings::terrainMapTheme ( ) const
inline

Returns name of the map theme (from the active project) that will be used for terrain's texture.

Empty map theme name means that the map theme is not overridden and the current map theme will be used.

Note
Support for map themes only works if mapThemeCollection() is a valid object (otherwise it is not possible to resolve map themes from names)
Since
QGIS 3.6

Definition at line 325 of file qgs3dmapsettings.h.

◆ terrainMapThemeChanged

void Qgs3DMapSettings::terrainMapThemeChanged ( )
signal

Emitted when terrain's map theme has changed.

Since
QGIS 3.6

◆ terrainRenderingEnabled()

bool Qgs3DMapSettings::terrainRenderingEnabled ( ) const
inline

Returns whether the 2D terrain surface will be rendered.

See also
setTerrainRenderingEnabled()
Since
QGIS 3.22

Definition at line 591 of file qgs3dmapsettings.h.

◆ terrainShadingChanged

void Qgs3DMapSettings::terrainShadingChanged ( )
signal

Emitted when terrain shading enabled flag or terrain shading material has changed.

Since
QGIS 3.6

◆ terrainShadingMaterial()

QgsPhongMaterialSettings Qgs3DMapSettings::terrainShadingMaterial ( ) const
inline

Returns terrain shading material.

Diffuse color component is ignored since the diffuse component is provided by 2D rendered map texture. Only used when isTerrainShadingEnabled() is true.

Since
QGIS 3.6

Definition at line 310 of file qgs3dmapsettings.h.

◆ terrainVerticalScale()

double Qgs3DMapSettings::terrainVerticalScale ( ) const

Returns vertical scale (exaggeration) of terrain.

Definition at line 549 of file qgs3dmapsettings.cpp.

◆ terrainVerticalScaleChanged

void Qgs3DMapSettings::terrainVerticalScaleChanged ( )
signal

Emitted when the vertical scale of the terrain has changed.

◆ transformContext()

QgsCoordinateTransformContext Qgs3DMapSettings::transformContext ( ) const

Returns the coordinate transform context, which stores various information regarding which datum transforms should be used when transforming points from a source to destination coordinate reference system.

See also
setTransformContext()

Definition at line 502 of file qgs3dmapsettings.cpp.

◆ viewFrustumVisualizationEnabled()

bool Qgs3DMapSettings::viewFrustumVisualizationEnabled ( ) const
inline

Returns whether the camera's view frustum is visualized on the 2D map canvas.

Since
QGIS 3.26

Definition at line 635 of file qgs3dmapsettings.h.

◆ viewFrustumVisualizationEnabledChanged

void Qgs3DMapSettings::viewFrustumVisualizationEnabledChanged ( )
signal

Emitted when the camera's view frustum visualization on the main 2D map canvas is enabled or disabled.

Since
QGIS 3.26

◆ viewSyncMode()

Qgis::ViewSyncModeFlags Qgs3DMapSettings::viewSyncMode ( ) const
inline

Returns the view sync mode (used to synchronize the 2D main map canvas and the 3D camera navigation)

Since
QGIS 3.26

Definition at line 621 of file qgs3dmapsettings.h.

◆ worldToMapCoordinates()

QgsVector3D Qgs3DMapSettings::worldToMapCoordinates ( const QgsVector3D worldCoords) const

Converts 3D world coordinates to map coordinates (applies offset and turns (x,y,z) into (x,-z,y))

Definition at line 492 of file qgs3dmapsettings.cpp.

◆ writeXml()

QDomElement Qgs3DMapSettings::writeXml ( QDomDocument &  doc,
const QgsReadWriteContext context 
) const

Writes configuration to a DOM element, to be used later with readXml()

Definition at line 333 of file qgs3dmapsettings.cpp.


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