QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
Abstract base class for objects which generate elevation profiles which represent a continuous surface (e.g. More...
#include <qgsabstractprofilesurfacegenerator.h>
Public Member Functions | |
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 QgsFeedback * | feedback () const =0 |
Access to feedback object of the generator (may be nullptr ) | |
virtual Qgis::ProfileGeneratorFlags | flags () const |
Returns flags which reflect how the profile generator operates. | |
virtual bool | generateProfile (const QgsProfileGenerationContext &context=QgsProfileGenerationContext())=0 |
Generate the profile (based on data stored in the class). | |
virtual QString | sourceId () const =0 |
Returns a unique identifier representing the source of the profile. | |
virtual QgsAbstractProfileResults * | takeResults ()=0 |
Takes results from the generator. | |
Protected Attributes | |
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 |
Friends | |
class | QgsAbstractProfileSurfaceResults |
Abstract base class for objects which generate elevation profiles which represent a continuous surface (e.g.
mesh layers and raster layers).
Definition at line 77 of file qgsabstractprofilesurfacegenerator.h.
QgsAbstractProfileSurfaceGenerator::QgsAbstractProfileSurfaceGenerator | ( | const QgsProfileRequest & | request | ) |
Constructor for QgsAbstractProfileSurfaceGenerator.
Definition at line 381 of file qgsabstractprofilesurfacegenerator.cpp.
|
overridedefault |
double QgsAbstractProfileSurfaceGenerator::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.
By default this is NaN, which indicates that there is no elevation limit.
Definition at line 404 of file qgsabstractprofilesurfacegenerator.cpp.
QgsFillSymbol * QgsAbstractProfileSurfaceGenerator::fillSymbol | ( | ) | const |
Returns the fill symbol to be used for rendering the results.
Definition at line 399 of file qgsabstractprofilesurfacegenerator.cpp.
QgsLineSymbol * QgsAbstractProfileSurfaceGenerator::lineSymbol | ( | ) | const |
Returns the line symbol to be used for rendering the results.
Definition at line 394 of file qgsabstractprofilesurfacegenerator.cpp.
void QgsAbstractProfileSurfaceGenerator::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.
Set to NaN to indicate that there is no elevation limit.
Definition at line 409 of file qgsabstractprofilesurfacegenerator.cpp.
Qgis::ProfileSurfaceSymbology QgsAbstractProfileSurfaceGenerator::symbology | ( | ) | const |
Returns the symbology type for rendering the results.
Definition at line 389 of file qgsabstractprofilesurfacegenerator.cpp.
|
friend |
Definition at line 136 of file qgsabstractprofilesurfacegenerator.h.
|
protected |
Definition at line 132 of file qgsabstractprofilesurfacegenerator.h.
|
protected |
Definition at line 131 of file qgsabstractprofilesurfacegenerator.h.
|
protected |
Definition at line 130 of file qgsabstractprofilesurfacegenerator.h.
|
protected |
Definition at line 134 of file qgsabstractprofilesurfacegenerator.h.
|
protected |
Definition at line 129 of file qgsabstractprofilesurfacegenerator.h.