Class: Qgs3DMapSettings

class qgis._3d.Qgs3DMapSettings

Bases: PyQt5.QtCore.QObject, QgsTemporalRangeObject

Definition of the world.

New in version 3.0.

Qgs3DMapSettings() Constructor for Qgs3DMapSettings

Qgs3DMapSettings(other: Qgs3DMapSettings) Copy constructor

Methods

backgroundColor

Returns background color of the 3D map view

cameraMovementSpeed

Returns the camera movement speed

childEvent

connectNotify

crs

Returns coordinate reference system used in the 3D scene

customEvent

debugDepthMapCorner

Returns the corner where the shadow map preview is displayed

debugDepthMapEnabled

Returns whether the shadow map debugging is enabled

debugDepthMapSize

Returns the size of the shadow map preview

debugShadowMapCorner

Returns the corner where the shadow map preview is displayed

debugShadowMapEnabled

Returns whether the shadow map debugging is enabled

debugShadowMapSize

Returns the size of the shadow map preview

disconnectNotify

eyeDomeLightingDistance

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

eyeDomeLightingEnabled

Returns whether eye dome lighting is used

eyeDomeLightingStrength

Returns the eye dome lighting strength value

fieldOfView

Returns the camera lens' field of view

isDebugOverlayEnabled

Returns whether debug overlay is enabled

isFpsCounterEnabled

Returns whether FPS counter label is enabled

isSignalConnected

isSkyboxEnabled

Returns whether the skybox is enabled.

isTerrainShadingEnabled

Returns whether terrain shading is enabled.

layers

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

lightSources

Returns list of directional light sources defined in the scene.

mapThemeCollection

Returns pointer to the collection of map themes.

mapTileResolution

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

mapToWorldCoordinates

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

maxTerrainGroundError

Returns maximum ground error of terrain tiles in world units.

maxTerrainScreenError

Returns maximum allowed screen error of terrain tiles in pixels.

origin

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

outputDpi

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

pathResolver

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

readXml

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

receivers

rendererUsage

Returns the renderer usage

renderers

Returns list of extra 3D renderers

resolveReferences

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

selectionColor

Returns color used for selected features

sender

senderSignalIndex

setBackgroundColor

Sets background color of the 3D map view

setCameraMovementSpeed

Sets the camera movement speed

setCrs

Sets coordinate reference system used in the 3D scene

setDebugDepthMapSettings

Sets the debugging settings of the depth map

setDebugShadowMapSettings

Sets the debugging settings of the shadow map

setEyeDomeLightingDistance

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

setEyeDomeLightingEnabled

Sets whether eye dome lighting will be used

setEyeDomeLightingStrength

Sets the eye dome lighting strength value

setFieldOfView

Sets the camera lens' field of view

setIsDebugOverlayEnabled

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

setIsFpsCounterEnabled

Sets whether FPS counter label is enabled

setIsSkyboxEnabled

Sets whether the skybox is enabled.

setLayers

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

setLightSources

Sets the list of light sources defined in the scene.

setMapThemeCollection

Sets pointer to the collection of map themes.

setMapTileResolution

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

setMaxTerrainGroundError

Returns maximum ground error of terrain tiles in world units.

setMaxTerrainScreenError

Sets maximum allowed screen error of terrain tiles in pixels.

setOrigin

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

setOutputDpi

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

setPathResolver

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

setRendererUsage

Sets the renderer usage

setRenderers

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

setSelectionColor

Sets color used for selected features

setShowCameraRotationCenter

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

setShowCameraViewCenter

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

setShowLabels

Sets whether to display labels on terrain tiles

setShowLightSourceOrigins

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

setShowTerrainBoundingBoxes

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

setShowTerrainTilesInfo

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

setTerrainElevationOffset

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

setTerrainMapTheme

Sets name of the map theme.

setTerrainRenderingEnabled

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

setTerrainShadingEnabled

Sets whether terrain shading is enabled.

setTerrainShadingMaterial

Sets terrain shading material.

