Class: QgsPointCloudLayerElevationProperties

Point cloud layer specific subclass of QgsMapLayerElevationProperties.

Added in version 3.18.

Class Hierarchy

Inheritance diagram of qgis.core.QgsPointCloudLayerElevationProperties

Base classes

QgsMapLayerElevationProperties

Base class for storage of map layer elevation properties.

QObject

Methods

applyOpacityByDistanceEffect

Returns True if a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.

maximumScreenError

Returns the maximum screen error allowed when generating elevation profiles for the point cloud.

maximumScreenErrorUnit

Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.

pointColor

Returns the color used drawing points in elevation profile charts.

pointSize

Returns the point size used for drawing points in elevation profile charts.

pointSizeUnit

Returns the units used for the point size used for drawing points in elevation profile charts.

pointSymbol

Returns the symbol used drawing points in elevation profile charts.

respectLayerColors

Returns True if layer coloring should be respected when rendering elevation profile plots.

setApplyOpacityByDistanceEffect

Sets whether a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.

setMaximumScreenError

Sets the maximum screen error allowed when generating elevation profiles for the point cloud.

setMaximumScreenErrorUnit

Sets the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.

setPointColor

Sets the color used drawing points in elevation profile charts.

setPointSize

Sets the point size used for drawing points in elevation profile charts.

setPointSizeUnit

Sets the units used for the point size used for drawing points in elevation profile charts.

setPointSymbol

Sets the symbol used drawing points in elevation profile charts.

setRespectLayerColors

Sets whether layer coloring should be respected when rendering elevation profile plots.

class qgis.core.QgsPointCloudLayerElevationProperties[source]

Bases: QgsMapLayerElevationProperties

__init__(parent: QObject | None)

Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object.

Parameters:

parent (Optional[QObject])

applyOpacityByDistanceEffect(self) bool[source]

Returns True if a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.

Added in version 3.26.

Return type:

bool

maximumScreenError(self) float[source]

Returns the maximum screen error allowed when generating elevation profiles for the point cloud.

Larger values result in a faster generation with less points included.

Units are retrieved via maximumScreenErrorUnit().

Added in version 3.26.

Return type:

float

maximumScreenErrorUnit(self) Qgis.RenderUnit[source]

Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.

Added in version 3.26.

Return type:

Qgis.RenderUnit

pointColor(self) QColor[source]

Returns the color used drawing points in elevation profile charts.

See also

setPointColor()

Added in version 3.26.

Return type:

QColor

pointSize(self) float[source]

Returns the point size used for drawing points in elevation profile charts.

The point size units are retrieved by calling pointSizeUnit().

See also

setPointSize()

See also

pointSizeUnit()

Added in version 3.26.

Return type:

float

pointSizeUnit(self) Qgis.RenderUnit[source]

Returns the units used for the point size used for drawing points in elevation profile charts.

See also

pointSize()

Added in version 3.26.

Return type:

Qgis.RenderUnit

pointSymbol(self) Qgis.PointCloudSymbol[source]

Returns the symbol used drawing points in elevation profile charts.

See also

setPointSymbol()

Added in version 3.26.

Return type:

Qgis.PointCloudSymbol

respectLayerColors(self) bool[source]

Returns True if layer coloring should be respected when rendering elevation profile plots.

Return type:

bool

setApplyOpacityByDistanceEffect(self, apply: bool)[source]

Sets whether a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.

Added in version 3.26.

Parameters:

apply (bool)

setMaximumScreenError(self, error: float)[source]

Sets the maximum screen error allowed when generating elevation profiles for the point cloud.

Larger values result in a faster generation with less points included.

Units are set via setMaximumScreenErrorUnit().

Added in version 3.26.

Parameters:

error (float)

setMaximumScreenErrorUnit(self, unit: Qgis.RenderUnit)[source]

Sets the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.

Added in version 3.26.

Parameters:

unit (Qgis.RenderUnit)

setPointColor(self, color: QColor | Qt.GlobalColor)[source]

Sets the color used drawing points in elevation profile charts.

See also

pointColor()

Added in version 3.26.

Parameters:

color (Union[QColor, Qt.GlobalColor])

setPointSize(self, size: float)[source]

Sets the point size used for drawing points in elevation profile charts.

Point size units are specified via setPointSizeUnit().

See also

pointSize()

Added in version 3.26.

Parameters:

size (float)

setPointSizeUnit(self, units: Qgis.RenderUnit)[source]

Sets the units used for the point size used for drawing points in elevation profile charts.

See also

setPointSize()

See also

pointSizeUnit()

Added in version 3.26.

Parameters:

units (Qgis.RenderUnit)

setPointSymbol(self, symbol: Qgis.PointCloudSymbol)[source]

Sets the symbol used drawing points in elevation profile charts.

See also

pointSymbol()

Added in version 3.26.

Parameters:

symbol (Qgis.PointCloudSymbol)

setRespectLayerColors(self, enabled: bool)[source]

Sets whether layer coloring should be respected when rendering elevation profile plots.

Parameters:

enabled (bool)