Class: QgsPointCloudLayer¶

Represents a map layer supporting display of point clouds

Note

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

Added in version 3.18.

Class Hierarchy¶

Base classes¶

`QgsMapLayer`	Base class for all map layer types. This is the base class for all map layer types (vector, raster).
QObject
`QgsAbstractProfileSource`	Interface for classes which can generate elevation profiles.

class qgis.core.QgsPointCloudLayer[source]¶

Bases: QgsMapLayer, QgsAbstractProfileSource

__init__(uri: str | None = '', baseName: str | None = '', providerLib: str | None = '', options: QgsPointCloudLayer.LayerOptions = QgsPointCloudLayer.LayerOptions())

Constructor - creates a point cloud layer

Parameters:

uri (Optional[str] = '')
baseName (Optional[str] = '')
providerLib (Optional[str] = '')
options (QgsPointCloudLayer.LayerOptions = QgsPointCloudLayer.LayerOptions())

class LayerOptions¶

Bases: object

Setting options for loading point cloud layers.

skipCrsValidation¶

skipIndexGeneration¶

skipStatisticsCalculation¶

class PointCloudStatisticsCalculationState(*values)¶

Bases: IntEnum

Point cloud statistics calculation task

Added in version 3.26.

NotStarted: The statistics calculation task has not been started
Calculating: The statistics calculation task is running
Calculated: The statistics calculation task is done and statistics are available

Calculated = 2¶

Calculating = 1¶

NotStarted = 0¶

attributes(self) → QgsPointCloudAttributeCollection[source]¶

Returns the attributes available from the layer.

Return type:: QgsPointCloudAttributeCollection

convertRenderer3DFromRenderer2D(self) → bool[source]¶

Updates the layer’s 3D renderer’s symbol to match that of the layer’s 2D renderer

Return type:: bool
Returns:: True on success, False otherwise

Added in version 3.26.

pointCount(self) → int[source]¶

Returns the total number of points available in the layer.

Return type:: int

signal raiseError[source]¶

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.

renderer(self) → QgsPointCloudRenderer | None[source]¶

Returns the 2D renderer for the point cloud.

See also

renderer()

Parameters:: renderer (Optional[QgsPointCloudRenderer])

setSubsetString(self, subset: str | None) → bool[source]¶

Sets the string used to define a subset of the layer

Parameters:: subset (Optional[str]) – The subset string to be used in a :py:class:`QgsPointCloudExpression`
Return type:: bool
Returns:: True, when setting the subset string was successful, False otherwise

Added in version 3.26.

setSync3DRendererTo2DRenderer(self, sync: bool)[source]¶

Sets whether this layer’s 3D renderer should be automatically updated with changes applied to the layer’s 2D renderer

Added in version 3.26.

Parameters:: sync (bool)

statistics(self) → QgsPointCloudStatistics[source]¶

Returns the object containing statistics

Added in version 3.26.

Return type:: QgsPointCloudStatistics

statisticsCalculationState(self) → QgsPointCloudLayer.PointCloudStatisticsCalculationState[source]¶

Returns the status of point cloud statistics calculation

Added in version 3.26.

Return type:: QgsPointCloudLayer.PointCloudStatisticsCalculationState

signal statisticsCalculationStateChanged[source]¶

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.

subsetString(self) → str[source]¶

Returns the string used to define a subset of the layer.

Return type:: str
Returns:: The subset string or null QString if not implemented by the provider

Added in version 3.26.

signal subsetStringChanged[source]¶

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.

sync3DRendererTo2DRenderer(self) → bool[source]¶

Returns whether this layer’s 3D renderer should be automatically updated with changes applied to the layer’s 2D renderer

Added in version 3.26.

Return type:: bool