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 "qgis_core.h"
#include "qgspainteffect.h"
#include "qgis_sip.h"
#include "qgsmapunitscale.h"
#include "qgis.h"
 
#include <QPainter>
 
class CORE_EXPORT QgsShadowEffect : public QgsPaintEffect SIP_NODEFAULTCTORS
{
 
  public:
 
    QgsShadowEffect();
 
    QVariantMap properties() const override;
    void readProperties( const QVariantMap &props ) override;
 
    void setBlurLevel( const double level ) { mBlurLevel = level; }
 
    double blurLevel() const { return mBlurLevel; }
 
    void setBlurUnit( const Qgis::RenderUnit unit ) { mBlurUnit = unit; }
 
    Qgis::RenderUnit blurUnit() const { return mBlurUnit; }
 
    void setBlurMapUnitScale( const QgsMapUnitScale &scale ) { mBlurMapUnitScale = scale; }
 
    const QgsMapUnitScale &blurMapUnitScale() const { return mBlurMapUnitScale; }
 
    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 Qgis::RenderUnit unit ) { mOffsetUnit = unit; }
 
    Qgis::RenderUnit 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 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:
 
    QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const override;
    void draw( QgsRenderContext &context ) override;
 
    virtual bool exteriorShadow() const = 0;
 
    double mBlurLevel = 2.645;
    Qgis::RenderUnit mBlurUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mBlurMapUnitScale;
    int mOffsetAngle = 135;
    double mOffsetDist = 2.0;
    Qgis::RenderUnit mOffsetUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mOffsetMapUnitScale;
    double mOpacity = 1.0;
    QColor mColor;
    QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_Multiply;
 
};
 
 
class CORE_EXPORT QgsDropShadowEffect : public QgsShadowEffect SIP_NODEFAULTCTORS
{
 
  public:
 
    static QgsPaintEffect *create( const QVariantMap &map ) SIP_FACTORY;
 
    QgsDropShadowEffect();
 
    QString type() const override;
    QgsDropShadowEffect *clone() const override SIP_FACTORY;
 
  protected:
 
    bool exteriorShadow() const override;
 
};
 
class CORE_EXPORT QgsInnerShadowEffect : public QgsShadowEffect SIP_NODEFAULTCTORS
{
 
  public:
 
    static QgsPaintEffect *create( const QVariantMap &map ) SIP_FACTORY;
 
    QgsInnerShadowEffect();
 
    QString type() const override;
    QgsInnerShadowEffect *clone() const override SIP_FACTORY;
 
  protected:
 
    bool exteriorShadow() const override;
 
};
 
#endif // QGSSHADOWEFFECT_H