Class: QgsPointCloudLayer¶

class qgis.core.QgsPointCloudLayer¶

Bases: QgsMapLayer

Represents a map layer supporting display of point clouds

Note

The API is considered EXPERIMENTAL and can be changed without a notice

New in version 3.18.

QgsPointCloudLayer(uri: str = ‘’, baseName: str = ‘’, providerLib: str = ‘’, options: QgsPointCloudLayer.LayerOptions = QgsPointCloudLayer.LayerOptions()) Constructor - creates a point cloud layer

Methods

appendError

Add error message

attributes

Returns the attributes available from the layer.

childEvent

clone

rtype

QgsPointCloudLayer

connectNotify

createMapRenderer

param rendererContext

customEvent

dataProvider

rtype

QgsPointCloudDataProvider

decodedSource

param source

disconnectNotify

elevationProperties

rtype

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

loadDefaultStyle

rtype

Tuple[str, bool]

pointCount

Returns the total number of points available in the layer.

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 point cloud.

sender

senderSignalIndex

setError

Sets error message

setExtent

Sets the extent

setProviderType

Sets the providerType (provider key)

setRenderer

Sets the 2D renderer for the point cloud.

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.

QgsPointCloudLayer.LayerOptions(QgsPointCloudLayer.LayerOptions)

loadDefaultStyle¶

skipCrsValidation¶

skipIndexGeneration¶

transformContext¶

appendError(self, error: QgsErrorMessage)¶: Add error message

attributes(self) → QgsPointCloudAttributeCollection ¶

Returns the attributes available from the layer.

Return type: QgsPointCloudAttributeCollection

childEvent(self, QChildEvent)¶

clone(self) → QgsPointCloudLayer ¶

Return type: QgsPointCloudLayer

connectNotify(self, QMetaMethod)¶

createMapRenderer(self, rendererContext: QgsRenderContext) → QgsMapLayerRenderer ¶

Parameters: rendererContext (QgsRenderContext) –
Return type: QgsMapLayerRenderer

customEvent(self, QEvent)¶

dataProvider(self) → QgsPointCloudDataProvider ¶

Return type: QgsPointCloudDataProvider

decodedSource(self, source: str, dataProvider: str, context: QgsReadWriteContext) → str¶

Parameters

source (str) –
dataProvider (str) –
context (QgsReadWriteContext) –

Return type

str

disconnectNotify(self, QMetaMethod)¶

elevationProperties(self) → QgsMapLayerElevationProperties ¶

Return type: QgsMapLayerElevationProperties

encodedSource(self, source: str, context: QgsReadWriteContext) → str¶

Parameters

source (str) –
context (QgsReadWriteContext) –

Return type

str

extent(self) → QgsRectangle ¶

Return type: QgsRectangle

hasDependencyCycle(self, 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.

New in version 3.20.

isSignalConnected(self, QMetaMethod) → bool¶

loadDefaultStyle(self) → Tuple[str, bool]¶

Return type: Tuple[str, bool]

pointCount(self) → int¶

Returns the total number of points available in the layer.

Return type: int

readCommonStyle(self, layerElement: QDomElement, context: QgsReadWriteContext, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories)¶: Read style data common to all layer types

New in version 3.0.

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

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, context: QgsReadWriteContext, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) → bool¶

Parameters

node (QDomNode) –
errorMessage (str) –
context (QgsReadWriteContext) –
categories (Union[QgsMapLayer.StyleCategories) –

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, context: QgsReadWriteContext, categories: Union[QgsMapLayer.StyleCategories, QgsMapLayer.StyleCategory] = QgsMapLayer.AllStyleCategories) → bool¶

Parameters

node (QDomNode) –
errorMessage (str) –
context (QgsReadWriteContext) –
categories (Union[QgsMapLayer.StyleCategories) –

Return type

bool

readXml(self, layerNode: QDomNode, context: QgsReadWriteContext) → bool¶

Parameters

layerNode (QDomNode) –
context (QgsReadWriteContext) –

Return type

bool

receivers(self, PYQT_SIGNAL) → int¶

renderer(self) → QgsPointCloudRenderer ¶

Returns the 2D renderer for the point cloud.