Point cloud layer specific subclass of QgsMapLayerElevationProperties. More...

#include <qgspointcloudlayerelevationproperties.h>

Inheritance diagram for QgsPointCloudLayerElevationProperties:

[legend]

Public Member Functions
	QgsPointCloudLayerElevationProperties (QObject *parent)
	Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object.
bool	applyOpacityByDistanceEffect () const
	Returns `true` if a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.
QgsDoubleRange	calculateZRange (QgsMapLayer *layer) const override
	Attempts to calculate the overall elevation or z range for the specified layer, using the settings defined by this elevation properties object.
QgsPointCloudLayerElevationProperties *	clone () const override
	Creates a clone of the properties.
double	elevationLimit () const
	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.
bool	hasElevation () const override
	Returns `true` if the layer has an elevation or z component.
QString	htmlSummary () const override
	Returns a HTML formatted summary of the properties.
bool	isVisibleInZRange (const QgsDoubleRange &range, QgsMapLayer *layer=nullptr) const override
	Returns `true` if the layer should be visible and rendered for the specified z range.
double	maximumScreenError () const
	Returns the maximum screen error allowed when generating elevation profiles for the point cloud.
Qgis::RenderUnit	maximumScreenErrorUnit () const
	Returns the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.
QColor	pointColor () const
	Returns the color used drawing points in elevation profile charts.
double	pointSize () const
	Returns the point size used for drawing points in elevation profile charts.
Qgis::RenderUnit	pointSizeUnit () const
	Returns the units used for the point size used for drawing points in elevation profile charts.
Qgis::PointCloudSymbol	pointSymbol () const
	Returns the symbol used drawing points in elevation profile charts.
QgsFillSymbol *	profileFillSymbol () const
	Returns the symbol used to render polygons for the layer in elevation profile plots.
QgsLineSymbol *	profileLineSymbol () const
	Returns the symbol used to render lines for the layer in elevation profile plots.
Qgis::ProfileSurfaceSymbology	profileSymbology () const
	Returns the symbology option used to render the point cloud profile in elevation profile plots.
bool	readXml (const QDomElement &element, const QgsReadWriteContext &context) override
	Reads the elevation properties from a DOM element previously written by writeXml().
bool	respectLayerColors () const
	Returns `true` if layer coloring should be respected when rendering elevation profile plots.
void	setApplyOpacityByDistanceEffect (bool apply)
	Sets whether a reduced opacity by distance from profile curve effect should be applied when drawing points in elevation profile charts.
void	setElevationLimit (double limit)
	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.
void	setMaximumScreenError (double error)
	Sets the maximum screen error allowed when generating elevation profiles for the point cloud.
void	setMaximumScreenErrorUnit (Qgis::RenderUnit unit)
	Sets the unit for the maximum screen error allowed when generating elevation profiles for the point cloud.
void	setPointColor (const QColor &color)
	Sets the color used drawing points in elevation profile charts.
void	setPointSize (double size)
	Sets the point size used for drawing points in elevation profile charts.
void	setPointSizeUnit (const Qgis::RenderUnit units)
	Sets the units used for the point size used for drawing points in elevation profile charts.
void	setPointSymbol (Qgis::PointCloudSymbol symbol)
	Sets the symbol used drawing points in elevation profile charts.
void	setProfileFillSymbol (QgsFillSymbol *symbol)
	Sets the fill symbol used to render polygons for the layer in elevation profile plots.
void	setProfileLineSymbol (QgsLineSymbol *symbol)
	Sets the line symbol used to render lines for the layer in elevation profile plots.
void	setProfileSymbology (Qgis::ProfileSurfaceSymbology symbology)
	Sets the symbology option used to render the point cloud profile in elevation profile plots.
void	setRespectLayerColors (bool enabled)
	Sets whether layer coloring should be respected when rendering elevation profile plots.
void	setType (Qgis::PointCloudProfileType type)
	Sets the profile type used when generating elevation profile plots.
bool	showByDefaultInElevationProfilePlots () const override
	Returns `true` if the layer should be visible by default in newly created elevation profile plots.
