Abstract base class for storage of elevation profiles which represent a continuous surface (e.g. More...

#include <qgsabstractprofilesurfacegenerator.h>

Inheritance diagram for QgsAbstractProfileSurfaceResults:

[legend]

Public Member Functions
	~QgsAbstractProfileSurfaceResults () override

QVector< QgsGeometry >	asGeometries () const override
	Returns a list of geometries representing the calculated elevation results. More...

void	copyPropertiesFromGenerator (const QgsAbstractProfileGenerator *generator) override
	Copies properties from specified generator to the results object. More...

QMap< double, double >	distanceToHeightMap () const override
	Returns the map of distance (chainage) to height. More...

QVector< QgsProfileIdentifyResults >	identify (const QgsProfilePoint &point, const QgsProfileIdentifyContext &context) override
	Identify results visible at the specified profile point. More...

void	renderResults (QgsProfileRenderContext &context) override
	Renders the results to the specified context. More...

QgsPointSequence	sampledPoints () const override
	Returns a list of sampled points, with their calculated elevation as the point z value. More...

QgsProfileSnapResult	snapPoint (const QgsProfilePoint &point, const QgsProfileSnapContext &context) override
	Snaps a point to the generated elevation profile. More...

QgsDoubleRange	zRange () const override
	Returns the range of the retrieved elevation values. More...

Public Member Functions inherited from QgsAbstractProfileResults
virtual	~QgsAbstractProfileResults ()

virtual QVector< QgsGeometry >	asGeometries () const =0
	Returns a list of geometries representing the calculated elevation results. More...

virtual void	copyPropertiesFromGenerator (const QgsAbstractProfileGenerator *generator)
	Copies properties from specified generator to the results object. More...

virtual QMap< double, double >	distanceToHeightMap () const =0
	Returns the map of distance (chainage) to height. More...

virtual QVector< QgsProfileIdentifyResults >	identify (const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange, const QgsProfileIdentifyContext &context)
	Identify results visible within the specified ranges. More...

virtual QVector< QgsProfileIdentifyResults >	identify (const QgsProfilePoint &point, const QgsProfileIdentifyContext &context)
	Identify results visible at the specified profile point. More...

virtual void	renderResults (QgsProfileRenderContext &context)=0
	Renders the results to the specified context. More...

virtual QgsPointSequence	sampledPoints () const =0
	Returns a list of sampled points, with their calculated elevation as the point z value. More...

virtual QgsProfileSnapResult	snapPoint (const QgsProfilePoint &point, const QgsProfileSnapContext &context)
	Snaps a point to the generated elevation profile. More...

virtual QString	type () const =0
	Returns the unique string identifier for the results type. More...

virtual QgsDoubleRange	zRange () const =0
	Returns the range of the retrieved elevation values. More...

Public Attributes
double	maxZ = std::numeric_limits< double >::lowest()

QMap< double, double >	mDistanceToHeightMap

std::unique_ptr< QgsFillSymbol >	mFillSymbol

double	minZ = std::numeric_limits< double >::max()

std::unique_ptr< QgsLineSymbol >	mLineSymbol

QgsPointSequence	mRawPoints

Qgis::ProfileSurfaceSymbology	symbology = Qgis::ProfileSurfaceSymbology::Line

Detailed Description

Abstract base class for storage of elevation profiles which represent a continuous surface (e.g.

mesh layers and raster layers).

Note: Not available in Python bindings

Since: QGIS 3.26

Definition at line 37 of file qgsabstractprofilesurfacegenerator.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractProfileSurfaceResults()

QgsAbstractProfileSurfaceResults::~QgsAbstractProfileSurfaceResults ( )

overridedefault

Member Function Documentation

◆ asGeometries()

QVector< QgsGeometry > QgsAbstractProfileSurfaceResults::asGeometries ( ) const

overridevirtual

Returns a list of geometries representing the calculated elevation results.

Implements QgsAbstractProfileResults.

Reimplemented in QgsVectorLayerProfileResults.

Definition at line 46 of file qgsabstractprofilesurfacegenerator.cpp.

◆ copyPropertiesFromGenerator()

void QgsAbstractProfileSurfaceResults::copyPropertiesFromGenerator ( const QgsAbstractProfileGenerator * generator )

overridevirtual

Copies properties from specified generator to the results object.

For instance, this method can be used to copy any properties relating to rendering the gathered results to reflect the generator's current properties.

The base class method does nothing.

Reimplemented from QgsAbstractProfileResults.

Reimplemented in QgsVectorLayerProfileResults.

Definition at line 217 of file qgsabstractprofilesurfacegenerator.cpp.

◆ distanceToHeightMap()

QMap< double, double > QgsAbstractProfileSurfaceResults::distanceToHeightMap ( ) const

overridevirtual

Returns the map of distance (chainage) to height.

Implements QgsAbstractProfileResults.

Definition at line 31 of file qgsabstractprofilesurfacegenerator.cpp.

◆ identify()

QVector< QgsProfileIdentifyResults > QgsAbstractProfileSurfaceResults::identify	(	const QgsProfilePoint &	point,
		const QgsProfileIdentifyContext &	context
	)