-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgspainteffect.h
405 lines (346 loc) · 13.8 KB
/
qgspainteffect.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
/***************************************************************************
qgspainteffect.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 QGSPAINTEFFECT_H
#define QGSPAINTEFFECT_H
#include "qgis_core.h"
#include "qgis.h"
#include <QPainter>
#include <QDomDocument>
#include <QDomElement>
class QgsRenderContext;
/** \ingroup core
* \class QgsPaintEffect
* \brief Base class for visual effects which can be applied to QPicture drawings
*
* QgsPaintEffect objects can be used to modify QPicture drawings prior to rendering
* them with a QPainter operation. There are two methods for drawing using an effect,
* either drawing a picture directly, or by intercepting drawing operations to a
* render context.
*
* To directly draw a picture, use the render() method with a source
* QPicture and destination render context.
*
* Intercepting drawing operations to a render context is achieved by first calling
* the begin() method, passing a render context. Any drawing operations
* performed on the render context will not directly affect the context's paint
* device. When the drawing operations have been completed, call the end()
* method. This will perform the paint effect on the intercepted drawing operations
* and render the result to the render context's paint device.
*
* \see QgsPaintEffectRegistry
* \since QGIS 2.9
*/
class CORE_EXPORT QgsPaintEffect
{
#ifdef SIP_RUN
SIP_CONVERT_TO_SUBCLASS_CODE
if ( sipCpp->type() == "drawSource" && dynamic_cast<QgsDrawSourceEffect *>( sipCpp ) != NULL )
{
sipType = sipType_QgsDrawSourceEffect;
}
else if ( sipCpp->type() == "effectStack" && dynamic_cast<QgsEffectStack *>( sipCpp ) != NULL )
{
sipType = sipType_QgsEffectStack;
}
else if ( sipCpp->type() == "blur" && dynamic_cast<QgsBlurEffect *>( sipCpp ) != NULL )
{
sipType = sipType_QgsBlurEffect;
}
else if ( sipCpp->type() == "dropShadow" && dynamic_cast<QgsDropShadowEffect *>( sipCpp ) != NULL )
{
sipType = sipType_QgsDropShadowEffect;
}
else if ( sipCpp->type() == "outerGlow" && dynamic_cast<QgsOuterGlowEffect *>( sipCpp ) != NULL )
{
sipType = sipType_QgsOuterGlowEffect;
}
else if ( sipCpp->type() == "innerGlow" && dynamic_cast<QgsInnerGlowEffect *>( sipCpp ) != NULL )
{
sipType = sipType_QgsInnerGlowEffect;
}
else if ( sipCpp->type() == "transform" && dynamic_cast<QgsTransformEffect *>( sipCpp ) != NULL )
{
sipType = sipType_QgsTransformEffect;
}
else if ( sipCpp->type() == "color" && dynamic_cast<QgsColorEffect *>( sipCpp ) != NULL )
{
sipType = sipType_QgsColorEffect;
}
else
{
sipType = 0;
}
SIP_END
#endif
public:
/** Drawing modes for effects. These modes are used only when effects are
* drawn as part of an effects stack
* \see QgsEffectStack
*/
enum DrawMode
{
Modifier, //!< The result of the effect is not rendered, but is passed on to following effects in the stack
Render, //!< The result of the effect is rendered on the destination, but does not affect subsequent effects in the stack
ModifyAndRender //!< The result of the effect is both rendered and passed on to subsequent effects in the stack
};
QgsPaintEffect();
QgsPaintEffect( const QgsPaintEffect &other );
virtual ~QgsPaintEffect();
/** Returns the effect type.
* \returns unique string representation of the effect type
*/
virtual QString type() const = 0;
/** Duplicates an effect by creating a deep copy of the effect
* \returns clone of paint effect
*/
virtual QgsPaintEffect *clone() const = 0 SIP_FACTORY;
/** Returns the properties describing the paint effect encoded in a
* string format.
* \returns string map of properties, in the form property key, value
* \see readProperties
* \see saveProperties
*/
virtual QgsStringMap properties() const = 0;
/** Reads a string map of an effect's properties and restores the effect
* to the state described by the properties map.
* \param props effect properties encoded in a string map
* \see properties
*/
virtual void readProperties( const QgsStringMap &props ) = 0;
/** Saves the current state of the effect to a DOM element. The default
* behavior is to save the properties string map returned by
* properties().
* \param doc destination DOM document
* \param element destination DOM element
* \returns true if save was successful
* \see readProperties
*/
virtual bool saveProperties( QDomDocument &doc, QDomElement &element ) const;
/** Restores the effect to the state described by a DOM element.
* \param element DOM element describing an effect's state
* \returns true if read was successful
* \see saveProperties
*/
virtual bool readProperties( const QDomElement &element );
/** Renders a picture using the effect.
* \param picture source QPicture to render
* \param context destination render context
* \see begin
*/
virtual void render( QPicture &picture, QgsRenderContext &context );
/** Begins intercepting paint operations to a render context. When the corresponding
* end() member is called all intercepted paint operations will be
* drawn to the render context after being modified by the effect.
* \param context destination render context
* \see end
* \see render
*/
virtual void begin( QgsRenderContext &context );
/** Ends interception of paint operations to a render context, and draws the result
* to the render context after being modified by the effect.
* \param context destination render context
* \see begin
*/
virtual void end( QgsRenderContext &context );
/** Returns whether the effect is enabled
* \returns true if effect is enabled
* \see setEnabled
*/
bool enabled() const { return mEnabled; }
/** Sets whether the effect is enabled
* \param enabled set to false to disable the effect
* \see enabled
*/
void setEnabled( const bool enabled );
/** Returns the draw mode for the effect. This property only has an
* effect if the paint effect is used in a QgsEffectStack.
* \returns draw mode for effect
* \see setDrawMode
*/
DrawMode drawMode() const { return mDrawMode; }
/** Sets the draw mode for the effect. This property only has an
* effect if the paint effect is used in a QgsEffectStack.
* \param drawMode draw mode for effect
* \see drawMode
*/
void setDrawMode( const DrawMode drawMode );
protected:
bool mEnabled;
DrawMode mDrawMode;
bool requiresQPainterDpiFix;
/** Handles drawing of the effect's result on to the specified render context.
* Derived classes must reimplement this method to apply any transformations to
* the source QPicture and draw the result using the context's painter.
* \param context destination render context
* \see drawSource
*/
virtual void draw( QgsRenderContext &context ) = 0;
/** Draws the source QPicture onto the specified painter. Handles scaling of the picture
* to account for the destination painter's DPI.
* \param painter destination painter
* \see source
* \see sourceAsImage
*/
void drawSource( QPainter &painter );
/** Returns the source QPicture. The draw() member can utilize this when
* drawing the effect.
* \returns source QPicture
* \see drawSource
* \see sourceAsImage
*/
const QPicture *source() const { return mPicture; }
/** Returns the source QPicture rendered to a new QImage. The draw() member can
* utilize this when drawing the effect. The image will be padded or cropped from the original
* source QPicture by the results of the boundingRect() method.
* The result is cached to speed up subsequent calls to sourceAsImage.
* \returns source QPicture rendered to an image
* \see drawSource
* \see source
* \see imageOffset
* \see boundingRect
*/
QImage *sourceAsImage( QgsRenderContext &context );
/** Returns the offset which should be used when drawing the source image on to a destination
* render context.
* \param context destination render context
* \returns point offset for image top left corner
* \see sourceAsImage
*/
QPointF imageOffset( const QgsRenderContext &context ) const;
/** Returns the bounding rect required for drawing the effect. This method can be used
* to expand the bounding rect of a source picture to account for offset or blurring
* effects.
* \param rect original source bounding rect
* \param context destination render context
* \returns modified bounding rect
* \see sourceAsImage
*/
virtual QRectF boundingRect( const QRectF &rect, const QgsRenderContext &context ) const;
/** Applies a workaround to a QPainter to avoid an issue with incorrect scaling
* when drawing QPictures. This may need to be called by derived classes prior
* to rendering results onto a painter.
* \param painter destination painter
*/
void fixQPictureDpi( QPainter *painter ) const;
private:
const QPicture *mPicture = nullptr;
QImage *mSourceImage = nullptr;
bool mOwnsImage;
QPainter *mPrevPainter = nullptr;
QPainter *mEffectPainter = nullptr;
QPicture *mTempPicture = nullptr;
QRectF imageBoundingRect( const QgsRenderContext &context ) const;
friend class QgsEffectStack;
};
/** \ingroup core
* \class QgsDrawSourceEffect
* \brief A paint effect which draws the source picture with minor or no alterations
*
* The draw source effect can be used to draw an unaltered copy of the original source
* picture. Minor changes like lowering the opacity and applying a blend mode are
* supported, however these changes will force the resultant output to be rasterized.
* If no alterations are performed then the original picture will be rendered as a vector.
*
* \since QGIS 2.9
*/
class CORE_EXPORT QgsDrawSourceEffect : public QgsPaintEffect
{
public:
QgsDrawSourceEffect();
/** Creates a new QgsDrawSource effect from a properties string map.
* \param map encoded properties string map
* \returns new QgsDrawSourceEffect
*/
static QgsPaintEffect *create( const QgsStringMap &map ) SIP_FACTORY;
virtual QString type() const override { return QStringLiteral( "drawSource" ); }
virtual QgsDrawSourceEffect *clone() const override SIP_FACTORY;
virtual QgsStringMap properties() const override;
virtual void readProperties( const QgsStringMap &props ) override;
/** Sets the \a opacity for the effect.
* \param opacity double between 0 and 1 inclusive, where 0 is fully transparent
* and 1 is fully opaque
* \see opacity()
*/
void setOpacity( const double opacity ) { mOpacity = opacity; }
/** Returns the opacity for the effect
* \returns opacity value between 0 and 1 inclusive, where 0 is fully transparent
* and 1 is fully opaque
* \see setOpacity()
*/
double opacity() const { return mOpacity; }
/** Sets the blend mode for the effect
* \param mode blend mode used for drawing the source on to a destination
* paint device
* \see blendMode
*/
void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }
/** Returns the blend mode for the effect
* \returns blend mode used for drawing the source on to a destination
* paint device
* \see setBlendMode
*/
QPainter::CompositionMode blendMode() const { return mBlendMode; }
protected:
virtual void draw( QgsRenderContext &context ) override;
private:
double mOpacity = 1.0;
QPainter::CompositionMode mBlendMode;
};
/** \ingroup core
* \class QgsEffectPainter
* \brief A class to manager painter saving and restoring required for effect drawing
*
* \since QGIS 3.0
*/
class CORE_EXPORT QgsEffectPainter
{
public:
/**
* QgsEffectPainter constructor
*
* \param renderContext the QgsRenderContext object
* \since QGIS 3.0
*/
QgsEffectPainter( QgsRenderContext &renderContext );
/**
* QgsEffectPainter constructor alternative if no painter translation is needed
*
* \param renderContext the QgsRenderContext object
* \param effect the QgsPaintEffect object
* \since QGIS 3.0
*/
QgsEffectPainter( QgsRenderContext &renderContext, QgsPaintEffect *effect );
~QgsEffectPainter();
/**
* Sets the effect to be painted
*
* \param effect the QgsPaintEffect object
*/
void setEffect( QgsPaintEffect *effect );
///@cond PRIVATE
/**
* Access to the painter object
*
* \since QGIS 3.0
*/
QPainter *operator->() { return mPainter; }
///@endcond
private:
QgsRenderContext &mRenderContext;
QPainter *mPainter = nullptr;
QgsPaintEffect *mEffect = nullptr;
};
#endif // QGSPAINTEFFECT_H