QGIS API Documentation 3.27.0-Master (1c05421486)
Classes | Public Member Functions | Public Attributes | Friends | List of all members
QgsPointCloudLayerProfileResults Class Reference

Implementation of QgsAbstractProfileResults for point cloud layers. More...

#include <qgspointcloudlayerprofilegenerator.h>

Inheritance diagram for QgsPointCloudLayerProfileResults:
Inheritance graph
[legend]

Classes

struct  PointResult
 

Public Member Functions

 QgsPointCloudLayerProfileResults ()
 
 ~QgsPointCloudLayerProfileResults () override
 
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...
 
void finalize (QgsFeedback *feedback)
 Finalizes results – should be called after last point is added. More...
 
QVector< QgsProfileIdentifyResultsidentify (const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange, const QgsProfileIdentifyContext &context) override
 Identify results visible within the specified ranges. 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...
 
QString type () const override
 Returns the unique string identifier for the results type. More...
 
QgsDoubleRange zRange () const override
 Returns the range of the retrieved elevation values. More...
 
- Public Member Functions inherited from QgsAbstractProfileResults
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...
 

Public Attributes

double maxZ = std::numeric_limits< double >::lowest()
 
double minZ = std::numeric_limits< double >::max()
 
bool opacityByDistanceEffect = false
 
QColor pointColor
 
double pointSize = 1
 
QgsUnitTypes::RenderUnit pointSizeUnit = QgsUnitTypes::RenderMillimeters
 
Qgis::PointCloudSymbol pointSymbol = Qgis::PointCloudSymbol::Square
 
bool respectLayerColors = true
 
std::vector< PointResultresults
 
double tolerance = 0
 

Friends

class QgsPointCloudLayerProfileGenerator
 

Detailed Description

Implementation of QgsAbstractProfileResults for point cloud layers.

Note
Not available in Python bindings
Since
QGIS 3.26

Definition at line 57 of file qgspointcloudlayerprofilegenerator.h.

Constructor & Destructor Documentation

◆ QgsPointCloudLayerProfileResults()

QgsPointCloudLayerProfileResults::QgsPointCloudLayerProfileResults ( )

Definition at line 38 of file qgspointcloudlayerprofilegenerator.cpp.

◆ ~QgsPointCloudLayerProfileResults()

QgsPointCloudLayerProfileResults::~QgsPointCloudLayerProfileResults ( )
override

Definition at line 43 of file qgspointcloudlayerprofilegenerator.cpp.

Member Function Documentation

◆ asGeometries()

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

Returns a list of geometries representing the calculated elevation results.

Implements QgsAbstractProfileResults.

Definition at line 95 of file qgspointcloudlayerprofilegenerator.cpp.

◆ copyPropertiesFromGenerator()

void QgsPointCloudLayerProfileResults::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.

Definition at line 261 of file qgspointcloudlayerprofilegenerator.cpp.

◆ distanceToHeightMap()

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

Returns the map of distance (chainage) to height.

Implements QgsAbstractProfileResults.

Definition at line 72 of file qgspointcloudlayerprofilegenerator.cpp.

◆ finalize()

void QgsPointCloudLayerProfileResults::finalize ( QgsFeedback feedback)

Finalizes results – should be called after last point is added.

Definition at line 49 of file qgspointcloudlayerprofilegenerator.cpp.

◆ identify() [1/2]

QVector< QgsProfileIdentifyResults > QgsPointCloudLayerProfileResults::identify ( const QgsDoubleRange distanceRange,
const QgsDoubleRange elevationRange,
const QgsProfileIdentifyContext context 
)
overridevirtual

Identify results visible within the specified ranges.

Reimplemented from QgsAbstractProfileResults.

Definition at line 229 of file qgspointcloudlayerprofilegenerator.cpp.

◆ identify() [2/2]

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

Identify results visible at the specified profile point.

Reimplemented from QgsAbstractProfileResults.

Definition at line 223 of file qgspointcloudlayerprofilegenerator.cpp.

◆ renderResults()

void QgsPointCloudLayerProfileResults::renderResults ( QgsProfileRenderContext context)
overridevirtual

Renders the results to the specified context.

Implements QgsAbstractProfileResults.

Definition at line 112 of file qgspointcloudlayerprofilegenerator.cpp.

◆ sampledPoints()

QgsPointSequence QgsPointCloudLayerProfileResults::sampledPoints ( ) const
overridevirtual

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

Implements QgsAbstractProfileResults.

Definition at line 83 of file qgspointcloudlayerprofilegenerator.cpp.

◆ snapPoint()

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

Snaps a point to the generated elevation profile.

Reimplemented from QgsAbstractProfileResults.

Definition at line 181 of file qgspointcloudlayerprofilegenerator.cpp.

◆ type()

QString QgsPointCloudLayerProfileResults::type ( ) const
overridevirtual

Returns the unique string identifier for the results type.

Implements QgsAbstractProfileResults.

Definition at line 67 of file qgspointcloudlayerprofilegenerator.cpp.

◆ zRange()

QgsDoubleRange QgsPointCloudLayerProfileResults::zRange ( ) const
overridevirtual

Returns the range of the retrieved elevation values.

Implements QgsAbstractProfileResults.

Definition at line 107 of file qgspointcloudlayerprofilegenerator.cpp.

Friends And Related Function Documentation

◆ QgsPointCloudLayerProfileGenerator

Definition at line 115 of file qgspointcloudlayerprofilegenerator.h.

Member Data Documentation

◆ maxZ

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

Definition at line 84 of file qgspointcloudlayerprofilegenerator.h.

◆ minZ

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

Definition at line 83 of file qgspointcloudlayerprofilegenerator.h.

◆ opacityByDistanceEffect

bool QgsPointCloudLayerProfileResults::opacityByDistanceEffect = false

Definition at line 91 of file qgspointcloudlayerprofilegenerator.h.

◆ pointColor

QColor QgsPointCloudLayerProfileResults::pointColor

Definition at line 90 of file qgspointcloudlayerprofilegenerator.h.

◆ pointSize

double QgsPointCloudLayerProfileResults::pointSize = 1

Definition at line 86 of file qgspointcloudlayerprofilegenerator.h.

◆ pointSizeUnit

QgsUnitTypes::RenderUnit QgsPointCloudLayerProfileResults::pointSizeUnit = QgsUnitTypes::RenderMillimeters

Definition at line 87 of file qgspointcloudlayerprofilegenerator.h.

◆ pointSymbol

Qgis::PointCloudSymbol QgsPointCloudLayerProfileResults::pointSymbol = Qgis::PointCloudSymbol::Square

Definition at line 88 of file qgspointcloudlayerprofilegenerator.h.

◆ respectLayerColors

bool QgsPointCloudLayerProfileResults::respectLayerColors = true

Definition at line 89 of file qgspointcloudlayerprofilegenerator.h.

◆ results

std::vector< PointResult > QgsPointCloudLayerProfileResults::results

Definition at line 80 of file qgspointcloudlayerprofilegenerator.h.

◆ tolerance

double QgsPointCloudLayerProfileResults::tolerance = 0

Definition at line 81 of file qgspointcloudlayerprofilegenerator.h.


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