qgsshadoweffect.h

Go to the documentation of this file.

/***************************************************************************
                             qgsshadoweffect.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 QGSSHADOWEFFECT_H
#define QGSSHADOWEFFECT_H

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

class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect
{

  public:

    QgsShadowEffect();
    virtual ~QgsShadowEffect();

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

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

    int blurLevel() const { return mBlurLevel; }

    void setOffsetAngle( const int angle ) { mOffsetAngle = angle; }

    int offsetAngle() const { return mOffsetAngle; }

    void setOffsetDistance( const double distance ) { mOffsetDist = distance; }

    double offsetDistance() const { return mOffsetDist; }

    void setOffsetUnit( const QgsSymbolV2::OutputUnit unit ) { mOffsetUnit = unit; }

    QgsSymbolV2::OutputUnit offsetUnit() const { return mOffsetUnit; }

    void setOffsetMapUnitScale( const QgsMapUnitScale& scale ) { mOffsetMapUnitScale = scale; }

    const QgsMapUnitScale& offsetMapUnitScale() const { return mOffsetMapUnitScale; }

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

    QColor color() const { return mColor; }

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

    double transparency() const { return mTransparency; }

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

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

  protected:

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

    virtual bool exteriorShadow() const = 0;

    int mBlurLevel;
    int mOffsetAngle;
    double mOffsetDist;
    QgsSymbolV2::OutputUnit mOffsetUnit;
    QgsMapUnitScale mOffsetMapUnitScale;
    double mTransparency;
    QColor mColor;
    QPainter::CompositionMode mBlendMode;

};


class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect
{

  public:

    static QgsPaintEffect* create( const QgsStringMap& map );

    QgsDropShadowEffect();
    virtual ~QgsDropShadowEffect();

    virtual QString type() const override { return QString( "dropShadow" ); }
    virtual QgsDropShadowEffect* clone() const override;

  protected:

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

};

class CORE_EXPORT QgsInnerShadowEffect : public QgsShadowEffect
{

  public:

    static QgsPaintEffect* create( const QgsStringMap& map );

    QgsInnerShadowEffect();
    virtual ~QgsInnerShadowEffect();

    virtual QString type() const override { return QString( "innerShadow" ); }
    virtual QgsInnerShadowEffect* clone() const override;

  protected:

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

};

#endif // QGSSHADOWEFFECT_H