QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Public Attributes | List of all members
QgsAbstractProfileSurfaceResults Class Reference

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

#include <qgsabstractprofilesurfacegenerator.h>

Inheritance diagram for QgsAbstractProfileSurfaceResults:
Inheritance graph
[legend]

Public Member Functions

 ~QgsAbstractProfileSurfaceResults () override
 
QVector< QgsAbstractProfileResults::FeatureasFeatures (Qgis::ProfileExportType type, QgsFeedback *feedback=nullptr) const override
 Returns a list of features representing the calculated elevation results. More...
 
QVector< QgsGeometryasGeometries () const override
 Returns a list of geometries representing the calculated elevation results. More...
 
void copyPropertiesFromGenerator (const QgsAbstractProfileGenerator *generator) override
 Copies properties from specified generator to the results object. More...
 
QMap< double, double > distanceToHeightMap () const override
 Returns the map of distance (chainage) to height. More...
 
QVector< QgsProfileIdentifyResultsidentify (const QgsProfilePoint &point, const QgsProfileIdentifyContext &context) override
 Identify results visible at the specified profile point. More...
 
void renderResults (QgsProfileRenderContext &context) override
 Renders the results to the specified context. More...
 
QgsPointSequence sampledPoints () const override
 Returns a list of sampled points, with their calculated elevation as the point z value. More...
 
QgsProfileSnapResult snapPoint (const QgsProfilePoint &point, const QgsProfileSnapContext &context) override
 Snaps a point to the generated elevation profile. More...
 
QgsDoubleRange zRange () const override
 Returns the range of the retrieved elevation values. More...
 
- Public Member Functions inherited from QgsAbstractProfileResults
virtual ~QgsAbstractProfileResults ()
 
virtual QVector< QgsAbstractProfileResults::FeatureasFeatures (Qgis::ProfileExportType type, QgsFeedback *feedback=nullptr) const
 Returns a list of features representing the calculated elevation results. More...
 
virtual QVector< QgsGeometryasGeometries () const =0
 Returns a list of geometries representing the calculated elevation results. More...
 
virtual void copyPropertiesFromGenerator (const QgsAbstractProfileGenerator *generator)
 Copies properties from specified generator to the results object. More...
 
virtual QMap< double, double > distanceToHeightMap () const =0
 Returns the map of distance (chainage) to height. More...
 
virtual QVector< QgsProfileIdentifyResultsidentify (const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange, const QgsProfileIdentifyContext &context)
 Identify results visible within the specified ranges. More...
 
virtual QVector< QgsProfileIdentifyResultsidentify (const QgsProfilePoint &point, const QgsProfileIdentifyContext &context)
 Identify results visible at the specified profile point. More...
 
virtual void renderResults (QgsProfileRenderContext &context)=0
 Renders the results to the specified context. More...
 
virtual QgsPointSequence sampledPoints () const =0
 Returns a list of sampled points, with their calculated elevation as the point z value. More...
 
virtual QgsProfileSnapResult snapPoint (const QgsProfilePoint &point, const QgsProfileSnapContext &context)
 Snaps a point to the generated elevation profile. More...
 
virtual QString type () const =0
 Returns the unique string identifier for the results type. More...
 
virtual QgsDoubleRange zRange () const =0
 Returns the range of the retrieved elevation values. More...
 

Public Attributes

double maxZ = std::numeric_limits< double >::lowest()
 
QMap< double, double > mDistanceToHeightMap
 
double mElevationLimit = std::numeric_limits< double >::quiet_NaN()
 
std::unique_ptr< QgsFillSymbolmFillSymbol
 
QString mId
 
double minZ = std::numeric_limits< double >::max()
 
std::unique_ptr< QgsLineSymbolmLineSymbol
 
std::unique_ptr< QgsCurvemProfileCurve
 
QgsPointSequence mRawPoints
 
Qgis::ProfileSurfaceSymbology symbology = Qgis::ProfileSurfaceSymbology::Line
 

Detailed Description

Abstract base class for storage of 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 40 of file qgsabstractprofilesurfacegenerator.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractProfileSurfaceResults()

QgsAbstractProfileSurfaceResults::~QgsAbstractProfileSurfaceResults ( )
overridedefault

Member Function Documentation

◆ asFeatures()

QVector< QgsAbstractProfileResults::Feature > QgsAbstractProfileSurfaceResults::asFeatures ( Qgis::ProfileExportType  type,
QgsFeedback feedback = nullptr 
) const
overridevirtual

Returns a list of features representing the calculated elevation results.

The default implementation returns an empty list.

Since
QGIS 3.32

Reimplemented from QgsAbstractProfileResults.

Reimplemented in QgsVectorLayerProfileResults.

Definition at line 58 of file qgsabstractprofilesurfacegenerator.cpp.

◆ asGeometries()

QVector< QgsGeometry > QgsAbstractProfileSurfaceResults::asGeometries ( ) const
overridevirtual

Returns a list of geometries representing the calculated elevation results.

Implements QgsAbstractProfileResults.

