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.
QObject
QgsAbstractProfileSource	Interface for classes which can generate elevation profiles.

class qgis.core.QgsPointCloudLayer

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: bool

skipIndexGeneration: bool

skipStatisticsCalculation: bool

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

Returns the attributes available from the layer.

Return type:

QgsPointCloudAttributeCollection

signal chunkAttributeValuesChanged

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.

commitChanges(self, stopEditing: bool = True) → bool

Attempts to commit to the underlying data provider any buffered changes made since the last to call to startEditing().

Returns the result of the attempt. If a commit fails (i.e. False is returned), the in-memory changes are left untouched and are not discarded. This allows editing to continue if the commit failed on e.g. a disallowed value for an attribute - the user can re-edit and try again.

If the commit failed, an error message may returned by commitError().

By setting stopEditing to False, the layer will stay in editing mode. Otherwise the layer editing mode will be disabled if the commit is successful.

See also

startEditing()

See also

commitError()

See also

rollBack()

Added in version 3.42.

Parameters:

stopEditing (bool = True)

Return type:

bool

commitError(self) → str

Returns the last error message generated when attempting to commit changes to the layer.

See also

commitChanges()

Added in version 3.42.

Return type:

str

convertRenderer3DFromRenderer2D(self) → bool

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.

index(self) → QgsPointCloudIndex

Returns the point cloud index associated with the layer. If the layer is editable, its QgsPointCloudEditingIndex is returned, otherwise the index is fetched from the data provider.

Added in version 3.42.

Return type:

QgsPointCloudIndex

pointCount(self) → int

Returns the total number of points available in the layer.

Return type:

int

signal raiseError

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

Returns the 2D renderer for the point cloud.

See also

setRenderer()

Return type:

Optional[QgsPointCloudRenderer]

rollBack(self) → bool

Stops a current editing operation and discards any uncommitted edits.

See also

startEditing()

See also

commitChanges()

Added in version 3.42.

Return type:

bool

setRenderer(self, renderer: QgsPointCloudRenderer | None)

Sets the 2D renderer for the point cloud.

Ownership of renderer is transferred to the layer.

See also

renderer()

Parameters:

renderer (Optional[QgsPointCloudRenderer])

setSubsetString(self, subset: str | None) → bool

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)

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)

startEditing(self) → bool

Makes the layer editable.

This starts an edit session on this layer. Changes made in this edit session will not be made persistent until commitChanges() is called, and can be reverted by calling rollBack().

Return type:

bool

Returns:

True if the layer was successfully made editable, or False if the operation failed (e.g. due to an underlying read-only data source, or lack of edit support by the backend data provider).

See also

commitChanges()

See also

rollBack()

Added in version 3.42.

statistics(self) → QgsPointCloudStatistics

Returns the object containing statistics

Added in version 3.26.

Return type:

QgsPointCloudStatistics

statisticsCalculationState(self) → QgsPointCloudLayer.PointCloudStatisticsCalculationState

Returns the status of point cloud statistics calculation

Added in version 3.26.

Return type:

QgsPointCloudLayer.PointCloudStatisticsCalculationState

signal statisticsCalculationStateChanged

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

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

Return type:

str

Returns:

The subset string or an empty string if not implemented by the provider

Added in version 3.26.

signal subsetStringChanged

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

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