QGIS API Documentation 4.1.0-Master (376402f9aeb)
Loading...
Searching...
No Matches
qgsalgorithmextrude.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmextrude.h
3 ---------------------
4 begin : April 2026
5 copyright : (C) 2026 by Jean Felder
6 email : jean dot felder at oslandia dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSALGORITHMEXTRUDE_H
19#define QGSALGORITHMEXTRUDE_H
20
21
22#include "qgis_sip.h"
24
25#define SIP_NO_FILE
26
28
29
33class QgsExtrudeAlgorithm : public QgsProcessingFeatureBasedAlgorithm
34{
35 public:
36 QgsExtrudeAlgorithm() = default;
37 QString name() const override;
38 QString displayName() const override;
39 QStringList tags() const override;
40 QString group() const override;
41 QString groupId() const override;
42 QString shortHelpString() const override;
43 QString shortDescription() const override;
44 QgsExtrudeAlgorithm *createInstance() const override SIP_FACTORY;
45 QList<int> inputLayerTypes() const override;
46
47 protected:
48 QString outputName() const override;
49 Qgis::ProcessingSourceType outputLayerType() const override;
50 Qgis::WkbType outputWkbType( Qgis::WkbType inputWkbType ) const override;
51 void initParameters( const QVariantMap & ) override;
52 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
54
55 private:
56#ifdef WITH_SFCGAL
57 std::optional<QgsGeometry> extrudePolygon( const QgsAbstractGeometry *polygon, const QgsVector3D &extrusion, const QgsFeatureId &featureId, QgsProcessingFeedback *feedback );
58#endif
59
60 private:
61 double mExtrudeX = 0.0;
62 bool mDynamicExtrudeX = false;
63 QgsProperty mExtrudeXProperty;
64
65 double mExtrudeY = 0.0;
66 bool mDynamicExtrudeY = false;
67 QgsProperty mExtrudeYProperty;
68
69 double mExtrudeZ = 0.0;
70 bool mDynamicExtrudeZ = false;
71 QgsProperty mExtrudeZProperty;
72};
73
75#endif // QGSALGORITHMEXTRUDE_H
ProcessingSourceType
Processing data source types.
Definition qgis.h:3712
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:294
Abstract base class for all geometries.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Base class for providing feedback from a processing algorithm.
A store for object properties.
A 3D vector (similar to QVector3D) with the difference that it uses double precision instead of singl...
Definition qgsvector3d.h:33
#define SIP_FACTORY
Definition qgis_sip.h:83
QList< QgsFeature > QgsFeatureList
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features