QgsRasterLayerProfileGenerator Class Reference

Implementation of QgsAbstractProfileGenerator for raster layers. More...

#include <qgsrasterlayerprofilegenerator.h>

Inheritance diagram for QgsRasterLayerProfileGenerator:

Public Member Functions
	QgsRasterLayerProfileGenerator (QgsRasterLayer *layer, const QgsProfileRequest &request)
	Constructor for QgsRasterLayerProfileGenerator.
	~QgsRasterLayerProfileGenerator () override
QgsFeedback *	feedback () const override
	Access to feedback object of the generator (may be nullptr)
Qgis::ProfileGeneratorFlags	flags () const override
	Returns flags which reflect how the profile generator operates.
bool	generateProfile (const QgsProfileGenerationContext &context=QgsProfileGenerationContext()) override
	Generate the profile (based on data stored in the class).
QString	sourceId () const override
	Returns a unique identifier representing the source of the profile.
QgsAbstractProfileResults *	takeResults () override
	Takes results from the generator.
Public Member Functions inherited from QgsAbstractProfileSurfaceGenerator
	QgsAbstractProfileSurfaceGenerator (const QgsProfileRequest &request)
	Constructor for QgsAbstractProfileSurfaceGenerator.
	~QgsAbstractProfileSurfaceGenerator () override
double	elevationLimit () const
	Returns the elevation limit, which is used when symbology() is Qgis::ProfileSurfaceSymbology::FillBelow or Qgis::ProfileSurfaceSymbology::FillAbove to limit the fill to a specific elevation range.
QgsFillSymbol *	fillSymbol () const
	Returns the fill symbol to be used for rendering the results.
QgsLineSymbol *	lineSymbol () const
	Returns the line symbol to be used for rendering the results.
void	setElevationLimit (double limit)
	Sets the elevation limit, which is used when symbology() is Qgis::ProfileSurfaceSymbology::FillBelow or Qgis::ProfileSurfaceSymbology::FillAbove to limit the fill to a specific elevation range.
Qgis::ProfileSurfaceSymbology	symbology () const
	Returns the symbology type for rendering the results.
Public Member Functions inherited from QgsAbstractProfileGenerator
virtual	~QgsAbstractProfileGenerator ()

Friends
class	QgsRasterLayerProfileResults

Additional Inherited Members
Protected Attributes inherited from QgsAbstractProfileSurfaceGenerator
double	mElevationLimit = std::numeric_limits< double >::quiet_NaN()
std::unique_ptr< QgsFillSymbol >	mFillSymbol
std::unique_ptr< QgsLineSymbol >	mLineSymbol
std::unique_ptr< QgsCurve >	mProfileCurve
Qgis::ProfileSurfaceSymbology	mSymbology = Qgis::ProfileSurfaceSymbology::Line

Detailed Description

Implementation of QgsAbstractProfileGenerator for raster layers.

Note

Not available in Python bindings

Since

QGIS 3.26

Definition at line 67 of file qgsrasterlayerprofilegenerator.h.

Constructor & Destructor Documentation

QgsRasterLayerProfileGenerator()

QgsRasterLayerProfileGenerator::QgsRasterLayerProfileGenerator	(	QgsRasterLayer *	layer,
		const QgsProfileRequest &	request
	)

Constructor for QgsRasterLayerProfileGenerator.

Definition at line 62 of file qgsrasterlayerprofilegenerator.cpp.

~QgsRasterLayerProfileGenerator()

QgsRasterLayerProfileGenerator::~QgsRasterLayerProfileGenerator ( )

overridedefault

Member Function Documentation

feedback()

QgsFeedback * QgsRasterLayerProfileGenerator::feedback ( ) const

overridevirtual

Access to feedback object of the generator (may be nullptr)

Implements QgsAbstractProfileGenerator.

Definition at line 380 of file qgsrasterlayerprofilegenerator.cpp.

flags()

Qgis::ProfileGeneratorFlags QgsRasterLayerProfileGenerator::flags ( ) const

overridevirtual

Returns flags which reflect how the profile generator operates.

Reimplemented from QgsAbstractProfileGenerator.

Definition at line 92 of file qgsrasterlayerprofilegenerator.cpp.

generateProfile()

bool QgsRasterLayerProfileGenerator::generateProfile ( const QgsProfileGenerationContext &  context = QgsProfileGenerationContext() )

overridevirtual

Generate the profile (based on data stored in the class).

Returns true if the profile was generated successfully (i.e. the generation was not canceled early).

Implements QgsAbstractProfileGenerator.

Definition at line 99 of file qgsrasterlayerprofilegenerator.cpp.

sourceId()

QString QgsRasterLayerProfileGenerator::sourceId ( ) const

overridevirtual

Returns a unique identifier representing the source of the profile.

For generators associated with a map layer the source ID will match the layer's QgsMapLayer::id(). Other (non-map-layer) sources will have a different unique ID with its own custom interpretation.gen

Implements QgsAbstractProfileGenerator.

Definition at line 87 of file qgsrasterlayerprofilegenerator.cpp.

takeResults()

QgsAbstractProfileResults * QgsRasterLayerProfileGenerator::takeResults ( )

overridevirtual

Takes results from the generator.

Ownership is transferred to the caller.

Implements QgsAbstractProfileGenerator.

Definition at line 375 of file qgsrasterlayerprofilegenerator.cpp.

Friends And Related Symbol Documentation

QgsRasterLayerProfileResults

friend class QgsRasterLayerProfileResults

friend

Definition at line 109 of file qgsrasterlayerprofilegenerator.h.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/raster/qgsrasterlayerprofilegenerator.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/raster/qgsrasterlayerprofilegenerator.cpp