qgsterrainprovider.h

Go to the documentation of this file.

/***************************************************************************
                         qgsterrainprovider.h
                         ---------------
    begin                : February 2022
    copyright            : (C) 2022 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSTERRAINPROVIDER_H
#define QGSTERRAINPROVIDER_H
 
#include "qgis_core.h"
#include "qgsmaplayerref.h"
#include "qgsmeshlayer.h"
#include "qgsrange.h"
#include "qgsrasterlayer.h"
#include "qgstriangularmesh.h"
#include "qgsunittypes.h"
 
#include <QObject>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QDomElement;
class QgsReadWriteContext;
class QDomDocument;

class CORE_EXPORT QgsAbstractTerrainProvider
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( sipCpp->type().compare( "flat"_L1 ) == 0 )
    {
      sipType = sipType_QgsFlatTerrainProvider;
    }
    else if ( sipCpp->type().compare( "raster"_L1 ) == 0 )
    {
      sipType = sipType_QgsRasterDemTerrainProvider;
    }
    else if ( sipCpp->type().compare( "mesh"_L1 ) == 0 )
    {
      sipType = sipType_QgsMeshTerrainProvider;
    }
    else
    {
      sipType = 0;
    }
  SIP_END
#endif
 
  public:
 
    virtual ~QgsAbstractTerrainProvider();
 
    QgsAbstractTerrainProvider &operator=( const QgsAbstractTerrainProvider &other ) = delete;

    virtual bool equals( const QgsAbstractTerrainProvider *other ) const = 0;

    virtual void resolveReferences( const QgsProject *project );

    virtual bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) = 0;

    virtual QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const = 0;

    virtual QString type() const = 0;

    virtual QgsAbstractTerrainProvider *clone() const = 0 SIP_FACTORY;

    virtual void prepare() = 0 SIP_FACTORY;

    virtual QgsCoordinateReferenceSystem crs() const = 0;

    virtual double heightAt( double x, double y ) const = 0;

    double scale() const { return mScale; }

    void setScale( double scale ) { mScale = scale; }

    double offset() const { return mOffset; }

    void setOffset( double offset ) { mOffset = offset; }
 
  protected:
    QgsAbstractTerrainProvider() = default;
 
#ifndef SIP_RUN
    QgsAbstractTerrainProvider( const QgsAbstractTerrainProvider &other );
#endif

    void writeCommonProperties( QDomElement &element, const QgsReadWriteContext &context ) const;

    void readCommonProperties( const QDomElement &element, const QgsReadWriteContext &context );

    double mScale = 1.0;

    double mOffset = 0.0;
 
  private:
#ifdef SIP_RUN
    QgsAbstractTerrainProvider( const QgsAbstractTerrainProvider &other );
#endif
};
 

class CORE_EXPORT QgsFlatTerrainProvider : public QgsAbstractTerrainProvider
{
  public:
    QgsFlatTerrainProvider() = default;
 
    QString type() const override;
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const override;
    QgsCoordinateReferenceSystem crs() const override;
    double heightAt( double x, double y ) const override;
    QgsFlatTerrainProvider *clone() const override SIP_FACTORY;
    void prepare() override;
    bool equals( const QgsAbstractTerrainProvider *other ) const override;
};

class CORE_EXPORT QgsRasterDemTerrainProvider : public QgsAbstractTerrainProvider
{
  public:
    QgsRasterDemTerrainProvider() = default;
 
#ifndef SIP_RUN
    const QgsRasterDemTerrainProvider *operator=( const QgsRasterDemTerrainProvider &other ) = delete;
#endif
 
    QString type() const override;
    void resolveReferences( const QgsProject *project ) override;
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const override;
    QgsCoordinateReferenceSystem crs() const override;
    double heightAt( double x, double y ) const override;
    QgsRasterDemTerrainProvider *clone() const override SIP_FACTORY;
    bool equals( const QgsAbstractTerrainProvider *other ) const override;
    void prepare() override;

    void setLayer( QgsRasterLayer *layer );

    QgsRasterLayer *layer() const;
 
 
  private:
    QgsRasterDemTerrainProvider( const QgsRasterDemTerrainProvider &other );
 
    _LayerRef<QgsRasterLayer> mRasterLayer;
    std::unique_ptr< QgsRasterDataProvider > mRasterProvider;
};
 

class CORE_EXPORT QgsMeshTerrainProvider : public QgsAbstractTerrainProvider
{
  public:
    QgsMeshTerrainProvider() = default;
 
#ifndef SIP_RUN
    const QgsMeshTerrainProvider *operator=( const QgsMeshTerrainProvider &other ) = delete;
#endif
 
    QString type() const override;
    void resolveReferences( const QgsProject *project ) override;
    bool readXml( const QDomElement &element, const QgsReadWriteContext &context ) override;
    QDomElement writeXml( QDomDocument &document, const QgsReadWriteContext &context ) const override;
    QgsCoordinateReferenceSystem crs() const override;
    double heightAt( double x, double y ) const override;
    QgsMeshTerrainProvider *clone() const override SIP_FACTORY;
    bool equals( const QgsAbstractTerrainProvider *other ) const override;
    void prepare() override;

    void setLayer( QgsMeshLayer *layer );

    QgsMeshLayer *layer() const;
 
  private:
    QgsMeshTerrainProvider( const QgsMeshTerrainProvider &other );
 
    _LayerRef<QgsMeshLayer> mMeshLayer;
    QgsTriangularMesh mTriangularMesh;
};
 
#endif // QGSTERRAINPROVIDER_H