qgselevationshadingrenderer.h

Go to the documentation of this file.

/***************************************************************************
  qgselevationshadingrenderer.h - QgsElevationShadingRenderer
 
 ---------------------
 begin                : 4.12.2022
 copyright            : (C) 2022 by Vincent Cloarec
 email                : vcloarec 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 QGSELEVATIONSHADINGRENDERER_H
#define QGSELEVATIONSHADINGRENDERER_H
 
#include "qgis.h"
#include "qgis_sip.h"
#include "qgselevationmap.h"
 
class QImage;
class QgsElevationMap;
class QgsRenderContext;
class QgsMapSettings;
class QDomDocument;
class QgsReadWriteContext;
class QDomElement;

class CORE_EXPORT QgsElevationShadingRenderer
{
  public:
    QgsElevationShadingRenderer();

    void renderShading( const QgsElevationMap &elevation, QImage &image, const QgsRenderContext &context ) const;

    void setActive( bool active );

    bool isActive() const;

    void setActiveEyeDomeLighting( bool active );

    bool isActiveEyeDomeLighting() const;

    double eyeDomeLightingStrength() const;

    void setEyeDomeLightingStrength( double strength );

    double eyeDomeLightingDistance() const;

    void setEyeDomeLightingDistance( double distance );

    Qgis::RenderUnit eyeDomeLightingDistanceUnit() const;

    void setEyeDomeLightingDistanceUnit( Qgis::RenderUnit unit );

    void setActiveHillshading( bool active );

    bool isActiveHillshading() const;

    double hillshadingZFactor() const;

    void setHillshadingZFactor( double zFactor );

    bool isHillshadingMultidirectional() const;

    void setHillshadingMultidirectional( bool multiDirectional );

    double lightAltitude() const;

    void setLightAltitude( double lightAltitude );

    double lightAzimuth() const;

    void setLightAzimuth( double lightAzimuth );

    void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const;

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

    Qgis::ElevationMapCombineMethod combinedElevationMethod() const;

    void setCombinedElevationMethod( Qgis::ElevationMapCombineMethod method );
 
  private:
    bool mIsActive = false;
 
    Qgis::ElevationMapCombineMethod mCombinedElevationMethod = Qgis::ElevationMapCombineMethod::HighestElevation;
 
    bool mRenderEdl = true;
    double mEyeDomeLightingStrength = 1000.0;
    double mEyeDomeLightingDistance = 0.5;
    Qgis::RenderUnit mEyeDomeLightingDistanceUnit = Qgis::RenderUnit::Millimeters;
 
    bool mRenderHillshading = false;
    double mLightAltitude = 45.0;
    double mLightAzimuth = 315.0;
    double mHillshadingZFactor = 1.0;
    bool mHillshadingMultiDir = false;
 
    void renderEdl( const QgsElevationMap &elevation, QImage &image, const QgsRenderContext &context ) const;
    void renderHillshading( const QgsElevationMap &elevation, QImage &image, const QgsRenderContext &context ) const;
};
 
#endif // QGSELEVATIONSHADINGRENDERER_H