setTerrainVerticalScale

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

setTransformContext

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.

setViewFrustumVisualizationEnabled

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

setViewSyncMode

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

showCameraRotationCenter

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

showCameraViewCenter

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

showLabels

Returns whether to display labels on terrain tiles

showLightSourceOrigins

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

showTerrainBoundingBoxes

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

showTerrainTilesInfo

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

terrainElevationOffset

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

terrainMapTheme

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

terrainRenderingEnabled

Returns whether the 2D terrain surface will be rendered.

terrainShadingMaterial

Returns terrain shading material.

terrainVerticalScale

Returns vertical scale (exaggeration) of terrain

timerEvent

transformContext

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.

viewFrustumVisualizationEnabled

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

viewSyncMode

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

worldToMapCoordinates

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

writeXml

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

Signals

ambientOcclusionSettingsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

axisSettingsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

backgroundColorChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

cameraMovementSpeedChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

cameraNavigationModeChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

debugDepthMapSettingsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

debugOverlayEnabledChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

debugShadowMapSettingsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

directionalLightsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

eyeDomeLightingDistanceChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

eyeDomeLightingEnabledChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

eyeDomeLightingStrengthChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

fieldOfViewChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

fpsCounterEnabledChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

layersChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

lightSourcesChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

mapTileResolutionChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

maxTerrainGroundErrorChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

maxTerrainScreenErrorChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

pointLightsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

projectionTypeChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

renderersChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

selectionColorChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

settingsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

shadowSettingsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

showCameraRotationCenterChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

showCameraViewCenterChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

showLabelsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

showLightSourceOriginsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

showTerrainBoundingBoxesChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

showTerrainTilesInfoChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

skyboxSettingsChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

terrainElevationOffsetChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

terrainGeneratorChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

terrainMapThemeChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

terrainShadingChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

terrainVerticalScaleChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL

viewFrustumVisualizationEnabledChanged

pyqtSignal(*types, name: str = ..., revision: int = ..., arguments: Sequence = ...) -> PYQT_SIGNAL
ambientOcclusionSettingsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

axisSettingsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

backgroundColor(self) → QColor

Returns background color of the 3D map view

Return type:

QColor

backgroundColorChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

cameraMovementSpeed(self) → float

Returns the camera movement speed

New in version 3.18.

Return type:

float

cameraMovementSpeedChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

cameraNavigationModeChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
crs(self) → QgsCoordinateReferenceSystem

Returns coordinate reference system used in the 3D scene

Return type:

QgsCoordinateReferenceSystem

customEvent(self, QEvent)
debugDepthMapCorner(self) → Qt.Corner

Returns the corner where the shadow map preview is displayed

Return type:

Qt.Corner

debugDepthMapEnabled(self) → bool

Returns whether the shadow map debugging is enabled

Return type:

bool

debugDepthMapSettingsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

debugDepthMapSize(self) → float

Returns the size of the shadow map preview

Return type:

float

debugOverlayEnabledChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

debugShadowMapCorner(self) → Qt.Corner

Returns the corner where the shadow map preview is displayed

Return type:

Qt.Corner

debugShadowMapEnabled(self) → bool

Returns whether the shadow map debugging is enabled

Return type:

bool

debugShadowMapSettingsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

debugShadowMapSize(self) → float

Returns the size of the shadow map preview

Return type:

float

directionalLightsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

disconnectNotify(self, QMetaMethod)
eyeDomeLightingDistance(self) → int

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

Return type:

int

eyeDomeLightingDistanceChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

eyeDomeLightingEnabled(self) → bool

Returns whether eye dome lighting is used

Return type:

bool

eyeDomeLightingEnabledChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

eyeDomeLightingStrength(self) → float

Returns the eye dome lighting strength value

Return type:

float

eyeDomeLightingStrengthChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

fieldOfView(self) → float

Returns the camera lens’ field of view

New in version 3.8.

Return type:

float

fieldOfViewChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

fpsCounterEnabledChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

isDebugOverlayEnabled(self) → bool

Returns whether debug overlay is enabled

See also

setIsDebugOverlayEnabled()

New in version 3.26.

Return type:

bool

isFpsCounterEnabled(self) → bool

Returns whether FPS counter label is enabled

See also

setIsFpsCounterEnabled()

New in version 3.18.

Return type:

bool

isSignalConnected(self, QMetaMethod) → bool
isSkyboxEnabled(self) → bool

Returns whether the skybox is enabled.

See also

setIsSkyboxEnabled()

New in version 3.16.

Return type:

bool

isTerrainShadingEnabled(self) → bool

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).

New in version 3.6.

Return type:

bool

layers(self) → List[QgsMapLayer]

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()

See also

layersChanged()

Return type:

List[QgsMapLayer]

layersChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

lightSources(self) → List[QgsLightSource]

Returns list of directional light sources defined in the scene.

See also

setLightSources()

New in version 3.26.

Return type:

List[QgsLightSource]

lightSourcesChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

mapThemeCollection(self) → QgsMapThemeCollection

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.

New in version 3.6.

Return type:

QgsMapThemeCollection

mapTileResolution(self) → int

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())

Return type:

int

mapTileResolutionChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

mapToWorldCoordinates(self, mapCoords: QgsVector3D) → QgsVector3D

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

Parameters:

mapCoords (QgsVector3D) –

Return type:

QgsVector3D

maxTerrainGroundError(self) → float

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.

Return type:

float

maxTerrainGroundErrorChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

maxTerrainScreenError(self) → float

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.

Return type:

float

maxTerrainScreenErrorChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

origin(self) → QgsVector3D

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

Return type:

QgsVector3D

outputDpi(self) → float

Returns DPI used for conversion between real world units (e.g. mm) and pixels Default value is 96

New in version 3.10.

Return type:

float

pathResolver(self) → QgsPathResolver

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

See also

setPathResolver()

New in version 3.0.

Return type:

QgsPathResolver

pointLightsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

projectionTypeChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

readXml(self, elem: QDomElement, context: QgsReadWriteContext)

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

Parameters:
receivers(self, PYQT_SIGNAL) → int
rendererUsage(self) → Qgis.RendererUsage

Returns the renderer usage

See also

rendererUsage()

New in version 3.24.

Return type:

Qgis.RendererUsage

renderers(self) → List[QgsAbstract3DRenderer]

Returns list of extra 3D renderers

Return type:

List[QgsAbstract3DRenderer]

renderersChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

resolveReferences(self, project: QgsProject)

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

Parameters:

project (QgsProject) –

selectionColor(self) → QColor

Returns color used for selected features

Return type:

QColor

selectionColorChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

sender(self) → QObject
senderSignalIndex(self) → int
setBackgroundColor(self, color: QColor | Qt.GlobalColor)

Sets background color of the 3D map view

Parameters:

