qgselevationmap.h

Go to the documentation of this file.

/***************************************************************************
  qgselevationmap.h
  --------------------------------------
  Date                 : August 2022
  Copyright            : (C) 2022 by Martin Dobias
  Email                : wonder dot sk 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 QGSELEVATIONMAP_H
#define QGSELEVATIONMAP_H
 
#include "qgis.h"
#include "qgis_sip.h"
 
#include <QImage>
#include <memory>
 
class QgsRasterBlock;
 
class CORE_EXPORT QgsElevationMap
{
  public:
 
    QgsElevationMap() = default;
 
    explicit QgsElevationMap( const QSize &size );
 
    explicit QgsElevationMap( const QImage &image );
 
    QgsElevationMap( const QgsElevationMap &other );
 
    void applyEyeDomeLighting( QImage &image, int distance, float strength, float rendererScale ) const;
 
    void applyHillshading( QImage &image, bool multiDirectional, double altitude, double azimuth, double zFactor, double cellSizeX, double cellSizeY ) const;
 
    QImage rawElevationImage() const { return mElevationImage; }
 
    QPainter *painter() const;
 
    void combine( const QgsElevationMap &otherElevationMap, Qgis::ElevationMapCombineMethod method );
 
    void fillWithRasterBlock( QgsRasterBlock *block, int top, int left, double zScale = 1.0, double offset = 0.0 ) SIP_SKIP;
 
    bool isValid() const;
 
    static QRgb encodeElevation( float z );
    static float decodeElevation( QRgb colorRaw );
 
    static std::unique_ptr<QgsElevationMap> fromRasterBlock( QgsRasterBlock *block ) SIP_SKIP;
 
    inline bool isNoData( QRgb colorRaw ) const {return colorRaw == 0;}
 
    inline float noDataValue() const {return decodeElevation( 0 );}
 
    QgsElevationMap &operator=( const QgsElevationMap &other );
 
  private:
 
    mutable QImage mElevationImage;
    mutable std::unique_ptr<QPainter> mPainter;
};
 
#endif // QGSELEVATIONMAP_H