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>

class QgsVectorLayer;
class QgsGeometry;

struct ANALYSIS_EXPORT vertexData
{
  double x;
  double y;
  double z;
};

class ANALYSIS_EXPORT QgsInterpolator
{
  public:
    enum InputType
    {
      POINTS,
      STRUCTURE_LINES,
      BREAK_LINES
    };

    struct LayerData
    {
      QgsVectorLayer* vectorLayer;
      bool zCoordInterpolation;
      int interpolationAttribute;
      InputType mInputType;
    };

    QgsInterpolator( const QList<LayerData>& layerData );

    virtual ~QgsInterpolator();

    virtual int interpolatePoint( double x, double y, double& result ) = 0;

    // @note not available in python bindings
    const QList<LayerData>& layerData() const { return mLayerData; }

  protected:
    int cacheBaseData();

    QVector<vertexData> mCachedBaseData;

    bool mDataIsCached;

    //Information about the input vector layers and the attributes (or z-values) that are used for interpolation
    QList<LayerData> mLayerData;

  private:
    QgsInterpolator(); //forbidden
    int addVerticesToCache( QgsGeometry* geom, bool zCoord, double attributeValue );
};

#endif