color (Union[QColor) –

setCameraMovementSpeed(self, movementSpeed: float)

Sets the camera movement speed

New in version 3.18.

Parameters:

movementSpeed (float) –

setCrs(self, crs: QgsCoordinateReferenceSystem)

Sets coordinate reference system used in the 3D scene

Parameters:

crs (QgsCoordinateReferenceSystem) –

setDebugDepthMapSettings(self, enabled: bool, corner: Qt.Corner, size: float)

Sets the debugging settings of the depth map

See also

debugDepthMapEnabled()

New in version 3.18.

Parameters:

  • enabled (bool) –

  • corner (Qt.Corner) –

  • size (float) –

setDebugShadowMapSettings(self, enabled: bool, corner: Qt.Corner, size: float)

Sets the debugging settings of the shadow map

See also

debugShadowMapEnabled()

New in version 3.18.

Parameters:

  • enabled (bool) –

  • corner (Qt.Corner) –

  • size (float) –

setEyeDomeLightingDistance(self, distance: int)

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

See also

eyeDomeLightingDistance()

New in version 3.18.

Parameters:

distance (int) –

setEyeDomeLightingEnabled(self, enabled: bool)

Sets whether eye dome lighting will be used

See also

eyeDomeLightingEnabled()

New in version 3.18.

Parameters:

enabled (bool) –

setEyeDomeLightingStrength(self, strength: float)

Sets the eye dome lighting strength value

See also

eyeDomeLightingStrength()

New in version 3.18.

Parameters:

strength (float) –

setFieldOfView(self, fieldOfView: float)

Sets the camera lens’ field of view

New in version 3.8.

Parameters:

fieldOfView (float) –

setIsDebugOverlayEnabled(self, debugOverlayEnabled: bool)

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()

New in version 3.26.

Parameters:

debugOverlayEnabled (bool) –

setIsFpsCounterEnabled(self, fpsCounterEnabled: bool)

Sets whether FPS counter label is enabled

See also

isFpsCounterEnabled()

New in version 3.18.

Parameters:

fpsCounterEnabled (bool) –

setIsSkyboxEnabled(self, enabled: bool)

Sets whether the skybox is enabled.

See also

isSkyboxEnabled()

New in version 3.16.

Parameters:

enabled (bool) –

setLayers(self, layers: Iterable[QgsMapLayer])

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()

See also

layersChanged()

Parameters:

layers (Iterable[QgsMapLayer]) –

setLightSources(self, lights: Iterable[QgsLightSource])

Sets the list of light sources defined in the scene.

Ownership of the lights is transferred to the settings.

See also

lightSources()

New in version 3.26.

Parameters:

lights (Iterable[QgsLightSource]) –

setMapThemeCollection(self, mapThemes: QgsMapThemeCollection)

Sets pointer to the collection of map themes.

See also

mapThemeCollection()

New in version 3.6.

Parameters:

mapThemes (QgsMapThemeCollection) –

setMapTileResolution(self, res: int)

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

See also

mapTileResolution()

Parameters:

res (int) –

setMaxTerrainGroundError(self, error: float)

Returns maximum ground error of terrain tiles in world units.

See also

maxTerrainGroundError()

Parameters:

error (float) –

setMaxTerrainScreenError(self, error: float)

Sets maximum allowed screen error of terrain tiles in pixels.

See also

maxTerrainScreenError()

Parameters:

error (float) –

setOrigin(self, origin: QgsVector3D)

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.

Parameters:

origin (QgsVector3D) –

setOutputDpi(self, dpi: float)

Sets DPI used for conversion between real world units (e.g. mm) and pixels

Parameters:

dpi (float) – the number of dot per inch

New in version 3.10.

setPathResolver(self, resolver: QgsPathResolver)

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

See also

pathResolver()

New in version 3.0.

Parameters:

resolver (QgsPathResolver) –

setRendererUsage(self, rendererUsage: Qgis.RendererUsage)

Sets the renderer usage

See also

rendererUsage()

New in version 3.24.

Parameters:

rendererUsage (Qgis.RendererUsage) –

setRenderers(self, renderers: Iterable[QgsAbstract3DRenderer])

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

Parameters:

renderers (Iterable[QgsAbstract3DRenderer]) –

setSelectionColor(self, color: QColor | Qt.GlobalColor)

Sets color used for selected features

Parameters:

color (Union[QColor) –

setShowCameraRotationCenter(self, enabled: bool)

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

New in version 3.24.

Parameters:

enabled (bool) –

setShowCameraViewCenter(self, enabled: bool)

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

New in version 3.4.

Parameters:

enabled (bool) –

setShowLabels(self, enabled: bool)

Sets whether to display labels on terrain tiles

Parameters:

enabled (bool) –

setShowLightSourceOrigins(self, enabled: bool)

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

New in version 3.16.

Parameters:

enabled (bool) –

setShowTerrainBoundingBoxes(self, enabled: bool)

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

Parameters:

enabled (bool) –

setShowTerrainTilesInfo(self, enabled: bool)

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

Parameters:

enabled (bool) –

setTerrainElevationOffset(self, offset: float)

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

See also

terrainElevationOffset()

New in version 3.18.

Parameters:

offset (float) –

setTerrainMapTheme(self, theme: str)

Sets name of the map theme.

See also

terrainMapTheme()

New in version 3.6.

Parameters:

theme (str) –

setTerrainRenderingEnabled(self, terrainRenderingEnabled: bool)

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

See also

terrainRenderingEnabled()

New in version 3.22.

Parameters:

terrainRenderingEnabled (bool) –

setTerrainShadingEnabled(self, enabled: bool)

Sets whether terrain shading is enabled.

See also

isTerrainShadingEnabled()

New in version 3.6.

Parameters:

enabled (bool) –

setTerrainShadingMaterial(self, material: QgsPhongMaterialSettings)

Sets terrain shading material.

See also

terrainShadingMaterial()

New in version 3.6.

Parameters:

material (QgsPhongMaterialSettings) –

setTerrainVerticalScale(self, zScale: float)

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

Parameters:

zScale (float) –

setTransformContext(self, context: QgsCoordinateTransformContext)

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()

Parameters:

context (QgsCoordinateTransformContext) –

setViewFrustumVisualizationEnabled(self, enabled: bool)

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

New in version 3.26.

Parameters:

enabled (bool) –

setViewSyncMode(self, mode: Qgis.ViewSyncModeFlags | Qgis.ViewSyncModeFlag)

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

New in version 3.26.

Parameters:

mode (Union[Qgis.ViewSyncModeFlags) –

settingsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

shadowSettingsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

showCameraRotationCenter(self) → bool

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

New in version 3.24.

Return type:

bool

showCameraRotationCenterChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

showCameraViewCenter(self) → bool

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

New in version 3.4.

Return type:

bool

showCameraViewCenterChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

showLabels(self) → bool

Returns whether to display labels on terrain tiles

Return type:

bool

showLabelsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

showLightSourceOrigins(self) → bool

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

New in version 3.16.

Return type:

bool

showLightSourceOriginsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

showTerrainBoundingBoxes(self) → bool

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

Return type:

bool

showTerrainBoundingBoxesChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

showTerrainTilesInfo(self) → bool

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

Return type:

bool

showTerrainTilesInfoChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

skyboxSettingsChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

terrainElevationOffset(self) → float

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

Return type:

float

terrainElevationOffsetChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

terrainGeneratorChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

terrainMapTheme(self) → str

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)

New in version 3.6.

Return type:

str

terrainMapThemeChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

terrainRenderingEnabled(self) → bool

Returns whether the 2D terrain surface will be rendered.

See also

setTerrainRenderingEnabled()

New in version 3.22.

Return type:

bool

terrainShadingChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

terrainShadingMaterial(self) → QgsPhongMaterialSettings

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.

New in version 3.6.

Return type:

QgsPhongMaterialSettings

terrainVerticalScale(self) → float

Returns vertical scale (exaggeration) of terrain

Return type:

float

terrainVerticalScaleChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

timerEvent(self, QTimerEvent)
transformContext(self) → QgsCoordinateTransformContext

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()

Return type:

QgsCoordinateTransformContext

viewFrustumVisualizationEnabled(self) → bool

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

New in version 3.26.

Return type:

bool

viewFrustumVisualizationEnabledChanged

pyqtSignal(*types, name: str = …, revision: int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Parameters:

  • name (str = ...) –

  • revision (int = ...) –

  • arguments (Sequence = ...) –

Return type:

PYQT_SIGNAL

viewSyncMode(self) → Qgis.ViewSyncModeFlags

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

New in version 3.26.

Return type:

Qgis.ViewSyncModeFlags

worldToMapCoordinates(self, worldCoords: QgsVector3D) → QgsVector3D

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

Parameters:

worldCoords (QgsVector3D) –

Return type:

QgsVector3D

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement

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

Parameters:
Return type:

QDomElement