QgsVectorLayerProfileGenerator Class Reference

Implementation of QgsAbstractProfileGenerator for vector layers. More...

#include <qgsvectorlayerprofilegenerator.h>

Inheritance diagram for QgsVectorLayerProfileGenerator:

Public Member Functions
	QgsVectorLayerProfileGenerator (QgsVectorLayer *layer, const QgsProfileRequest &request)
	Constructor for QgsVectorLayerProfileGenerator.
	~QgsVectorLayerProfileGenerator () override
QgsFeedback *	feedback () const override
	Access to feedback object of the generator (may be nullptr)
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 ()
virtual Qgis::ProfileGeneratorFlags	flags () const
	Returns flags which reflect how the profile generator operates.

Friends
class	QgsVectorLayerProfileResults

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

Note

Not available in Python bindings

Since

QGIS 3.26

Definition at line 104 of file qgsvectorlayerprofilegenerator.h.

Constructor & Destructor Documentation

QgsVectorLayerProfileGenerator()

QgsVectorLayerProfileGenerator::QgsVectorLayerProfileGenerator	(	QgsVectorLayer *	layer,
		const QgsProfileRequest &	request
	)

Constructor for QgsVectorLayerProfileGenerator.

Definition at line 671 of file qgsvectorlayerprofilegenerator.cpp.

~QgsVectorLayerProfileGenerator()

QgsVectorLayerProfileGenerator::~QgsVectorLayerProfileGenerator ( )

overridedefault

Member Function Documentation

feedback()

QgsFeedback * QgsVectorLayerProfileGenerator::feedback ( ) const

overridevirtual

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

Implements QgsAbstractProfileGenerator.

Definition at line 868 of file qgsvectorlayerprofilegenerator.cpp.

generateProfile()

bool QgsVectorLayerProfileGenerator::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 720 of file qgsvectorlayerprofilegenerator.cpp.

sourceId()

QString QgsVectorLayerProfileGenerator::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 713 of file qgsvectorlayerprofilegenerator.cpp.

takeResults()

QgsAbstractProfileResults * QgsVectorLayerProfileGenerator::takeResults ( )

overridevirtual

Takes results from the generator.

Ownership is transferred to the caller.

Implements QgsAbstractProfileGenerator.

Definition at line 863 of file qgsvectorlayerprofilegenerator.cpp.

Friends And Related Symbol Documentation

QgsVectorLayerProfileResults

friend class QgsVectorLayerProfileResults

friend

Definition at line 192 of file qgsvectorlayerprofilegenerator.h.

---

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

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