Class: QgsPointCloudLayerElevationProperties

class qgis.core.QgsPointCloudLayerElevationProperties

Bases: QgsMapLayerElevationProperties

Point cloud layer specific subclass of QgsMapLayerElevationProperties.

New in version 3.18.

QgsPointCloudLayerElevationProperties(parent: QObject) Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object.

Methods

applyOpacityByDistanceEffect

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

calculateZRange

param layer:

childEvent

clone

rtype:

QgsPointCloudLayerElevationProperties

connectNotify

copyCommonProperties

Copies common properties from another object.

customEvent

disconnectNotify

hasElevation

rtype:

bool

htmlSummary

rtype:

str

isSignalConnected

isVisibleInZRange

param range:

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.

readCommonProperties

Reads common class properties from a DOM element previously written by writeXml().

readXml

param element:

receivers

respectLayerColors

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

sender

senderSignalIndex

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.

showByDefaultInElevationProfilePlots

rtype:

bool

timerEvent

writeCommonProperties

Writes common class properties to a DOM element, to be used later with readXml().

writeXml

param element:
applyOpacityByDistanceEffect(self) → bool

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

See also

setApplyOpacityByDistanceEffect()

New in version 3.26.

Return type:

bool

calculateZRange(self, layer: QgsMapLayer) → QgsDoubleRange
Parameters:

layer (QgsMapLayer) –

Return type:

QgsDoubleRange

childEvent(self, QChildEvent)
clone(self) → QgsPointCloudLayerElevationProperties
Return type:

QgsPointCloudLayerElevationProperties

connectNotify(self, QMetaMethod)
copyCommonProperties(self, other: QgsMapLayerElevationProperties)

Copies common properties from another object.

New in version 3.26.

customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
hasElevation(self) → bool
Return type:

bool

htmlSummary(self) → str
Return type:

str

isSignalConnected(self, QMetaMethod) → bool
isVisibleInZRange(self, range: QgsDoubleRange) → bool
Parameters:

range (QgsDoubleRange) –

Return type:

bool

maximumScreenError(self) → float

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().

See also

setMaximumScreenError()

See also

maximumScreenErrorUnit()

New in version 3.26.

Return type:

float

maximumScreenErrorUnit(self) → Qgis.RenderUnit

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

See also

maximumScreenError()

See also

setMaximumScreenErrorUnit()

New in version 3.26.

Return type:

Qgis.RenderUnit

pointColor(self) → QColor

Returns the color used drawing points in elevation profile charts.

See also

setPointColor()

New in version 3.26.

Return type:

QColor

pointSize(self) → float

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()

New in version 3.26.

Return type:

float

pointSizeUnit(self) → Qgis.RenderUnit

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

See also

setPointSizeUnit()

See also

pointSize()

New in version 3.26.

Return type:

Qgis.RenderUnit

pointSymbol(self) → Qgis.PointCloudSymbol

Returns the symbol used drawing points in elevation profile charts.

See also

setPointSymbol()

New in version 3.26.

Return type:

Qgis.PointCloudSymbol

readCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)

Reads common class properties from a DOM element previously written by writeXml().

See also

writeCommonProperties()

New in version 3.26.

readXml(self, element: QDomElement, context: QgsReadWriteContext) → bool
Parameters:
Return type:

bool

receivers(self, PYQT_SIGNAL) → int
respectLayerColors(self) → bool

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

See also

setRespectLayerColors()

Return type:

bool

sender(self) → QObject
senderSignalIndex(self) → int
setApplyOpacityByDistanceEffect(self, apply: bool)

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

See also

applyOpacityByDistanceEffect()

New in version 3.26.

Parameters:

apply (bool) –

setMaximumScreenError(self, error: float)

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().

See also

maximumScreenError()

See also

setMaximumScreenErrorUnit()

New in version 3.26.

Parameters:

error (float) –

setMaximumScreenErrorUnit(self, unit: Qgis.RenderUnit)

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

See also

setMaximumScreenError()

See also

maximumScreenErrorUnit()

New in version 3.26.

Parameters:

unit (Qgis.RenderUnit) –

setPointColor(self, color: QColor | Qt.GlobalColor | QGradient)

Sets the color used drawing points in elevation profile charts.

See also

pointColor()

New in version 3.26.

Parameters:

color (Union[QColor) –

setPointSize(self, size: float)

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

Point size units are specified via setPointSizeUnit().

See also

pointSize()

See also

setPointSizeUnit()

New in version 3.26.

Parameters:

size (float) –

setPointSizeUnit(self, units: Qgis.RenderUnit)

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

See also

setPointSize()

See also

pointSizeUnit()

New in version 3.26.

Parameters:

units (Qgis.RenderUnit) –

setPointSymbol(self, symbol: Qgis.PointCloudSymbol)

Sets the symbol used drawing points in elevation profile charts.

See also

pointSymbol()

New in version 3.26.

Parameters:

symbol (Qgis.PointCloudSymbol) –

setRespectLayerColors(self, enabled: bool)

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

See also

respectLayerColors()

Parameters:

enabled (bool) –

showByDefaultInElevationProfilePlots(self) → bool
Return type:

bool

timerEvent(self, QTimerEvent)
writeCommonProperties(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext)

Writes common class properties to a DOM element, to be used later with readXml().

See also

readCommonProperties()

New in version 3.26.

writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement
Parameters:
Return type:

QDomElement