QGIS API Documentation 3.99.0-Master (c22de0620c0)
Loading...
Searching...
No Matches
qgsvectorlayerprofilegenerator.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectorlayerprofilegenerator.h
3 ---------------
4 begin : March 2022
5 copyright : (C) 2022 by Nyall Dawson
6 email : nyall dot dawson at gmail 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#ifndef QGSVECTORLAYERPROFILEGENERATOR_H
18#define QGSVECTORLAYERPROFILEGENERATOR_H
19
20#include <memory>
21
22#include "qgis_core.h"
23#include "qgis_sip.h"
28#include "qgsfeatureid.h"
29#include "qgsfillsymbol.h"
30#include "qgslinesymbol.h"
31#include "qgsmarkersymbol.h"
32
33#define SIP_NO_FILE
34
36class QgsCurve;
37class QgsVectorLayer;
40class QgsGeos;
41class QgsLineString;
42class QgsPolygon;
44
45
46
55{
56 public:
57
67
68 QHash< QgsFeatureId, QVector< Feature > > features;
69 QPointer< QgsVectorLayer > mLayer;
70
73 std::unique_ptr< QgsMarkerSymbol > mMarkerSymbol;
75
76 QString type() const override;
77 QVector< QgsGeometry > asGeometries() const override;
78 QVector< QgsAbstractProfileResults::Feature > asFeatures( Qgis::ProfileExportType type, QgsFeedback *feedback = nullptr ) const override;
79 QgsProfileSnapResult snapPoint( const QgsProfilePoint &point, const QgsProfileSnapContext &context ) override;
80 QVector<QgsProfileIdentifyResults> identify( const QgsProfilePoint &point, const QgsProfileIdentifyContext &context ) override;
81 QVector<QgsProfileIdentifyResults> identify( const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange, const QgsProfileIdentifyContext &context ) override;
82 void renderResults( QgsProfileRenderContext &context ) override;
83 void copyPropertiesFromGenerator( const QgsAbstractProfileGenerator *generator ) override;
84
85 private:
86 void renderResultsAsIndividualFeatures( QgsProfileRenderContext &context );
87 void renderMarkersOverContinuousSurfacePlot( QgsProfileRenderContext &context );
88 QVector< QgsAbstractProfileResults::Feature > asIndividualFeatures( Qgis::ProfileExportType type, QgsFeedback *feedback = nullptr ) const;
89 QgsProfileSnapResult snapPointToIndividualFeatures( const QgsProfilePoint &point, const QgsProfileSnapContext &context );
90
91 void visitFeaturesAtPoint( const QgsProfilePoint &point, double maximumPointDistanceDelta, double maximumPointElevationDelta, double maximumSurfaceElevationDelta,
92 const std::function< void( QgsFeatureId, double delta, double distance, double elevation ) > &visitor, bool visitWithin ) const;
93 void visitFeaturesInRange( const QgsDoubleRange &distanceRange, const QgsDoubleRange &elevationRange,
94 const std::function<void ( QgsFeatureId )> &visitor ) const;
95};
96
97
106{
107
108 public:
109
114
116
117 QString sourceId() const override;
120 QgsFeedback *feedback() const override;
121 QString type() const override;
122
123 private:
124
125 // We may need to split mProfileCurve into multiple parts, this will be
126 // called for each part.
127 bool generateProfileInner( const QgsProfileGenerationContext &context = QgsProfileGenerationContext() );
128
129 bool generateProfileForPoints();
130 bool generateProfileForLines();
131 bool generateProfileForPolygons();
132
133 void processIntersectionPoint( const QgsPoint *intersectionPoint, const QgsFeature &feature );
134 void processIntersectionCurve( const QgsLineString *intersectionCurve, const QgsFeature &feature );
135
136 QgsPoint interpolatePointOnTriangle( const QgsPolygon *triangle, double x, double y ) const;
137 void processTriangleIntersectForPoint( const QgsPolygon *triangle, const QgsPoint *intersect, QVector< QgsGeometry > &transformedParts, QVector< QgsGeometry > &crossSectionParts );
138 void processTriangleIntersectForLine( const QgsPolygon *triangle, const QgsLineString *intersect, QVector< QgsGeometry > &transformedParts, QVector< QgsGeometry > &crossSectionParts );
139 void processTriangleIntersectForPolygon( const QgsPolygon *triangle, const QgsPolygon *intersectionPolygon, QVector< QgsGeometry > &transformedParts, QVector< QgsGeometry > &crossSectionParts );
140
141 double tolerance() const;
142
143 double terrainHeight( double x, double y ) const;
144 double featureZToHeight( double x, double y, double z, double offset ) const;
145
146 void clampAltitudes( QgsLineString *lineString, const QgsPoint &centroid, double offset ) const;
147 bool clampAltitudes( QgsPolygon *polygon, double offset ) const;
148
149 QString mId;
150 std::unique_ptr<QgsFeedback> mFeedback = nullptr;
151
152 std::unique_ptr< QgsCurve > mProfileCurve;
153 std::unique_ptr< QgsGeos > mProfileCurveEngine;
154
155 std::unique_ptr<QgsAbstractGeometry> mProfileBufferedCurve;
156 std::unique_ptr< QgsGeos > mProfileBufferedCurveEngine;
157
158 std::unique_ptr< QgsAbstractTerrainProvider > mTerrainProvider;
159
160 std::unique_ptr< QgsCurve > mTransformedCurve;
161 double mTolerance = 0;
162
163
166 QgsCoordinateTransformContext mTransformContext;
167 QgsRectangle mExtent;
168
169 std::unique_ptr< QgsVectorLayerFeatureSource > mSource;
170
171 double mOffset = 0;
172 double mScale = 1;
176 bool mExtrusionEnabled = false;
177 double mExtrusionHeight = 0;
178 bool mCustomToleranceEnabled = false;
179 double mCustomTolerance = 0;
180
181 QgsExpressionContext mExpressionContext;
182 QgsFields mFields;
183 QgsPropertyCollection mDataDefinedProperties;
184
186 QgsCoordinateTransform mLayerToTargetTransform;
187 QgsCoordinateTransform mTargetToTerrainProviderTransform;
188
189 std::unique_ptr< QgsVectorLayerProfileResults > mResults;
190 std::unique_ptr< QgsMarkerSymbol > mMarkerSymbol;
191
192 bool mRespectLayerSymbology = true;
193 std::unique_ptr< QgsMarkerSymbol > mProfileMarkerSymbol;
194 bool mShowMarkerSymbolInSurfacePlots = false;
195
196 // NOT for use in the background thread!
197 QPointer< QgsVectorLayer > mLayer;
198
200
201};
202
203#endif // QGSVECTORLAYERPROFILEGENERATOR_H
AltitudeClamping
Altitude clamping.
Definition qgis.h:4068
@ Terrain
Elevation is clamped to terrain (final elevation = terrain elevation).
Definition qgis.h:4071
AltitudeBinding
Altitude binding.
Definition qgis.h:4081
@ Centroid
Clamp just centroid of feature.
Definition qgis.h:4083
VectorProfileType
Types of elevation profiles to generate for vector sources.
Definition qgis.h:4303
@ IndividualFeatures
Treat each feature as an individual object (eg buildings).
Definition qgis.h:4304
ProfileExportType
Types of export for elevation profiles.
Definition qgis.h:4342
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:291
@ Unknown
Unknown.
Definition qgis.h:292
Abstract base class for objects which generate elevation profiles.
Abstract base class for storage of elevation profiles.
virtual QString type() const =0
Returns the unique string identifier for the results type.
QgsAbstractProfileSurfaceGenerator(const QgsProfileRequest &request)
Constructor for QgsAbstractProfileSurfaceGenerator.
Abstract base class for storage of elevation profiles which represent a continuous surface (e....
void renderResults(QgsProfileRenderContext &context) override
Renders the results to the specified context.
void copyPropertiesFromGenerator(const QgsAbstractProfileGenerator *generator) override
Copies properties from specified generator to the results object.
QVector< QgsAbstractProfileResults::Feature > asFeatures(Qgis::ProfileExportType type, QgsFeedback *feedback=nullptr) const override
Returns a list of features representing the calculated elevation results.
QVector< QgsGeometry > asGeometries() const override
Returns a list of geometries representing the calculated elevation results.
QVector< QgsProfileIdentifyResults > identify(const QgsProfilePoint &point, const QgsProfileIdentifyContext &context) override
Identify results visible at the specified profile point.
QgsProfileSnapResult snapPoint(const QgsProfilePoint &point, const QgsProfileSnapContext &context) override
Snaps a point to the generated elevation profile.
Abstract base class for terrain providers.
Represents a coordinate reference system (CRS).
Contains information about the context in which a coordinate transform is executed.
Handles coordinate transforms between two coordinate systems.
Abstract base class for curved geometry type.
Definition qgscurve.h:36
QgsRange which stores a range of double values.
Definition qgsrange.h:236
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
Container of fields for a vector layer.
Definition qgsfields.h:46
A geometry is the spatial representation of a feature.
Does vector analysis using the GEOS library and handles import, export, and exception handling.
Definition qgsgeos.h:141
Line string geometry type, with support for z-dimension and m-values.
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:53
Polygon geometry type.
Definition qgspolygon.h:37
Encapsulates the context in which an elevation profile is to be generated.
Encapsulates the context of identifying profile results.
Encapsulates a point on a distance-elevation profile.
Abstract base class for storage of elevation profiles.
Encapsulates properties and constraints relating to fetching elevation profiles from different source...
Encapsulates the context of snapping a profile point.
Encapsulates results of snapping a profile point.
A grouped map of multiple QgsProperty objects, each referenced by an integer key value.
A rectangle specified with double values.
Partial snapshot of vector layer's state (only the members necessary for access to features).
QgsAbstractProfileResults * takeResults() override
Takes results from the generator.
bool generateProfile(const QgsProfileGenerationContext &context=QgsProfileGenerationContext()) override
Generate the profile (based on data stored in the class).
QString sourceId() const override
Returns a unique identifier representing the source of the profile.
~QgsVectorLayerProfileGenerator() override
QgsFeedback * feedback() const override
Access to feedback object of the generator (may be nullptr).
QgsVectorLayerProfileGenerator(QgsVectorLayer *layer, const QgsProfileRequest &request)
Constructor for QgsVectorLayerProfileGenerator.
Implementation of QgsAbstractProfileResults for vector layers.
std::unique_ptr< QgsMarkerSymbol > mMarkerSymbol
QString type() const override
Returns the unique string identifier for the results type.
QHash< QgsFeatureId, QVector< Feature > > features
Represents a vector layer which manages a vector based dataset.
qint64 QgsFeatureId
64 bit feature ids negative numbers are used for uncommitted/newly added features
QgsGeometry crossSectionGeometry
Cross section distance vs height geometry for feature.
QgsGeometry geometry
Feature's geometry with any terrain height adjustment and extrusion applied.