qgsgloweffect.h

Go to the documentation of this file.

/***************************************************************************
                             qgsgloweffect.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 QGSGLOWEFFECT_H
#define QGSGLOWEFFECT_H

#include "qgspainteffect.h"
#include "qgssymbolv2.h"
#include <QPainter>

class QgsVectorColorRampV2;

class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
{

  public:

    enum GlowColorType
    {
      SingleColor, 
      ColorRamp 
    };

    QgsGlowEffect();
    QgsGlowEffect( const QgsGlowEffect& other );
    virtual ~QgsGlowEffect();

    virtual QgsStringMap properties() const override;
    virtual void readProperties( const QgsStringMap& props ) override;

    void setSpread( const double spread ) { mSpread = spread; }

    double spread() const { return mSpread; }

    void setSpreadUnit( const QgsSymbolV2::OutputUnit unit ) { mSpreadUnit = unit; }

    QgsSymbolV2::OutputUnit spreadUnit() const { return mSpreadUnit; }

    void setSpreadMapUnitScale( const QgsMapUnitScale& scale ) { mSpreadMapUnitScale = scale; }

    const QgsMapUnitScale& spreadMapUnitScale() const { return mSpreadMapUnitScale; }

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

    int blurLevel() const { return mBlurLevel; }

    void setTransparency( const double transparency ) { mTransparency = transparency; }

    double transparency() const { return mTransparency; }

    void setColor( const QColor& color ) { mColor = color; }

    QColor color() const { return mColor; }

    void setRamp( QgsVectorColorRampV2* ramp );

    QgsVectorColorRampV2* ramp() const { return mRamp; }

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

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

    void setColorType( GlowColorType colorType ) { mColorType = colorType; }

    GlowColorType colorType() const { return mColorType; }

    QgsGlowEffect& operator=( const QgsGlowEffect& rhs );

  protected:

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

    virtual bool shadeExterior() const = 0;

    double mSpread;
    QgsSymbolV2::OutputUnit mSpreadUnit;
    QgsMapUnitScale mSpreadMapUnitScale;
    QgsVectorColorRampV2* mRamp;
    int mBlurLevel;
    double mTransparency;
    QColor mColor;
    QPainter::CompositionMode mBlendMode;
    GlowColorType mColorType;

};


class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect
{

  public:

    static QgsPaintEffect* create( const QgsStringMap& map );

    QgsOuterGlowEffect();
    virtual ~QgsOuterGlowEffect();

    virtual QString type() const override { return QString( "outerGlow" ); }
    virtual QgsOuterGlowEffect* clone() const override;

  protected:

    virtual bool shadeExterior() const override { return true; }

};


class CORE_EXPORT QgsInnerGlowEffect : public QgsGlowEffect
{

  public:

    static QgsPaintEffect* create( const QgsStringMap& map );

    QgsInnerGlowEffect();
    virtual ~QgsInnerGlowEffect();

    virtual QString type() const override { return QString( "innerGlow" ); }
    virtual QgsInnerGlowEffect* clone() const override;

  protected:

    virtual bool shadeExterior() const override { return false; }

};

#endif // QGSGLOWEFFECT_H