QGIS API Documentation 3.27.0-Master (1d7a28cfd2)
Public Member Functions | List of all members
QgsAbstractProfileResults Class Referenceabstract

Abstract base class for storage of elevation profiles. More...

#include <qgsabstractprofilegenerator.h>

Inheritance diagram for QgsAbstractProfileResults:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsAbstractProfileResults ()
 
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...
 

Detailed Description

Abstract base class for storage of elevation profiles.

Since
QGIS 3.26

Definition at line 193 of file qgsabstractprofilegenerator.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractProfileResults()

QgsAbstractProfileResults::~QgsAbstractProfileResults ( )
virtualdefault

Member Function Documentation

◆ asGeometries()

virtual QVector< QgsGeometry > QgsAbstractProfileResults::asGeometries ( ) const
pure virtual

Returns a list of geometries representing the calculated elevation results.

Implemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

◆ copyPropertiesFromGenerator()

void QgsAbstractProfileResults::copyPropertiesFromGenerator ( const QgsAbstractProfileGenerator generator)
virtual

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 in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 77 of file qgsabstractprofilegenerator.cpp.

◆ distanceToHeightMap()

virtual QMap< double, double > QgsAbstractProfileResults::distanceToHeightMap ( ) const
pure virtual

Returns the map of distance (chainage) to height.

Implemented in QgsAbstractProfileSurfaceResults, and QgsPointCloudLayerProfileResults.

◆ identify() [1/2]

QVector< QgsProfileIdentifyResults > QgsAbstractProfileResults::identify ( const QgsDoubleRange distanceRange,
const QgsDoubleRange elevationRange,
const QgsProfileIdentifyContext context 
)
virtual

Identify results visible within the specified ranges.

Reimplemented in QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 72 of file qgsabstractprofilegenerator.cpp.

◆ identify() [2/2]

QVector< QgsProfileIdentifyResults > QgsAbstractProfileResults::identify ( const QgsProfilePoint point,
const QgsProfileIdentifyContext context 
)
virtual

◆ renderResults()

virtual void QgsAbstractProfileResults::renderResults ( QgsProfileRenderContext context)
pure virtual

Renders the results to the specified context.

Implemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

◆ sampledPoints()

virtual QgsPointSequence QgsAbstractProfileResults::sampledPoints ( ) const
pure virtual

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

Implemented in QgsAbstractProfileSurfaceResults, and QgsPointCloudLayerProfileResults.

◆ snapPoint()

QgsProfileSnapResult QgsAbstractProfileResults::snapPoint ( const QgsProfilePoint point,
const QgsProfileSnapContext context 
)
virtual

Snaps a point to the generated elevation profile.

Reimplemented in QgsAbstractProfileSurfaceResults, QgsPointCloudLayerProfileResults, and QgsVectorLayerProfileResults.

Definition at line 62 of file qgsabstractprofilegenerator.cpp.

◆ type()

virtual QString QgsAbstractProfileResults::type ( ) const
pure virtual

Returns the unique string identifier for the results type.

Implemented in QgsMeshLayerProfileResults, QgsPointCloudLayerProfileResults, QgsRasterLayerProfileResults, and QgsVectorLayerProfileResults.

◆ zRange()

virtual QgsDoubleRange QgsAbstractProfileResults::zRange ( ) const
pure virtual

Returns the range of the retrieved elevation values.

Implemented in QgsAbstractProfileSurfaceResults, and QgsPointCloudLayerProfileResults.


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