qgsinterpolator.h

Go to the documentation of this file.

/***************************************************************************
                              qgsinterpolator.h
                              ------------------------
  begin                : March 10, 2008
  copyright            : (C) 2008 by Marco Hugentobler
  email                : marco dot hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSINTERPOLATOR_H
#define QGSINTERPOLATOR_H
 
#include "qgis_analysis.h"
#include "qgis_sip.h"
#include "qgscoordinatetransformcontext.h"
 
#include <QList>
#include <QVector>
 
class QgsFeatureSource;
class QgsGeometry;
class QgsFeedback;
 
#ifdef SIP_RUN
//%ModuleHeaderCode
#include "qgsinterpolator.h"
//%End
#endif

struct ANALYSIS_EXPORT QgsInterpolatorVertexData
{

    QgsInterpolatorVertexData( double x, double y, double z )
      : x( x )
      , y( y )
      , z( z )
    {}
 
    QgsInterpolatorVertexData() = default;

    double x = 0.0;
    double y = 0.0;
    double z = 0.0;
};

class ANALYSIS_EXPORT QgsInterpolator
{
  public:
    enum class SourceType SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsInterpolator, SourceType ) : int
    {
      Points SIP_MONKEYPATCH_COMPAT_NAME( SourcePoints ),                 
      StructureLines SIP_MONKEYPATCH_COMPAT_NAME( SourceStructureLines ), 
      BreakLines SIP_MONKEYPATCH_COMPAT_NAME( SourceBreakLines ),         
    };

    enum class ValueSource SIP_MONKEYPATCH_SCOPEENUM_UNNEST( QgsInterpolator, ValueSource ) : int
    {
      Attribute SIP_MONKEYPATCH_COMPAT_NAME( ValueAttribute ), 
      Z SIP_MONKEYPATCH_COMPAT_NAME( ValueZ ),                 
      M SIP_MONKEYPATCH_COMPAT_NAME( ValueM ),                 
    };

    enum class Result : int
    {
      Success = 0,          
      Canceled,             
      InvalidSource,        
      FeatureGeometryError, 
    };

    struct LayerData
    {
        QgsFeatureSource *source = nullptr;
        QgsInterpolator::ValueSource valueSource = QgsInterpolator::ValueSource::Attribute;
        int interpolationAttribute = -1;
        QgsInterpolator::SourceType sourceType = QgsInterpolator::SourceType::Points;

        QgsCoordinateTransformContext transformContext;
    };
 
    QgsInterpolator( const QList<QgsInterpolator::LayerData> &layerData );
 
    virtual ~QgsInterpolator() = default;

    virtual int interpolatePoint( double x, double y, double &result SIP_OUT, QgsFeedback *feedback = nullptr ) = 0;

    QList<LayerData> layerData() const SIP_SKIP { return mLayerData; }
 
  protected:

    Result cacheBaseData( QgsFeedback *feedback = nullptr );

    QVector<QgsInterpolatorVertexData> mCachedBaseData;

    bool mDataIsCached = false;

    QList<LayerData> mLayerData;
 
  private:
    QgsInterpolator() = delete;

    bool addVerticesToCache( const QgsGeometry &geom, ValueSource source, double attributeValue );
};
 
#endif