Class: QgsTiledSceneLayer

class qgis.core.QgsTiledSceneLayer

Bases: QgsMapLayer

Represents a map layer supporting display of tiled scene objects.

Added in version 3.34.

QgsTiledSceneLayer(uri: Optional[str] = ‘’, baseName: Optional[str] = ‘’, provider: Optional[str] = ‘’, options: QgsTiledSceneLayer.LayerOptions = QgsTiledSceneLayer.LayerOptions()) Constructor for QgsTiledSceneLayer.

Methods

appendError

Add error message

childEvent

clone

rtype:

Optional[QgsTiledSceneLayer]

connectNotify

createMapRenderer

param rendererContext:

customEvent

dataProvider

rtype:

Optional[QgsTiledSceneDataProvider]

decodedSource

param source:

disconnectNotify

elevationProperties

rtype:

Optional[QgsMapLayerElevationProperties]

encodedSource

param source:

extent

rtype:

QgsRectangle

hasDependencyCycle

Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return False, because circular dependencies are now correctly managed.

htmlMetadata

rtype:

str

invalidateWgs84Extent

Invalidates the WGS84 extent.

isSignalConnected

loadDefaultMetadata

loadDefaultStyle

readCommonStyle

Read style data common to all layer types

readCustomProperties

Read custom properties from project file.

readStyle

param node:

readStyleManager

Read style manager's configuration (if any).

readSymbology

param node:

readXml

param layerNode:

receivers

renderer

Returns the 2D renderer for the tiled scene.

sender

senderSignalIndex

setError

Sets error message

setExtent

Sets the extent

setExtent3D

Sets the extent

setProviderType

Sets the providerType (provider key)

setRenderer

Sets the 2D renderer for the tiled scene.

setTransformContext

param transformContext:

setValid

Sets whether layer is valid or not

timerEvent

writeCommonStyle

Write style data common to all layer types

writeCustomProperties

Write custom properties to project file.

writeStyle

param node:

writeStyleManager

Write style manager's configuration (if exists).

writeSymbology

param node:

writeXml

param layerNode:

class LayerOptions(transformContext: QgsCoordinateTransformContext = QgsCoordinateTransformContext())

Bases: sip.wrapper

Constructor for LayerOptions with optional transformContext.

QgsTiledSceneLayer.LayerOptions(a0: QgsTiledSceneLayer.LayerOptions)

loadDefaultStyle
skipCrsValidation
transformContext
appendError(self, error: QgsErrorMessage)

Add error message

childEvent(self, a0: QChildEvent | None)
clone(self) QgsTiledSceneLayer | None
Return type:

Optional[QgsTiledSceneLayer]

connectNotify(self, signal: QMetaMethod)
createMapRenderer(self, rendererContext: QgsRenderContext) QgsMapLayerRenderer | None
Parameters:

rendererContext (QgsRenderContext)

Return type:

Optional[QgsMapLayerRenderer]

customEvent(self, a0: QEvent | None)
dataProvider(self) QgsTiledSceneDataProvider | None
Return type:

Optional[QgsTiledSceneDataProvider]

decodedSource(self, source: str | None, dataProvider: str | None, context: QgsReadWriteContext) str
Parameters:
Return type:

str

disconnectNotify(self, signal: QMetaMethod)
elevationProperties(self) QgsMapLayerElevationProperties | None
Return type:

Optional[QgsMapLayerElevationProperties]

encodedSource(self, source: str | None, context: QgsReadWriteContext) str
Parameters:
Return type:

str

extent(self) QgsRectangle
Return type:

QgsRectangle

hasDependencyCycle(self, a0: Iterable[QgsMapLayerDependency]) bool

Checks whether a new set of dependencies will introduce a cycle this method is now deprecated and always return False, because circular dependencies are now correctly managed.

Deprecated since version QGIS: 3.10

htmlMetadata(self) str
Return type:

str

invalidateWgs84Extent(self)

Invalidates the WGS84 extent. If FlagTrustLayerMetadata is enabled, the extent is not invalidated because we want to trust metadata whatever happens.

Added in version 3.20.

isSignalConnected(self, signal: QMetaMethod) bool
loadDefaultMetadata(self)
loadDefaultStyle(self)
readCommonStyle(self, layerElement: QDomElement, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories)

Read style data common to all layer types

readCustomProperties(self, layerNode: QDomNode, keyStartsWith: str | None = '')

Read custom properties from project file.

Parameters:
  • layerNode – note to read from

  • keyStartsWith – reads only properties starting with the specified string (or all if the string is empty)

readStyle(self, node: QDomNode, errorMessage: str | None, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories) bool
Parameters:
Return type:

bool

readStyleManager(self, layerNode: QDomNode)

Read style manager’s configuration (if any). To be called by subclasses.

readSymbology(self, node: QDomNode, errorMessage: str | None, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories) bool
Parameters:
Return type:

bool

readXml(self, layerNode: QDomNode, context: QgsReadWriteContext) bool
Parameters:
Return type:

bool

receivers(self, signal: PYQT_SIGNAL) int
renderer(self) QgsTiledSceneRenderer | None

Returns the 2D renderer for the tiled scene.

See also

setRenderer()

Return type:

Optional[QgsTiledSceneRenderer]

sender(self) QObject | None
senderSignalIndex(self) int
setError(self, error: QgsError)

Sets error message

setExtent(self, rect: QgsRectangle)

Sets the extent

setExtent3D(self, box: QgsBox3D)

Sets the extent

Added in version 3.36.

setProviderType(self, providerType: str | None)

Sets the providerType (provider key)

setRenderer(self, renderer: QgsTiledSceneRenderer | None)

Sets the 2D renderer for the tiled scene.

Ownership of renderer is transferred to the layer.

See also

renderer()

Parameters:

renderer (Optional[QgsTiledSceneRenderer])

setTransformContext(self, transformContext: QgsCoordinateTransformContext)
Parameters:

transformContext (QgsCoordinateTransformContext)

setValid(self, valid: bool)

Sets whether layer is valid or not

timerEvent(self, a0: QTimerEvent | None)
writeCommonStyle(self, layerElement: QDomElement, document: QDomDocument, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories)

Write style data common to all layer types

writeCustomProperties(self, layerNode: QDomNode, doc: QDomDocument)

Write custom properties to project file.

writeStyle(self, node: QDomNode, doc: QDomDocument, errorMessage: str | None, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories) bool
Parameters:
Return type:

bool

writeStyleManager(self, layerNode: QDomNode, doc: QDomDocument)

Write style manager’s configuration (if exists). To be called by subclasses.

writeSymbology(self, node: QDomNode, doc: QDomDocument, errorMessage: str | None, context: QgsReadWriteContext, categories: QgsMapLayer.StyleCategories | QgsMapLayer.StyleCategory = QgsMapLayer.AllStyleCategories) bool
Parameters:
Return type:

bool

writeXml(self, layerNode: QDomNode, doc: QDomDocument, context: QgsReadWriteContext) bool
Parameters:
Return type:

bool