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 "qgis_core.h"
#include "qgis.h"
#include "qgspainteffect.h"
#include "qgssymbol.h"
#include "qgscolorramp.h"

#include <QPainter>


class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
{

  public:

    enum GlowColorType
    {
      SingleColor, 
      ColorRamp 
    };

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

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

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

    double spread() const { return mSpread; }

    void setSpreadUnit( const QgsUnitTypes::RenderUnit unit ) { mSpreadUnit = unit; }

    QgsUnitTypes::RenderUnit spreadUnit() const { return mSpreadUnit; }

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

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

    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 setOpacity( const double opacity ) { mOpacity = opacity; }

    double opacity() const { return mOpacity; }

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

    QColor color() const { return mColor; }

    void setRamp( QgsColorRamp *ramp SIP_TRANSFER );

    QgsColorRamp *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:

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

    virtual bool shadeExterior() const = 0;

    double mSpread = 2.0;
    QgsUnitTypes::RenderUnit mSpreadUnit = QgsUnitTypes::RenderMillimeters;
    QgsMapUnitScale mSpreadMapUnitScale;
    QgsColorRamp *mRamp = nullptr;
    double mBlurLevel = 2.645;
    QgsUnitTypes::RenderUnit mBlurUnit = QgsUnitTypes::RenderMillimeters;
    QgsMapUnitScale mBlurMapUnitScale;
    double mOpacity = 0.5;
    QColor mColor;
    QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
    GlowColorType mColorType = SingleColor;

};


class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect
{

  public:

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

    QgsOuterGlowEffect();

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

  protected:

    bool shadeExterior() const override { return true; }

};


class CORE_EXPORT QgsInnerGlowEffect : public QgsGlowEffect
{

  public:

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

    QgsInnerGlowEffect();

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

  protected:

    bool shadeExterior() const override { return false; }

};

#endif // QGSGLOWEFFECT_H