qgshillshaderenderer.h

Go to the documentation of this file.

/***************************************************************************
                         qgshillshaderenderer.cpp
                         ---------------------------------
    begin                : May 2016
    copyright            : (C) 2016 by Nathan Woodrow
    email                : woodrow dot nathan 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 QGSHILLSHADERENDERER_H
#define QGSHILLSHADERENDERER_H
 
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrasterrenderer.h"
 
class QgsRasterBlock;
class QgsRectangle;
class QgsRasterInterface;
 
 
class CORE_EXPORT QgsHillshadeRenderer : public QgsRasterRenderer
{
  public:
 
    QgsHillshadeRenderer( QgsRasterInterface *input, int band, double lightAzimuth, double lightAltitude );
 
    QgsHillshadeRenderer *clone() const override SIP_FACTORY;
    Qgis::RasterRendererFlags flags() const override;
 
    static QgsRasterRenderer *create( const QDomElement &elem, QgsRasterInterface *input ) SIP_FACTORY;
 
    void writeXml( QDomDocument &doc, QDomElement &parentElem ) const override;
 
    QgsRasterBlock *block( int bandNo, const QgsRectangle &extent, int width, int height, QgsRasterBlockFeedback *feedback = nullptr ) override SIP_FACTORY;
 
    QList<int> usesBands() const override;
    int inputBand() const override;
 
    void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override;
 
    Q_DECL_DEPRECATED int band() const SIP_DEPRECATED { return mBand; }
 
    Q_DECL_DEPRECATED void setBand( int bandNo ) SIP_DEPRECATED;
    bool setInputBand( int band ) override;
 
    double azimuth() const { return mLightAzimuth; }
 
    double altitude()  const { return mLightAngle; }
 
    double zFactor()  const { return mZFactor; }
 
    bool multiDirectional() const { return mMultiDirectional; }
 
    void setAzimuth( double azimuth ) { mLightAzimuth = azimuth; }
 
    void setAltitude( double altitude ) { mLightAngle = altitude; }
 
    void setZFactor( double zfactor ) { mZFactor = zfactor; }
 
    void setMultiDirectional( bool isMultiDirectional ) { mMultiDirectional = isMultiDirectional; }
 
  private:
    int mBand = 1;
    double mZFactor = 1;
    double mLightAngle = 45;
    double mLightAzimuth = 315;
    bool mMultiDirectional = false;
 
};
 
#endif // QGSHILLSHADERENDERER_H