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 specifiedparent
object.Methods
Returns
True
if a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.- param layer
- rtype
QgsPointCloudLayerElevationProperties
Copies common properties from another object.
- rtype
bool
- rtype
str
- param range
Returns the maximum screen error allowed when generating elevation profiles for the point cloud.
Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.
Returns the color used drawing points in elevation profile charts.
Returns the point size used for drawing points in elevation profile charts.
Returns the units used for the point size used for drawing points in elevation profile charts.
Returns the symbol used drawing points in elevation profile charts.
Reads common class properties from a DOM
element
previously written bywriteXml()
.- param element
Returns
True
if layer coloring should be respected when rendering elevation profile plots.Sets whether a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.
Sets the maximum screen
error
allowed when generating elevation profiles for the point cloud.Sets the
unit
for the maximum screen error allowed when generating elevation profiles for the point cloud.Sets the
color
used drawing points in elevation profile charts.Sets the point
size
used for drawing points in elevation profile charts.Sets the
units
used for the point size used for drawing points in elevation profile charts.Sets the
symbol
used drawing points in elevation profile charts.Sets whether layer coloring should be respected when rendering elevation profile plots.
- rtype
bool
Writes common class properties to a DOM
element
, to be used later withreadXml()
.- 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
New in version 3.26.
- Return type
bool
- calculateZRange(self, layer: QgsMapLayer) QgsDoubleRange ¶
- Parameters
layer (QgsMapLayer) –
- Return type
- childEvent(self, QChildEvent)¶
- clone(self) QgsPointCloudLayerElevationProperties ¶
- Return type
- 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
See also
New in version 3.26.
- Return type
float
- maximumScreenErrorUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.
See also
See also
New in version 3.26.
- Return type
- pointColor(self) QColor ¶
Returns the color used drawing points in elevation profile charts.
See also
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
See also
New in version 3.26.
- Return type
float
- pointSizeUnit(self) QgsUnitTypes.RenderUnit ¶
Returns the units used for the point size used for drawing points in elevation profile charts.
See also
See also
New in version 3.26.
- Return type
- pointSymbol(self) Qgis.PointCloudSymbol ¶
Returns the symbol used drawing points in elevation profile charts.
See also
New in version 3.26.
- Return type
- readCommonProperties(self, element: QDomElement, context: QgsReadWriteContext)¶
Reads common class properties from a DOM
element
previously written bywriteXml()
.See also
New in version 3.26.
- readXml(self, element: QDomElement, context: QgsReadWriteContext) bool ¶
- Parameters
element (QDomElement) –
context (QgsReadWriteContext) –
- 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
- 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
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
See also
New in version 3.26.
- Parameters
error (float) –
- setMaximumScreenErrorUnit(self, unit: QgsUnitTypes.RenderUnit)¶
Sets the
unit
for the maximum screen error allowed when generating elevation profiles for the point cloud.See also
See also
New in version 3.26.
- Parameters
unit (QgsUnitTypes.RenderUnit) –
- setPointColor(self, color: Union[QColor, Qt.GlobalColor, QGradient])¶
Sets the
color
used drawing points in elevation profile charts.See also
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
See also
New in version 3.26.
- Parameters
size (float) –
- setPointSizeUnit(self, units: QgsUnitTypes.RenderUnit)¶
Sets the
units
used for the point size used for drawing points in elevation profile charts.See also
See also
New in version 3.26.
- Parameters
units (QgsUnitTypes.RenderUnit) –
- setPointSymbol(self, symbol: Qgis.PointCloudSymbol)¶
Sets the
symbol
used drawing points in elevation profile charts.See also
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
- 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 withreadXml()
.See also
New in version 3.26.
- writeXml(self, element: QDomElement, doc: QDomDocument, context: QgsReadWriteContext) QDomElement ¶
- Parameters
element (QDomElement) –
doc (QDomDocument) –
context (QgsReadWriteContext) –
- Return type
QDomElement