QGIS API Documentation 3.29.0-Master (53715c36dc)
qgsgloweffect.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsgloweffect.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 QGSGLOWEFFECT_H
18#define QGSGLOWEFFECT_H
19
20#include "qgis_core.h"
21#include "qgis.h"
22#include "qgspainteffect.h"
23#include "qgscolorramp.h"
24#include "qgsunittypes.h"
25#include "qgsmapunitscale.h"
26
27#include <QPainter>
28
29
39class CORE_EXPORT QgsGlowEffect : public QgsPaintEffect
40{
41
42 public:
43
46 {
48 ColorRamp
49 };
50
52 QgsGlowEffect( const QgsGlowEffect &other );
53 ~QgsGlowEffect() override;
54
55 QVariantMap properties() const override;
56 void readProperties( const QVariantMap &props ) override;
57
65 void setSpread( const double spread ) { mSpread = spread; }
66
74 double spread() const { return mSpread; }
75
83 void setSpreadUnit( const QgsUnitTypes::RenderUnit unit ) { mSpreadUnit = unit; }
84
92 QgsUnitTypes::RenderUnit spreadUnit() const { return mSpreadUnit; }
93
101 void setSpreadMapUnitScale( const QgsMapUnitScale &scale ) { mSpreadMapUnitScale = scale; }
102
110 const QgsMapUnitScale &spreadMapUnitScale() const { return mSpreadMapUnitScale; }
111
120 void setBlurLevel( const double level ) { mBlurLevel = level; }
121
129 double blurLevel() const { return mBlurLevel; }
130
139 void setBlurUnit( const QgsUnitTypes::RenderUnit unit ) { mBlurUnit = unit; }
140
149 QgsUnitTypes::RenderUnit blurUnit() const { return mBlurUnit; }
150
159 void setBlurMapUnitScale( const QgsMapUnitScale &scale ) { mBlurMapUnitScale = scale; }
160
169 const QgsMapUnitScale &blurMapUnitScale() const { return mBlurMapUnitScale; }
170
177 void setOpacity( const double opacity ) { mOpacity = opacity; }
178
185 double opacity() const { return mOpacity; }
186
195 void setColor( const QColor &color ) { mColor = color; }
196
205 QColor color() const { return mColor; }
206
214 void setRamp( QgsColorRamp *ramp SIP_TRANSFER );
215
223 QgsColorRamp *ramp() const { return mRamp; }
224
231 void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
232
239 QPainter::CompositionMode blendMode() const { return mBlendMode; }
240
250 void setColorType( GlowColorType colorType ) { mColorType = colorType; }
251
260 GlowColorType colorType() const { return mColorType; }
261
262 QgsGlowEffect &operator=( const QgsGlowEffect &rhs );
263
264 protected:
265
266 QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const override;
267 void draw( QgsRenderContext &context ) override;
268
275 virtual bool shadeExterior() const = 0;
276
277 double mSpread = 2.0;
280 QgsColorRamp *mRamp = nullptr;
281 double mBlurLevel = 2.645;
284 double mOpacity = 0.5;
285 QColor mColor;
286 QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;
287 GlowColorType mColorType = SingleColor;
288
289};
290
291
300class CORE_EXPORT QgsOuterGlowEffect : public QgsGlowEffect
301{
302
303 public:
304
310 static QgsPaintEffect *create( const QVariantMap &map ) SIP_FACTORY;
311
313
314 QString type() const override { return QStringLiteral( "outerGlow" ); }
315 QgsOuterGlowEffect *clone() const override SIP_FACTORY;
316
317 protected:
318
319 bool shadeExterior() const override { return true; }
320
321};
322
323
332class CORE_EXPORT QgsInnerGlowEffect : public QgsGlowEffect
333{
334
335 public:
336
342 static QgsPaintEffect *create( const QVariantMap &map ) SIP_FACTORY;
343
345
346 QString type() const override { return QStringLiteral( "innerGlow" ); }
347 QgsInnerGlowEffect *clone() const override SIP_FACTORY;
348
349 protected:
350
351 bool shadeExterior() const override { return false; }
352
353};
354
355#endif // QGSGLOWEFFECT_H
356
Abstract base class for color ramps.
Definition: qgscolorramp.h:30
Base class for paint effect which draw a glow inside or outside a picture.
Definition: qgsgloweffect.h:40
QgsUnitTypes::RenderUnit spreadUnit() const
Returns the units used for the glow spread distance.
Definition: qgsgloweffect.h:92
void setSpread(const double spread)
Sets the spread distance for drawing the glow effect.
Definition: qgsgloweffect.h:65
void setColorType(GlowColorType colorType)
Sets the color mode to use for the glow.
void setSpreadMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale used for the spread distance.
void setOpacity(const double opacity)
Sets the opacity for the effect.
QgsMapUnitScale mBlurMapUnitScale
double spread() const
Returns the spread distance used for drawing the glow effect.
Definition: qgsgloweffect.h:74
virtual bool shadeExterior() const =0
Specifies whether the glow is drawn outside the picture or within the picture.
const QgsMapUnitScale & spreadMapUnitScale() const
Returns the map unit scale used for the spread distance.
GlowColorType
Color sources for the glow.
Definition: qgsgloweffect.h:46
@ SingleColor
Use a single color and fade the color to totally transparent.
Definition: qgsgloweffect.h:47
QPainter::CompositionMode blendMode() const
Returns the blend mode for the effect.
double blurLevel() const
Returns the blur level (radius) for the glow.
double opacity() const
Returns the opacity for the effect.
void setBlendMode(const QPainter::CompositionMode mode)
Sets the blend mode for the effect.
QColor color() const
Returns the color for the glow.
const QgsMapUnitScale & blurMapUnitScale() const
Returns the map unit scale used for the glow blur strength (radius).
QgsUnitTypes::RenderUnit blurUnit() const
Returns the units used for the glow blur level (radius).
void setBlurLevel(const double level)
Sets blur level (radius) for the glow.
void setSpreadUnit(const QgsUnitTypes::RenderUnit unit)
Sets the units used for the glow spread distance.
Definition: qgsgloweffect.h:83
QgsColorRamp * ramp() const
Returns the color ramp used for the glow.
QgsMapUnitScale mSpreadMapUnitScale
void setBlurUnit(const QgsUnitTypes::RenderUnit unit)
Sets the units used for the glow blur level (radius).
void setColor(const QColor &color)
Sets the color for the glow.
GlowColorType colorType() const
Returns the color mode used for the glow.
void setBlurMapUnitScale(const QgsMapUnitScale &scale)
Sets the map unit scale used for the glow blur strength (radius).
A paint effect which draws a glow within a picture.
QString type() const override
Returns the effect type.
Struct for storing maximum and minimum scales for measurements in map units.
A paint effect which draws a glow outside of a picture.
QString type() const override
Returns the effect type.
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.
Contains information about the context of a rendering operation.
RenderUnit
Rendering size units.
Definition: qgsunittypes.h:168
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:169
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_FACTORY
Definition: qgis_sip.h:76