QGIS API Documentation 3.43.0-Master (c67cf405802)
qgsshadoweffect.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsshadoweffect.h
3 -----------------
4 begin : December 2014
5 copyright : (C) 2014 Nyall Dawson
6 email : nyall dot dawson at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17#ifndef QGSSHADOWEFFECT_H
18#define QGSSHADOWEFFECT_H
19
20#include "qgis_core.h"
21#include "qgspainteffect.h"
22#include "qgis_sip.h"
23#include "qgsmapunitscale.h"
24#include "qgis.h"
25
26#include <QPainter>
27
34{
35
36 public:
37
39
40 QVariantMap properties() const override;
41 void readProperties( const QVariantMap &props ) override;
42
51 void setBlurLevel( const double level ) { mBlurLevel = level; }
52
61 double blurLevel() const { return mBlurLevel; }
62
71 void setBlurUnit( const Qgis::RenderUnit unit ) { mBlurUnit = unit; }
72
81 Qgis::RenderUnit blurUnit() const { return mBlurUnit; }
82
91 void setBlurMapUnitScale( const QgsMapUnitScale &scale ) { mBlurMapUnitScale = scale; }
92
101 const QgsMapUnitScale &blurMapUnitScale() const { return mBlurMapUnitScale; }
102
109 void setOffsetAngle( const int angle ) { mOffsetAngle = angle; }
110
117 int offsetAngle() const { return mOffsetAngle; }
118
126 void setOffsetDistance( const double distance ) { mOffsetDist = distance; }
127
135 double offsetDistance() const { return mOffsetDist; }
136
144 void setOffsetUnit( const Qgis::RenderUnit unit ) { mOffsetUnit = unit; }
145
153 Qgis::RenderUnit offsetUnit() const { return mOffsetUnit; }
154
162 void setOffsetMapUnitScale( const QgsMapUnitScale &scale ) { mOffsetMapUnitScale = scale; }
163
171 const QgsMapUnitScale &offsetMapUnitScale() const { return mOffsetMapUnitScale; }
172
178 void setColor( const QColor &color ) { mColor = color; }
179
185 QColor color() const { return mColor; }
186
193 void setOpacity( const double opacity ) { mOpacity = opacity; }
194
201 double opacity() const { return mOpacity; }
202
209 void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
210
217 QPainter::CompositionMode blendMode() const { return mBlendMode; }
218
219 protected:
220
221 QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const override;
222 void draw( QgsRenderContext &context ) override;
223
230 virtual bool exteriorShadow() const = 0;
231
232 double mBlurLevel = 2.645;
235 int mOffsetAngle = 135;
236 double mOffsetDist = 2.0;
239 double mOpacity = 1.0;
240 QColor mColor;
241 QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_Multiply;
242
243};
244
245
253{
254
255 public:
256
262 static QgsPaintEffect *create( const QVariantMap &map ) SIP_FACTORY;
263
265
266 QString type() const override;
267 QgsDropShadowEffect *clone() const override SIP_FACTORY;
268
269 protected:
270
271 bool exteriorShadow() const override;
272
273};
274
283{
284
285 public:
286
292 static QgsPaintEffect *create( const QVariantMap &map ) SIP_FACTORY;
293
295
296 QString type() const override;
297 QgsInnerShadowEffect *clone() const override SIP_FACTORY;
298
299 protected:
300
301 bool exteriorShadow() const override;
302
303};
304
305#endif // QGSSHADOWEFFECT_H
306
RenderUnit
Rendering size units.
Definition qgis.h:5013
@ Millimeters
Millimeters.
A paint effect which draws an offset and optionally blurred drop shadow.
A paint effect which draws an offset and optionally blurred drop shadow within a picture.
Struct for storing maximum and minimum scales for measurements in map units.
Base class for visual effects which can be applied to QPicture drawings.
virtual void readProperties(const QVariantMap &props)=0
Reads a string map of an effect's properties and restores the effect to the state described by the pr...
virtual QgsPaintEffect * clone() const =0
Duplicates an effect by creating a deep copy of the effect.
virtual QRectF boundingRect(const QRectF &rect, const QgsRenderContext &context) const
Returns the bounding rect required for drawing the effect.
virtual QVariantMap properties() const =0
Returns the properties describing the paint effect encoded in a string format.
virtual void draw(QgsRenderContext &context)=0
Handles drawing of the effect's result on to the specified render context.
virtual QString type() const =0
Returns the effect type.
Contains information about the context of a rendering operation.
Base class for paint effects which render offset, blurred shadows.
int offsetAngle() const
Returns the angle used for offsetting the shadow.
void setOffsetAngle(const int angle)
Sets the angle for offsetting the shadow.
void setOpacity(const double opacity)
Sets the opacity for the effect.
void setColor(const QColor &color)
Sets the color for the shadow.
double opacity() const
Returns the opacity for the effect.
Qgis::RenderUnit offsetUnit() const
Returns the units used for the shadow offset distance.
QColor color() const
Returns the color used for the shadow.
virtual bool exteriorShadow() const =0
Specifies whether the shadow is drawn outside the picture or within the picture.
QPainter::CompositionMode blendMode() const
Returns the blend mode for the effect.
Qgis::RenderUnit blurUnit() const
Returns the units used for the shadow blur level (radius).
void setBlurLevel(const double level)
Sets blur level (radius) for the shadow.
void setOffsetUnit(const Qgis::RenderUnit unit)
Sets the units used for the shadow offset distance.
void setOffsetDistance(const double distance)
Sets the distance for offsetting the shadow.
QgsMapUnitScale mOffsetMapUnitScale
double blurLevel() const
Returns the blur level (radius) for the shadow.
void setBlurUnit(const Qgis::RenderUnit unit)
Sets the units used for the shadow blur level (radius).
const QgsMapUnitScale & offsetMapUnitScale() const
Returns the map unit scale used for the shadow offset distance.
void setOffsetMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale used for the shadow offset distance.
void setBlendMode(const QPainter::CompositionMode mode)
Sets the blend mode for the effect.
double offsetDistance() const
Returns the distance used for offsetting the shadow.
QgsMapUnitScale mBlurMapUnitScale
const QgsMapUnitScale & blurMapUnitScale() const
Returns the map unit scale used for the shadow blur strength (radius).
void setBlurMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale used for the shadow blur strength (radius).
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_NODEFAULTCTORS
Definition qgis_sip.h:101