Class: QgsPointCloudLayerElevationProperties¶

Point cloud layer specific subclass of QgsMapLayerElevationProperties.

Added in version 3.18.

List of all members, including inherited members

Class Hierarchy¶

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.
`elevationLimit`	Returns the elevation limit, which is used when `profileSymbology()` is `Qgis`.ProfileSurfaceSymbology.FillBelow or `Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation 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.
`profileFillSymbol`	Returns the symbol used to render polygons for the layer in elevation profile plots.
`profileLineSymbol`	Returns the symbol used to render lines for the layer in elevation profile plots.
`profileSymbology`	Returns the symbology option used to render the point cloud profile in elevation profile plots.
`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.
`setElevationLimit`	Sets the elevation limit, which is used when `profileSymbology()` is `Qgis`.ProfileSurfaceSymbology.FillBelow or `Qgis`.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.
`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.
`setProfileFillSymbol`	Sets the fill symbol used to render polygons for the layer in elevation profile plots.
`setProfileLineSymbol`	Sets the line symbol used to render lines for the layer in elevation profile plots.
`setProfileSymbology`	Sets the symbology option used to render the point cloud profile in elevation profile plots.
`setRespectLayerColors`	Sets whether layer coloring should be respected when rendering elevation profile plots.
`setType`	Sets the profile type used when generating elevation profile plots.
`type`	Returns the profile type used when generating 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.

See also

setApplyOpacityByDistanceEffect()

Added in version 3.26.

Return type:: bool

elevationLimit(self) → float[source]¶

Returns the elevation limit, which is used when profileSymbology() is Qgis.ProfileSurfaceSymbology.FillBelow or Qgis.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.

By default this is NaN, which indicates that there is no elevation limit.

Note

This setting is only used when type() is Qgis.PointCloudProfileType.TriangulatedSurface.

See also

setElevationLimit()

Added in version 4.0.

Return type:: float

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

See also

setMaximumScreenError()

See also

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.

See also

maximumScreenError()

See also

setMaximumScreenErrorUnit()

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

setPointSizeUnit()

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

profileFillSymbol(self) → QgsFillSymbol | None[source]¶

Returns the symbol used to render polygons for the layer in elevation profile plots.

Note

This setting is only used when type() is Qgis.PointCloudProfileType.TriangulatedSurface.

See also

setProfileFillSymbol()

Added in version 4.0.

Return type:: Optional[QgsFillSymbol]

profileLineSymbol(self) → QgsLineSymbol | None[source]¶

Returns the symbol used to render lines for the layer in elevation profile plots.

Note

This setting is only used when type() is Qgis.PointCloudProfileType.TriangulatedSurface.

See also

setProfileLineSymbol()

Added in version 4.0.

Return type:: Optional[QgsLineSymbol]

profileSymbology(self) → Qgis.ProfileSurfaceSymbology[source]¶

Returns the symbology option used to render the point cloud profile in elevation profile plots.

Note

This setting is only used when type() is Qgis.PointCloudProfileType.TriangulatedSurface.

See also

setProfileSymbology()

Added in version 4.0.

Return type:: Qgis.ProfileSurfaceSymbology

respectLayerColors(self) → bool[source]¶

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

See also

setRespectLayerColors()

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.

See also

applyOpacityByDistanceEffect()

Added in version 3.26.

Parameters:: apply (bool)

setElevationLimit(self, limit: float)[source]¶

Sets the elevation limit, which is used when profileSymbology() is Qgis.ProfileSurfaceSymbology.FillBelow or Qgis.ProfileSurfaceSymbology.FillAbove to limit the fill to a specific elevation range.

Set to NaN to indicate that there is no elevation limit.

Note

This setting is only used when type() is Qgis.PointCloudProfileType.TriangulatedSurface.

See also

elevationLimit()

Added in version 4.0.