qgsblureffect.h

Go to the documentation of this file.

/***************************************************************************
                             qgsblureffect.h
                             ---------------
    begin                : December 2014
    copyright            : (C) 2014 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 QGSBLUREFFECT_H
#define QGSBLUREFFECT_H

#include "qgis_core.h"
#include "qgspainteffect.h"
#include "qgsunittypes.h"
#include "qgsmapunitscale.h"
#include "qgis.h"
#include <QPainter>

class CORE_EXPORT QgsBlurEffect : public QgsPaintEffect
{

  public:

    enum BlurMethod
    {
      StackBlur, 
      GaussianBlur 
    };

    static QgsPaintEffect *create( const QgsStringMap &map ) SIP_FACTORY;

    QgsBlurEffect() = default;

    QString type() const override { return QStringLiteral( "blur" ); }
    QgsStringMap properties() const override;
    void readProperties( const QgsStringMap &props ) override;
    QgsBlurEffect *clone() const override SIP_FACTORY;

    void setBlurLevel( const double level ) { mBlurLevel = level; }

    double blurLevel() const { return mBlurLevel; }

    void setBlurUnit( const QgsUnitTypes::RenderUnit unit ) { mBlurUnit = unit; }

    QgsUnitTypes::RenderUnit blurUnit() const { return mBlurUnit; }

    void setBlurMapUnitScale( const QgsMapUnitScale &scale ) { mBlurMapUnitScale = scale; }

    const QgsMapUnitScale &blurMapUnitScale() const { return mBlurMapUnitScale; }

    void setBlurMethod( const BlurMethod method ) { mBlurMethod = method; }

    BlurMethod blurMethod() const { return mBlurMethod; }

    void setOpacity( const double opacity ) { mOpacity = opacity; }

    double opacity() const { return mOpacity; }

    void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }

    QPainter::CompositionMode blendMode() const { return mBlendMode; }

  protected:

    void draw( QgsRenderContext &context ) override;
    QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const override;

  private:

    double mBlurLevel = 2.645;
    QgsUnitTypes::RenderUnit mBlurUnit = QgsUnitTypes::RenderMillimeters;
    QgsMapUnitScale mBlurMapUnitScale;
    BlurMethod mBlurMethod = StackBlur;
    double mOpacity = 1.0;
    QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;

    void drawStackBlur( QgsRenderContext &context );
    void drawGaussianBlur( QgsRenderContext &context );
    void drawBlurredImage( QgsRenderContext &context, QImage &image );
};

#endif // QGSBLUREFFECT_H