QGIS API Documentation  3.27.0-Master (11ef3e5184)
Public Member Functions | Protected Attributes | List of all members
QgsAbstractProfileSurfaceGenerator Class Reference

Abstract base class for objects which generate elevation profiles which represent a continuous surface (e.g. More...

#include <qgsabstractprofilesurfacegenerator.h>

Inheritance diagram for QgsAbstractProfileSurfaceGenerator:
Inheritance graph
[legend]

Public Member Functions

 ~QgsAbstractProfileSurfaceGenerator () override
 
QgsFillSymbolfillSymbol () const
 Returns the fill symbol to be used for rendering the results. More...
 
QgsLineSymbollineSymbol () const
 Returns the line symbol to be used for rendering the results. More...
 
Qgis::ProfileSurfaceSymbology symbology () const
 Returns the symbology type for rendering the results. More...
 
- Public Member Functions inherited from QgsAbstractProfileGenerator
virtual ~QgsAbstractProfileGenerator ()
 
virtual QgsFeedbackfeedback () 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 QgsAbstractProfileResultstakeResults ()=0
 Takes results from the generator. More...
 

Protected Attributes

std::unique_ptr< QgsFillSymbolmFillSymbol
 
std::unique_ptr< QgsLineSymbolmLineSymbol
 
Qgis::ProfileSurfaceSymbology mSymbology = Qgis::ProfileSurfaceSymbology::Line
 

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 69 of file qgsabstractprofilesurfacegenerator.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractProfileSurfaceGenerator()

QgsAbstractProfileSurfaceGenerator::~QgsAbstractProfileSurfaceGenerator ( )
overridedefault

Member Function Documentation

◆ fillSymbol()

QgsFillSymbol * QgsAbstractProfileSurfaceGenerator::fillSymbol ( ) const

Returns the fill symbol to be used for rendering the results.

Definition at line 242 of file qgsabstractprofilesurfacegenerator.cpp.

◆ lineSymbol()

QgsLineSymbol * QgsAbstractProfileSurfaceGenerator::lineSymbol ( ) const

Returns the line symbol to be used for rendering the results.

Definition at line 237 of file qgsabstractprofilesurfacegenerator.cpp.

◆ symbology()

Qgis::ProfileSurfaceSymbology QgsAbstractProfileSurfaceGenerator::symbology ( ) const

Returns the symbology type for rendering the results.

Definition at line 232 of file qgsabstractprofilesurfacegenerator.cpp.

Member Data Documentation

◆ mFillSymbol

std::unique_ptr< QgsFillSymbol > QgsAbstractProfileSurfaceGenerator::mFillSymbol
protected

Definition at line 94 of file qgsabstractprofilesurfacegenerator.h.

◆ mLineSymbol

std::unique_ptr< QgsLineSymbol > QgsAbstractProfileSurfaceGenerator::mLineSymbol
protected

Definition at line 93 of file qgsabstractprofilesurfacegenerator.h.

◆ mSymbology

Qgis::ProfileSurfaceSymbology QgsAbstractProfileSurfaceGenerator::mSymbology = Qgis::ProfileSurfaceSymbology::Line
protected

Definition at line 92 of file qgsabstractprofilesurfacegenerator.h.


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