Implementation of QgsAbstractProfileResults for vector layers. More...

#include <qgsvectorlayerprofilegenerator.h>

Inheritance diagram for QgsVectorLayerProfileResults:

Classes
struct	Feature

Public Member Functions
QVector< QgsAbstractProfileResults::Feature >	asFeatures (Qgis::ProfileExportType type, QgsFeedback *feedback=nullptr) const override
	Returns a list of features representing the calculated elevation results. More...

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

QVector< QgsProfileIdentifyResults >	identify (const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange, const QgsProfileIdentifyContext &context) override
	Identify results visible within the specified ranges. 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...

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

QString	type () const override
	Returns the unique string identifier for the results type. More...

Public Member Functions inherited from QgsAbstractProfileSurfaceResults
	~QgsAbstractProfileSurfaceResults () override

QVector< QgsAbstractProfileResults::Feature >	asFeatures (Qgis::ProfileExportType type, QgsFeedback *feedback=nullptr) const override
	Returns a list of features representing the calculated elevation results. More...

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< QgsAbstractProfileResults::Feature >	asFeatures (Qgis::ProfileExportType type, QgsFeedback *feedback=nullptr) const
	Returns a list of features representing the calculated elevation results. More...

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
QHash< QgsFeatureId, QVector< Feature > >	features

QPointer< QgsVectorLayer >	mLayer

std::unique_ptr< QgsMarkerSymbol >	mMarkerSymbol

bool	mShowMarkerSymbolInSurfacePlots = false

Qgis::VectorProfileType	profileType = Qgis::VectorProfileType::IndividualFeatures

bool	respectLayerSymbology = true

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

QMap< double, double >	mDistanceToHeightMap

double	mElevationLimit = std::numeric_limits< double >::quiet_NaN()

std::unique_ptr< QgsFillSymbol >	mFillSymbol

QString	mId

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

std::unique_ptr< QgsLineSymbol >	mLineSymbol

std::unique_ptr< QgsCurve >	mProfileCurve

QgsPointSequence	mRawPoints

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

Detailed Description

Implementation of QgsAbstractProfileResults for vector layers.

Note: Not available in Python bindings

Since: QGIS 3.26

Definition at line 53 of file qgsvectorlayerprofilegenerator.h.

Member Function Documentation

◆ asFeatures()

QVector< QgsAbstractProfileResults::Feature > QgsVectorLayerProfileResults::asFeatures	(	Qgis::ProfileExportType	type,
		QgsFeedback *	feedback = `nullptr`
	)		const

overridevirtual

Returns a list of features representing the calculated elevation results.

The default implementation returns an empty list.

Since: QGIS 3.32

Reimplemented from QgsAbstractProfileSurfaceResults.

Definition at line 63 of file qgsvectorlayerprofilegenerator.cpp.

◆ asGeometries()

QVector< QgsGeometry > QgsVectorLayerProfileResults::asGeometries ( ) const

overridevirtual

Returns a list of geometries representing the calculated elevation results.

Reimplemented from QgsAbstractProfileSurfaceResults.

Definition at line 49 of file qgsvectorlayerprofilegenerator.cpp.

◆ copyPropertiesFromGenerator()

void QgsVectorLayerProfileResults::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 QgsAbstractProfileSurfaceResults.

Definition at line 653 of file qgsvectorlayerprofilegenerator.cpp.

◆ identify() [1/2]

QVector< QgsProfileIdentifyResults > QgsVectorLayerProfileResults::identify	(	const QgsDoubleRange &	distanceRange,
		const QgsDoubleRange &	elevationRange,
		const QgsProfileIdentifyContext &	context
	)

overridevirtual

Identify results visible within the specified ranges.

Reimplemented from QgsAbstractProfileResults.

Definition at line 92 of file qgsvectorlayerprofilegenerator.cpp.

◆ identify() [2/2]

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

overridevirtual

Identify results visible at the specified profile point.

Reimplemented from QgsAbstractProfileSurfaceResults.

Definition at line 111 of file qgsvectorlayerprofilegenerator.cpp.

◆ renderResults()

void QgsVectorLayerProfileResults::renderResults ( QgsProfileRenderContext & context )

overridevirtual

Renders the results to the specified context.

Reimplemented from QgsAbstractProfileSurfaceResults.

Definition at line 387 of file qgsvectorlayerprofilegenerator.cpp.

◆ snapPoint()

QgsProfileSnapResult QgsVectorLayerProfileResults::snapPoint	(	const QgsProfilePoint &	point,
		const QgsProfileSnapContext &	context
	)

overridevirtual

Snaps a point to the generated elevation profile.

Reimplemented from QgsAbstractProfileSurfaceResults.

Definition at line 79 of file qgsvectorlayerprofilegenerator.cpp.

◆ type()

QString QgsVectorLayerProfileResults::type ( ) const

overridevirtual

Returns the unique string identifier for the results type.

Implements QgsAbstractProfileResults.

Definition at line 44 of file qgsvectorlayerprofilegenerator.cpp.

Member Data Documentation

◆ features

QHash< QgsFeatureId, QVector< Feature > > QgsVectorLayerProfileResults::features

Definition at line 67 of file qgsvectorlayerprofilegenerator.h.

◆ mLayer

QPointer< QgsVectorLayer > QgsVectorLayerProfileResults::mLayer

Definition at line 68 of file qgsvectorlayerprofilegenerator.h.

◆ mMarkerSymbol

std::unique_ptr< QgsMarkerSymbol > QgsVectorLayerProfileResults::mMarkerSymbol

Definition at line 72 of file qgsvectorlayerprofilegenerator.h.

◆ mShowMarkerSymbolInSurfacePlots

bool QgsVectorLayerProfileResults::mShowMarkerSymbolInSurfacePlots = false

Definition at line 73 of file qgsvectorlayerprofilegenerator.h.

◆ profileType

Qgis::VectorProfileType QgsVectorLayerProfileResults::profileType = Qgis::VectorProfileType::IndividualFeatures

Definition at line 70 of file qgsvectorlayerprofilegenerator.h.

◆ respectLayerSymbology

bool QgsVectorLayerProfileResults::respectLayerSymbology = true

Definition at line 71 of file qgsvectorlayerprofilegenerator.h.

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

/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/vector/qgsvectorlayerprofilegenerator.h
/build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/vector/qgsvectorlayerprofilegenerator.cpp

Classes

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ asFeatures()

◆ asGeometries()

◆ copyPropertiesFromGenerator()

◆ identify() [1/2]

◆ identify() [2/2]

◆ renderResults()

◆ snapPoint()

◆ type()

Member Data Documentation

◆ features

◆ mLayer

◆ mMarkerSymbol

◆ mShowMarkerSymbolInSurfacePlots

◆ profileType

◆ respectLayerSymbology