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 <QVector>
#include <QList>
#include "qgis_sip.h"
#include "qgis_analysis.h"

class QgsFeatureSource;
class QgsGeometry;
class QgsFeedback;

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 SourceType
    {
      SourcePoints, 
      SourceStructureLines, 
      SourceBreakLines, 
    };

    enum ValueSource
    {
      ValueAttribute, 
      ValueZ, 
      ValueM, 
    };

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

    struct LayerData
    {
      QgsFeatureSource *source = nullptr;
      QgsInterpolator::ValueSource valueSource = QgsInterpolator::ValueAttribute;
      int interpolationAttribute = -1;
      QgsInterpolator::SourceType sourceType = SourcePoints;
    };

    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 { return mLayerData; } SIP_SKIP

  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