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. 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... | |
 Public Member Functions inherited from QgsAbstractProfileGenerator | |
| 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... | |
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 |
Detailed Description
Abstract base class for objects which generate elevation profiles which represent a continuous surface (e.g.
mesh layers and raster layers).
- Note
- Not available in Python bindings
- Since
- QGIS 3.26
Definition at line 77 of file qgsabstractprofilesurfacegenerator.h.
Constructor & Destructor Documentation
◆ QgsAbstractProfileSurfaceGenerator()
| QgsAbstractProfileSurfaceGenerator::QgsAbstractProfileSurfaceGenerator | ( | const QgsProfileRequest & | request | ) |
Constructor for QgsAbstractProfileSurfaceGenerator.
Definition at line 381 of file qgsabstractprofilesurfacegenerator.cpp.
◆ ~QgsAbstractProfileSurfaceGenerator()
|
overridedefault |
Member Function Documentation
◆ elevationLimit()
| 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.
- See also
- setElevationLimit()
- Since
- QGIS 3.32
Definition at line 404 of file qgsabstractprofilesurfacegenerator.cpp.
◆ fillSymbol()
| QgsFillSymbol * QgsAbstractProfileSurfaceGenerator::fillSymbol | ( | ) | const |
Returns the fill symbol to be used for rendering the results.
Definition at line 399 of file qgsabstractprofilesurfacegenerator.cpp.
◆ lineSymbol()
| QgsLineSymbol * QgsAbstractProfileSurfaceGenerator::lineSymbol | ( | ) | const |
Returns the line symbol to be used for rendering the results.
Definition at line 394 of file qgsabstractprofilesurfacegenerator.cpp.
◆ setElevationLimit()
| 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.
- See also
- elevationLimit()
- Since
- QGIS 3.32
Definition at line 409 of file qgsabstractprofilesurfacegenerator.cpp.
◆ symbology()
| Qgis::ProfileSurfaceSymbology QgsAbstractProfileSurfaceGenerator::symbology | ( | ) | const |
Returns the symbology type for rendering the results.
Definition at line 389 of file qgsabstractprofilesurfacegenerator.cpp.
Friends And Related Function Documentation
◆ QgsAbstractProfileSurfaceResults
|
friend |
Definition at line 136 of file qgsabstractprofilesurfacegenerator.h.
Member Data Documentation
◆ mElevationLimit
|
protected |
Definition at line 132 of file qgsabstractprofilesurfacegenerator.h.
◆ mFillSymbol
|
protected |
Definition at line 131 of file qgsabstractprofilesurfacegenerator.h.
◆ mLineSymbol
|
protected |
Definition at line 130 of file qgsabstractprofilesurfacegenerator.h.
◆ mProfileCurve
|
protected |
Definition at line 134 of file qgsabstractprofilesurfacegenerator.h.
◆ mSymbology
|
protected |
Definition at line 129 of file qgsabstractprofilesurfacegenerator.h.
The documentation for this class was generated from the following files:
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/elevation/qgsabstractprofilesurfacegenerator.h
- /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/core/elevation/qgsabstractprofilesurfacegenerator.cpp