Reimplemented in QgsVectorLayerProfileResults.

Definition at line 48 of file qgsabstractprofilesurfacegenerator.cpp.

◆ copyPropertiesFromGenerator()

void QgsAbstractProfileSurfaceResults::copyPropertiesFromGenerator ( const QgsAbstractProfileGenerator generator)
overridevirtual

Copies properties from specified generator to the results object.

For instance, this method can be used to copy any properties relating to rendering the gathered results to reflect the generator's current properties.

The base class method does nothing.

Reimplemented from QgsAbstractProfileResults.

Reimplemented in QgsVectorLayerProfileResults.

Definition at line 365 of file qgsabstractprofilesurfacegenerator.cpp.

◆ distanceToHeightMap()

QMap< double, double > QgsAbstractProfileSurfaceResults::distanceToHeightMap ( ) const
overridevirtual

Returns the map of distance (chainage) to height.

Implements QgsAbstractProfileResults.

Definition at line 33 of file qgsabstractprofilesurfacegenerator.cpp.

◆ identify()

QVector< QgsProfileIdentifyResults > QgsAbstractProfileSurfaceResults::identify ( const QgsProfilePoint point,
const QgsProfileIdentifyContext context 
)
overridevirtual

Identify results visible at the specified profile point.

Reimplemented from QgsAbstractProfileResults.

Reimplemented in QgsMeshLayerProfileResults, QgsRasterLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 201 of file qgsabstractprofilesurfacegenerator.cpp.

◆ renderResults()

void QgsAbstractProfileSurfaceResults::renderResults ( QgsProfileRenderContext context)
overridevirtual

Renders the results to the specified context.

Implements QgsAbstractProfileResults.

Reimplemented in QgsVectorLayerProfileResults.

Definition at line 240 of file qgsabstractprofilesurfacegenerator.cpp.

◆ sampledPoints()

QgsPointSequence QgsAbstractProfileSurfaceResults::sampledPoints ( ) const
overridevirtual

Returns a list of sampled points, with their calculated elevation as the point z value.

Implements QgsAbstractProfileResults.

Definition at line 38 of file qgsabstractprofilesurfacegenerator.cpp.

◆ snapPoint()

QgsProfileSnapResult QgsAbstractProfileSurfaceResults::snapPoint ( const QgsProfilePoint point,
const QgsProfileSnapContext context 
)
overridevirtual

Snaps a point to the generated elevation profile.

Reimplemented from QgsAbstractProfileResults.

Reimplemented in QgsVectorLayerProfileResults.

Definition at line 172 of file qgsabstractprofilesurfacegenerator.cpp.

◆ zRange()

QgsDoubleRange QgsAbstractProfileSurfaceResults::zRange ( ) const
overridevirtual

Returns the range of the retrieved elevation values.

Implements QgsAbstractProfileResults.

Definition at line 43 of file qgsabstractprofilesurfacegenerator.cpp.

Member Data Documentation

◆ maxZ

double QgsAbstractProfileSurfaceResults::maxZ = std::numeric_limits< double >::lowest()

Definition at line 50 of file qgsabstractprofilesurfacegenerator.h.

◆ mDistanceToHeightMap

QMap< double, double > QgsAbstractProfileSurfaceResults::mDistanceToHeightMap

Definition at line 48 of file qgsabstractprofilesurfacegenerator.h.

◆ mElevationLimit

double QgsAbstractProfileSurfaceResults::mElevationLimit = std::numeric_limits< double >::quiet_NaN()

Definition at line 55 of file qgsabstractprofilesurfacegenerator.h.

◆ mFillSymbol

std::unique_ptr< QgsFillSymbol > QgsAbstractProfileSurfaceResults::mFillSymbol

Definition at line 54 of file qgsabstractprofilesurfacegenerator.h.

◆ mId

QString QgsAbstractProfileSurfaceResults::mId

Definition at line 46 of file qgsabstractprofilesurfacegenerator.h.

◆ minZ

double QgsAbstractProfileSurfaceResults::minZ = std::numeric_limits< double >::max()

Definition at line 49 of file qgsabstractprofilesurfacegenerator.h.

◆ mLineSymbol

std::unique_ptr< QgsLineSymbol > QgsAbstractProfileSurfaceResults::mLineSymbol

Definition at line 53 of file qgsabstractprofilesurfacegenerator.h.

◆ mProfileCurve

std::unique_ptr< QgsCurve > QgsAbstractProfileSurfaceResults::mProfileCurve

Definition at line 57 of file qgsabstractprofilesurfacegenerator.h.

◆ mRawPoints

QgsPointSequence QgsAbstractProfileSurfaceResults::mRawPoints

Definition at line 47 of file qgsabstractprofilesurfacegenerator.h.

◆ symbology

Qgis::ProfileSurfaceSymbology QgsAbstractProfileSurfaceResults::symbology = Qgis::ProfileSurfaceSymbology::Line

Definition at line 52 of file qgsabstractprofilesurfacegenerator.h.


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