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

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

#include <qgspointcloudlayerprofilegenerator.h>

Inheritance diagram for QgsPointCloudLayerProfileGenerator:
Inheritance graph
[legend]

Public Member Functions

 QgsPointCloudLayerProfileGenerator (QgsPointCloudLayer *layer, const QgsProfileRequest &request)
 Constructor for QgsPointCloudLayerProfileGenerator. More...
 
 ~QgsPointCloudLayerProfileGenerator () override
 
QgsFeedbackfeedback () const override
 Access to feedback object of the generator (may be nullptr) More...
 
Qgis::ProfileGeneratorFlags flags () const override
 Returns flags which reflect how the profile generator operates. More...
 
bool generateProfile (const QgsProfileGenerationContext &context=QgsProfileGenerationContext()) override
 Generate the profile (based on data stored in the class). More...
 
QString sourceId () const override
 Returns a unique identifier representing the source of the profile. More...
 
QgsAbstractProfileResultstakeResults () override
 Takes results from the generator. 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...
 

Friends

class QgsPointCloudLayerProfileResults
 

Detailed Description

Implementation of QgsAbstractProfileGenerator for point cloud layers.

Note
Not available in Python bindings
Since
QGIS 3.26

Definition at line 126 of file qgspointcloudlayerprofilegenerator.h.

Constructor & Destructor Documentation

◆ QgsPointCloudLayerProfileGenerator()

QgsPointCloudLayerProfileGenerator::QgsPointCloudLayerProfileGenerator ( QgsPointCloudLayer layer,
const QgsProfileRequest request 
)

◆ ~QgsPointCloudLayerProfileGenerator()

QgsPointCloudLayerProfileGenerator::~QgsPointCloudLayerProfileGenerator ( )
overridedefault

Member Function Documentation

◆ feedback()

QgsFeedback * QgsPointCloudLayerProfileGenerator::feedback ( ) const
overridevirtual

Access to feedback object of the generator (may be nullptr)

Implements QgsAbstractProfileGenerator.

Definition at line 504 of file qgspointcloudlayerprofilegenerator.cpp.

◆ flags()

Qgis::ProfileGeneratorFlags QgsPointCloudLayerProfileGenerator::flags ( ) const
overridevirtual

Returns flags which reflect how the profile generator operates.

Reimplemented from QgsAbstractProfileGenerator.

Definition at line 319 of file qgspointcloudlayerprofilegenerator.cpp.

◆ generateProfile()

bool QgsPointCloudLayerProfileGenerator::generateProfile ( const QgsProfileGenerationContext context = QgsProfileGenerationContext())
overridevirtual

Generate the profile (based on data stored in the class).

Returns true if the profile was generated successfully (i.e. the generation was not canceled early).

Implements QgsAbstractProfileGenerator.

Definition at line 326 of file qgspointcloudlayerprofilegenerator.cpp.

◆ sourceId()

QString QgsPointCloudLayerProfileGenerator::sourceId ( ) const
overridevirtual

Returns a unique identifier representing the source of the profile.

For generators associated with a map layer the source ID will match the layer's QgsMapLayer::id(). Other (non-map-layer) sources will have a different unique ID with its own custom interpretation.gen

Implements QgsAbstractProfileGenerator.

Definition at line 314 of file qgspointcloudlayerprofilegenerator.cpp.

◆ takeResults()

QgsAbstractProfileResults * QgsPointCloudLayerProfileGenerator::takeResults ( )
overridevirtual

Takes results from the generator.

Ownership is transferred to the caller.

Implements QgsAbstractProfileGenerator.

Definition at line 499 of file qgspointcloudlayerprofilegenerator.cpp.

Friends And Related Function Documentation

◆ QgsPointCloudLayerProfileResults

friend class QgsPointCloudLayerProfileResults
friend

Definition at line 191 of file qgspointcloudlayerprofilegenerator.h.


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