QGIS API Documentation  3.18.1-Zürich (202f1bf7e5)
qgsinterpolator.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsinterpolator.h
3  ------------------------
4  begin : March 10, 2008
5  copyright : (C) 2008 by Marco Hugentobler
6  email : marco dot hugentobler at karto dot baug dot ethz dot ch
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 QGSINTERPOLATOR_H
19 #define QGSINTERPOLATOR_H
20 
21 #include <QVector>
22 #include <QList>
23 
24 #include "qgis_sip.h"
25 #include "qgis_analysis.h"
27 
28 class QgsFeatureSource;
29 class QgsGeometry;
30 class QgsFeedback;
31 
36 struct ANALYSIS_EXPORT QgsInterpolatorVertexData
37 {
38 
43  QgsInterpolatorVertexData( double x, double y, double z )
44  : x( x )
45  , y( y )
46  , z( z )
47  {}
48 
51 
53  double x = 0.0;
55  double y = 0.0;
57  double z = 0.0;
58 };
59 
68 class ANALYSIS_EXPORT QgsInterpolator
69 {
70  public:
71 
74  {
78  };
79 
82  {
86  };
87 
89  enum Result
90  {
91  Success = 0,
95  };
96 
98  struct LayerData
99  {
101  QgsFeatureSource *source = nullptr;
105  int interpolationAttribute = -1;
107  QgsInterpolator::SourceType sourceType = SourcePoints;
108 
115  };
116 
117  QgsInterpolator( const QList<QgsInterpolator::LayerData> &layerData );
118 
119  virtual ~QgsInterpolator() = default;
120 
129  virtual int interpolatePoint( double x, double y, double &result SIP_OUT, QgsFeedback *feedback = nullptr ) = 0;
130 
132  QList<LayerData> layerData() const { return mLayerData; } SIP_SKIP
133 
134  protected:
135 
145  Result cacheBaseData( QgsFeedback *feedback = nullptr );
146 
148  QVector<QgsInterpolatorVertexData> mCachedBaseData;
149 
151  bool mDataIsCached = false;
152 
154  QList<LayerData> mLayerData;
155 
156  private:
157  QgsInterpolator() = delete;
158 
166  bool addVerticesToCache( const QgsGeometry &geom, ValueSource source, double attributeValue );
167 };
168 
169 #endif
Contains information about the context in which a coordinate transform is executed.
An interface for objects which provide features via a getFeatures method.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:124
Interface class for interpolations.
QVector< QgsInterpolatorVertexData > mCachedBaseData
Cached vertex data for input sources.
virtual int interpolatePoint(double x, double y, double &result, QgsFeedback *feedback=nullptr)=0
Calculates interpolation value for map coordinates x, y.
ValueSource
Source for interpolated values from features.
@ ValueM
Use feature's geometry M values for interpolation.
@ ValueAttribute
Take value from feature's attribute.
@ ValueZ
Use feature's geometry Z values for interpolation.
Result
Result of an interpolation operation.
@ Canceled
Operation was manually canceled.
@ InvalidSource
Operation failed due to invalid source.
@ FeatureGeometryError
Operation failed due to invalid feature geometry.
SourceType
Describes the type of input data.
@ SourcePoints
Point source.
@ SourceStructureLines
Structure lines.
@ SourceBreakLines
Break lines.
QList< LayerData > mLayerData
Information about the input vector layers and the attributes (or z-values) that are used for interpol...
virtual ~QgsInterpolator()=default
QList< LayerData > layerData() const
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_OUT
Definition: qgis_sip.h:58
Interpolation data for an individual source vertex.
QgsInterpolatorVertexData()=default
Constructor for QgsInterpolatorVertexData.
QgsInterpolatorVertexData(double x, double y, double z)
Constructor for QgsInterpolatorVertexData with the specified x, y, and z coordinate.
A source together with the information about interpolation attribute / z-coordinate interpolation and...
QgsCoordinateTransformContext transformContext
Coordinate transform context.