QList< double >	significantZValues (QgsMapLayer *layer) const override
	Returns a list of significant elevation/z-values for the specified layer, using the settings defined by this elevation properties object.
Qgis::PointCloudProfileType	type () const
	Returns the profile type used when generating elevation profile plots.
QDomElement	writeXml (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
	Writes the properties to a DOM element, to be used later with readXml().
Public Member Functions inherited from QgsMapLayerElevationProperties
	QgsMapLayerElevationProperties (QObject *parent)
	Constructor for QgsMapLayerElevationProperties, with the specified parent object.
QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the object's property collection, used for data defined overrides.
const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the object's property collection, used for data defined overrides.
virtual QgsMapLayerElevationProperties::Flags	flags () const
	Returns flags associated to the elevation properties.
void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the object's property collection, used for data defined overrides.
virtual void	setDefaultsFromLayer (QgsMapLayer *layer)
	Sets default properties based on sensible choices for the given map layer.
void	setZOffset (double offset)
	Sets the z offset, which is a fixed offset amount which will be added to z values from the layer.
void	setZScale (double scale)
	Sets the z scale, which is a scaling factor which will be applied to z values from the layer.
double	zOffset () const
	Returns the z offset, which is a fixed offset amount which should be added to z values from the layer.
double	zScale () const
	Returns the z scale, which is a scaling factor which should be applied to z values from the layer.

Additional Inherited Members
Public Types inherited from QgsMapLayerElevationProperties
enum	Flag { FlagDontInvalidateCachedRendersWhenRangeChanges = 1 }
	Flags attached to the elevation property. More...
typedef QFlags< Flag >	Flags
enum class	Property : int { ZOffset , ExtrusionHeight , RasterPerBandLowerElevation , RasterPerBandUpperElevation }
	Data definable properties. More...
Signals inherited from QgsMapLayerElevationProperties
void	changed ()
	Emitted when any of the elevation properties have changed.
void	profileGenerationPropertyChanged ()
	Emitted when any of the elevation properties which relate solely to generation of elevation profiles have changed.
void	profileRenderingPropertyChanged ()
	Emitted when any of the elevation properties which relate solely to presentation of elevation results have changed.
void	zOffsetChanged ()
	Emitted when the z offset changes.
void	zScaleChanged ()
	Emitted when the z scale changes.
Static Public Member Functions inherited from QgsMapLayerElevationProperties
static QgsPropertiesDefinition	propertyDefinitions ()
	Returns the definitions for data defined properties available for use in elevation properties.
Protected Member Functions inherited from QgsMapLayerElevationProperties
void	copyCommonProperties (const QgsMapLayerElevationProperties *other)
	Copies common properties from another object.
void	readCommonProperties (const QDomElement &element, const QgsReadWriteContext &context)
	Reads common class properties from a DOM element previously written by writeXml().
void	writeCommonProperties (QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context)
	Writes common class properties to a DOM element, to be used later with readXml().
Protected Attributes inherited from QgsMapLayerElevationProperties
QgsPropertyCollection	mDataDefinedProperties
	Property collection for data defined elevation settings.
double	mZOffset = 0.0
	Z offset.
double	mZScale = 1.0
	Z scale.
Static Protected Attributes inherited from QgsMapLayerElevationProperties
static QgsPropertiesDefinition	sPropertyDefinitions
	Property definitions.

Detailed Description

Point cloud layer specific subclass of QgsMapLayerElevationProperties.

Since: QGIS 3.18

Definition at line 38 of file qgspointcloudlayerelevationproperties.h.

Constructor & Destructor Documentation

◆ QgsPointCloudLayerElevationProperties()

QgsPointCloudLayerElevationProperties::QgsPointCloudLayerElevationProperties ( QObject * parent )

Constructor for QgsPointCloudLayerElevationProperties, with the specified parent object.

Definition at line 37 of file qgspointcloudlayerelevationproperties.cpp.

Member Function Documentation

◆ applyOpacityByDistanceEffect()

bool QgsPointCloudLayerElevationProperties::applyOpacityByDistanceEffect ( ) const

inline

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

Since: QGIS 3.26

Definition at line 147 of file qgspointcloudlayerelevationproperties.h.

◆ calculateZRange()

QgsDoubleRange QgsPointCloudLayerElevationProperties::calculateZRange ( QgsMapLayer * layer ) const

overridevirtual

Attempts to calculate the overall elevation or z range for the specified layer, using the settings defined by this elevation properties object.

May return an infinite range if the extent could not be calculated.

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 245 of file qgspointcloudlayerelevationproperties.cpp.

◆ clone()

QgsPointCloudLayerElevationProperties * QgsPointCloudLayerElevationProperties::clone ( ) const

overridevirtual

Creates a clone of the properties.

Since: QGIS 3.26

Implements QgsMapLayerElevationProperties.

Definition at line 208 of file qgspointcloudlayerelevationproperties.cpp.

◆ elevationLimit()

double QgsPointCloudLayerElevationProperties::elevationLimit ( ) const

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

Since: QGIS 4.0

Definition at line 94 of file qgspointcloudlayerelevationproperties.cpp.

◆ hasElevation()

bool QgsPointCloudLayerElevationProperties::hasElevation ( ) const

overridevirtual

Returns true if the layer has an elevation or z component.

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 124 of file qgspointcloudlayerelevationproperties.cpp.

◆ htmlSummary()

QString QgsPointCloudLayerElevationProperties::htmlSummary ( ) const

overridevirtual

Returns a HTML formatted summary of the properties.

Since: QGIS 3.26

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 231 of file qgspointcloudlayerelevationproperties.cpp.

◆ isVisibleInZRange()

bool QgsPointCloudLayerElevationProperties::isVisibleInZRange	(	const QgsDoubleRange &	range,
		QgsMapLayer *	layer = nullptr ) const

overridevirtual

Returns true if the layer should be visible and rendered for the specified z range.

Since QGIS 3.38 the layer argument can be used to specify the target layer.

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 239 of file qgspointcloudlayerelevationproperties.cpp.

◆ maximumScreenError()

double QgsPointCloudLayerElevationProperties::maximumScreenError ( ) const

inline

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

Since: QGIS 3.26

Definition at line 72 of file qgspointcloudlayerelevationproperties.h.

◆ maximumScreenErrorUnit()

Qgis::RenderUnit QgsPointCloudLayerElevationProperties::maximumScreenErrorUnit ( ) const

inline

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

See also: maximumScreenError(); setMaximumScreenErrorUnit()

Since: QGIS 3.26

Definition at line 96 of file qgspointcloudlayerelevationproperties.h.

◆ pointColor()

QColor QgsPointCloudLayerElevationProperties::pointColor ( ) const

inline

Returns the color used drawing points in elevation profile charts.

See also: setPointColor()

Since: QGIS 3.26

Definition at line 130 of file qgspointcloudlayerelevationproperties.h.

◆ pointSize()

double QgsPointCloudLayerElevationProperties::pointSize ( ) const

inline

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

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

See also: setPointSize(); pointSizeUnit()

Since: QGIS 3.26

Definition at line 179 of file qgspointcloudlayerelevationproperties.h.

◆ pointSizeUnit()

Qgis::RenderUnit QgsPointCloudLayerElevationProperties::pointSizeUnit ( ) const

inline

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

See also: setPointSizeUnit(); pointSize()

Since: QGIS 3.26

Definition at line 198 of file qgspointcloudlayerelevationproperties.h.

◆ pointSymbol()

Qgis::PointCloudSymbol QgsPointCloudLayerElevationProperties::pointSymbol ( ) const

Returns the symbol used drawing points in elevation profile charts.

See also: setPointSymbol()

Since: QGIS 3.26

Definition at line 318 of file qgspointcloudlayerelevationproperties.cpp.

◆ profileFillSymbol()

QgsFillSymbol * QgsPointCloudLayerElevationProperties::profileFillSymbol ( ) const

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

Since: QGIS 4.0

Definition at line 69 of file qgspointcloudlayerelevationproperties.cpp.

◆ profileLineSymbol()

QgsLineSymbol * QgsPointCloudLayerElevationProperties::profileLineSymbol ( ) const

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

Since: QGIS 4.0

Definition at line 54 of file qgspointcloudlayerelevationproperties.cpp.

◆ profileSymbology()

Qgis::ProfileSurfaceSymbology QgsPointCloudLayerElevationProperties::profileSymbology ( ) const

inline

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

Since: QGIS 4.0

Definition at line 282 of file qgspointcloudlayerelevationproperties.h.

◆ readXml()

bool QgsPointCloudLayerElevationProperties::readXml	(	const QDomElement &	element,
		const QgsReadWriteContext &	context )

overridevirtual

Reads the elevation properties from a DOM element previously written by writeXml().

See also: writeXml()

Implements QgsMapLayerElevationProperties.

Definition at line 159 of file qgspointcloudlayerelevationproperties.cpp.

◆ respectLayerColors()

bool QgsPointCloudLayerElevationProperties::respectLayerColors ( ) const

inline

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

See also: setRespectLayerColors()

Definition at line 205 of file qgspointcloudlayerelevationproperties.h.

◆ setApplyOpacityByDistanceEffect()

void QgsPointCloudLayerElevationProperties::setApplyOpacityByDistanceEffect ( bool apply )

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

See also: applyOpacityByDistanceEffect()

Since: QGIS 3.26

Definition at line 343 of file qgspointcloudlayerelevationproperties.cpp.

◆ setElevationLimit()

void QgsPointCloudLayerElevationProperties::setElevationLimit ( double limit )

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

Since: QGIS 4.0

Definition at line 99 of file qgspointcloudlayerelevationproperties.cpp.

◆ setMaximumScreenError()

void QgsPointCloudLayerElevationProperties::setMaximumScreenError ( double error )

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

Since: QGIS 3.26

Definition at line 298 of file qgspointcloudlayerelevationproperties.cpp.

◆ setMaximumScreenErrorUnit()

void QgsPointCloudLayerElevationProperties::setMaximumScreenErrorUnit ( Qgis::RenderUnit unit )

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

See also: setMaximumScreenError(); maximumScreenErrorUnit()

Since: QGIS 3.26

Definition at line 308 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointColor()

void QgsPointCloudLayerElevationProperties::setPointColor ( const QColor & color )

Sets the color used drawing points in elevation profile charts.

See also: pointColor()

Since: QGIS 3.26

Definition at line 333 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointSize()

void QgsPointCloudLayerElevationProperties::setPointSize ( double size )

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

Point size units are specified via setPointSizeUnit().

See also: pointSize(); setPointSizeUnit()

Since: QGIS 3.26

Definition at line 358 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointSizeUnit()

void QgsPointCloudLayerElevationProperties::setPointSizeUnit ( const Qgis::RenderUnit units )

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

See also: setPointSize(); pointSizeUnit()

Since: QGIS 3.26

Definition at line 368 of file qgspointcloudlayerelevationproperties.cpp.

◆ setPointSymbol()

void QgsPointCloudLayerElevationProperties::setPointSymbol ( Qgis::PointCloudSymbol symbol )

Sets the symbol used drawing points in elevation profile charts.

See also: pointSymbol()

Since: QGIS 3.26

Definition at line 323 of file qgspointcloudlayerelevationproperties.cpp.

◆ setProfileFillSymbol()

void QgsPointCloudLayerElevationProperties::setProfileFillSymbol ( QgsFillSymbol * symbol )

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

Ownership of symbol is transferred to the plot.

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

See also: profileFillSymbol()

Since: QGIS 4.0

Definition at line 74 of file qgspointcloudlayerelevationproperties.cpp.

◆ setProfileLineSymbol()

void QgsPointCloudLayerElevationProperties::setProfileLineSymbol ( QgsLineSymbol * symbol )

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

Ownership of symbol is transferred to the plot.

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

See also: profileLineSymbol()

Since: QGIS 4.0

Definition at line 59 of file qgspointcloudlayerelevationproperties.cpp.

◆ setProfileSymbology()

void QgsPointCloudLayerElevationProperties::setProfileSymbology ( Qgis::ProfileSurfaceSymbology symbology )

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

Since: QGIS 4.0

Definition at line 84 of file qgspointcloudlayerelevationproperties.cpp.

◆ setRespectLayerColors()

void QgsPointCloudLayerElevationProperties::setRespectLayerColors ( bool enabled )

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

See also: respectLayerColors()

Definition at line 378 of file qgspointcloudlayerelevationproperties.cpp.

◆ setType()

void QgsPointCloudLayerElevationProperties::setType ( Qgis::PointCloudProfileType type )

inline

Sets the profile type used when generating elevation profile plots.

See also: type()

Since: QGIS 4.0

Definition at line 220 of file qgspointcloudlayerelevationproperties.h.

◆ showByDefaultInElevationProfilePlots()

bool QgsPointCloudLayerElevationProperties::showByDefaultInElevationProfilePlots ( ) const

overridevirtual

Returns true if the layer should be visible by default in newly created elevation profile plots.

Subclasses should override this with logic which determines whether the layer is likely desirable to be initially checked in these plots.

Since: QGIS 3.26

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 293 of file qgspointcloudlayerelevationproperties.cpp.

◆ significantZValues()

QList< double > QgsPointCloudLayerElevationProperties::significantZValues ( QgsMapLayer * layer ) const

overridevirtual

Returns a list of significant elevation/z-values for the specified layer, using the settings defined by this elevation properties object.

These values will be highlighted in elevation related widgets for the layer.

Since: QGIS 3.38

Reimplemented from QgsMapLayerElevationProperties.

Definition at line 282 of file qgspointcloudlayerelevationproperties.cpp.

◆ type()

Qgis::PointCloudProfileType QgsPointCloudLayerElevationProperties::type ( ) const

inline

Returns the profile type used when generating elevation profile plots.

See also: setType()

Since: QGIS 4.0

Definition at line 228 of file qgspointcloudlayerelevationproperties.h.

◆ writeXml()

QDomElement QgsPointCloudLayerElevationProperties::writeXml	(	QDomElement &	element,
		QDomDocument &	doc,
		const QgsReadWriteContext &	context )

overridevirtual

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

See also: readXml()

Implements QgsMapLayerElevationProperties.

Definition at line 129 of file qgspointcloudlayerelevationproperties.cpp.

The documentation for this class was generated from the following files:

/build/qgis-3.99.0+git20260208+357b655ed83+99sid/src/core/pointcloud/qgspointcloudlayerelevationproperties.h
/build/qgis-3.99.0+git20260208+357b655ed83+99sid/src/core/pointcloud/qgspointcloudlayerelevationproperties.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsPointCloudLayerElevationProperties()

Member Function Documentation

◆ applyOpacityByDistanceEffect()

◆ calculateZRange()

◆ clone()

◆ elevationLimit()

◆ hasElevation()

◆ htmlSummary()

◆ isVisibleInZRange()

◆ maximumScreenError()

◆ maximumScreenErrorUnit()

◆ pointColor()

◆ pointSize()

◆ pointSizeUnit()

◆ pointSymbol()

◆ profileFillSymbol()

◆ profileLineSymbol()

◆ profileSymbology()

◆ readXml()

◆ respectLayerColors()

◆ setApplyOpacityByDistanceEffect()

◆ setElevationLimit()

◆ setMaximumScreenError()

◆ setMaximumScreenErrorUnit()

◆ setPointColor()

◆ setPointSize()

◆ setPointSizeUnit()

◆ setPointSymbol()

◆ setProfileFillSymbol()

◆ setProfileLineSymbol()

◆ setProfileSymbology()

◆ setRespectLayerColors()

◆ setType()

◆ showByDefaultInElevationProfilePlots()

◆ significantZValues()

◆ type()

◆ writeXml()