QGIS API Documentation 3.31.0-Master (9f23a2c1dc)
|
Implementation of QgsAbstractProfileGenerator for raster layers. More...
#include <qgsrasterlayerprofilegenerator.h>
Public Member Functions | |
QgsRasterLayerProfileGenerator (QgsRasterLayer *layer, const QgsProfileRequest &request) | |
Constructor for QgsRasterLayerProfileGenerator. More... | |
~QgsRasterLayerProfileGenerator () override | |
QgsFeedback * | feedback () const override |
Access to feedback object of the generator (may be nullptr ) More... | |
Qgis::ProfileGeneratorFlags | flags () const override |
Returns flags which reflect how the profile generator operates. More... | |
bool | generateProfile (const QgsProfileGenerationContext &context=QgsProfileGenerationContext()) override |
Generate the profile (based on data stored in the class). More... | |
QString | sourceId () const override |
Returns a unique identifier representing the source of the profile. More... | |
QgsAbstractProfileResults * | takeResults () override |
Takes results from the generator. More... | |
![]() | |
~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. More... | |
QgsFillSymbol * | fillSymbol () const |
Returns the fill symbol to be used for rendering the results. More... | |
QgsLineSymbol * | lineSymbol () const |
Returns the line symbol to be used for rendering the results. More... | |
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. More... | |
Qgis::ProfileSurfaceSymbology | symbology () const |
Returns the symbology type for rendering the results. More... | |
![]() | |
virtual | ~QgsAbstractProfileGenerator () |
virtual QgsFeedback * | feedback () const =0 |
Access to feedback object of the generator (may be nullptr ) More... | |
virtual Qgis::ProfileGeneratorFlags | flags () const |
Returns flags which reflect how the profile generator operates. More... | |
virtual bool | generateProfile (const QgsProfileGenerationContext &context=QgsProfileGenerationContext())=0 |
Generate the profile (based on data stored in the class). More... | |
virtual QString | sourceId () const =0 |
Returns a unique identifier representing the source of the profile. More... | |
virtual QgsAbstractProfileResults * | takeResults ()=0 |
Takes results from the generator. More... | |
Friends | |
class | QgsRasterLayerProfileResults |
Additional Inherited Members | |
![]() | |
double | mElevationLimit = std::numeric_limits< double >::quiet_NaN() |
std::unique_ptr< QgsFillSymbol > | mFillSymbol |
std::unique_ptr< QgsLineSymbol > | mLineSymbol |
Qgis::ProfileSurfaceSymbology | mSymbology = Qgis::ProfileSurfaceSymbology::Line |
Implementation of QgsAbstractProfileGenerator for raster layers.
Definition at line 67 of file qgsrasterlayerprofilegenerator.h.
QgsRasterLayerProfileGenerator::QgsRasterLayerProfileGenerator | ( | QgsRasterLayer * | layer, |
const QgsProfileRequest & | request | ||
) |
Constructor for QgsRasterLayerProfileGenerator.
Definition at line 61 of file qgsrasterlayerprofilegenerator.cpp.
|
overridedefault |
|
overridevirtual |
Access to feedback object of the generator (may be nullptr
)
Implements QgsAbstractProfileGenerator.
Definition at line 374 of file qgsrasterlayerprofilegenerator.cpp.
|
overridevirtual |
Returns flags which reflect how the profile generator operates.
Reimplemented from QgsAbstractProfileGenerator.
Definition at line 89 of file qgsrasterlayerprofilegenerator.cpp.
|
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 96 of file qgsrasterlayerprofilegenerator.cpp.
|
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 84 of file qgsrasterlayerprofilegenerator.cpp.
|
overridevirtual |
Takes results from the generator.
Ownership is transferred to the caller.
Implements QgsAbstractProfileGenerator.
Definition at line 369 of file qgsrasterlayerprofilegenerator.cpp.
|
friend |
Definition at line 109 of file qgsrasterlayerprofilegenerator.h.