-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
qgslayoutitempicture.h
361 lines (298 loc) · 11.5 KB
/
qgslayoutitempicture.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
/***************************************************************************
qgslayoutitempicture.h
-------------------
begin : October 2017
copyright : (C) 2017 by 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 QGSLAYOUTITEMPICTURE_H
#define QGSLAYOUTITEMPICTURE_H
#include "qgis_core.h"
#include "qgslayoutitem.h"
#include <QFile>
#include <QImage>
#include <QSvgRenderer>
class QgsLayoutItemMap;
class QgsExpression;
/**
* \ingroup core
* A layout item subclass that displays SVG files or raster format images (jpg, png, ...).
* \since QGIS 3.0
*/
class CORE_EXPORT QgsLayoutItemPicture: public QgsLayoutItem
{
Q_OBJECT
public:
/**
* Controls how pictures are scaled within the item's frame
*/
enum ResizeMode
{
Zoom, //!< Enlarges image to fit frame while maintaining aspect ratio of picture
Stretch, //!< Stretches image to fit frame, ignores aspect ratio
Clip, //!< Draws image at original size and clips any portion which falls outside frame
ZoomResizeFrame, //!< Enlarges image to fit frame, then resizes frame to fit resultant image
FrameToImageSize //!< Sets size of frame to match original size of image without scaling
};
/**
* Format of source image
*/
enum Format
{
FormatSVG, //!< SVG image
FormatRaster, //!< Raster image
FormatUnknown, //!< Invalid or unknown image type
};
//! Method for syncing rotation to a map's North direction
enum NorthMode
{
GridNorth = 0, //!< Align to grid north
TrueNorth, //!< Align to true north
};
/**
* Constructor for QgsLayoutItemPicture, with the specified parent \a layout.
*/
QgsLayoutItemPicture( QgsLayout *layout );
int type() const override;
QString stringType() const override;
/**
* Returns a new picture item for the specified \a layout.
*
* The caller takes responsibility for deleting the returned object.
*/
static QgsLayoutItemPicture *create( QgsLayout *layout ) SIP_FACTORY;
/**
* Sets the source \a path of the image (may be svg or a raster format). Data defined
* picture source may override this value. The path can either be a local path
* or a remote (http) path.
* \see picturePath()
*/
void setPicturePath( const QString &path );
/**
* Returns the path of the source image. Data defined picture source may override
* this value. The path can either be a local path or a remote (http) path.
* \returns path for the source image
* \see usePictureExpression()
* \see setPicturePath()
*/
QString picturePath() const;
#if 0
/**
* Sets this items bound in scene coordinates such that 1 item size units
* corresponds to 1 scene size unit and resizes the svg symbol / image
*/
void setSceneRect( const QRectF &rectangle ) override;
#endif
/**
* Returns the rotation used for drawing the picture within the item's frame,
* in degrees clockwise.
* \see setPictureRotation()
* \see rotationMap()
*/
double pictureRotation() const { return mPictureRotation; }
/**
* Sets the map object for rotation (by \a uuid). A empty string disables the map
* rotation. If this is set then the picture will be rotated by the same
* amount as the specified map object. This is useful especially for
* syncing north arrows with a map item.
* \see setPictureRotation()
* \see rotationMap()
*/
void setRotationMap( const QString &uuid );
/**
* Returns the uuid of the rotation map. An empty string means map rotation is
* disabled. If this is set then the picture is rotated by the same amount
* as the specified map object.
* \see setRotationMap()
* \see useRotationMap()
*/
QString rotationMap() const;
/**
* True if the picture rotation is matched to a map item.
* \see rotationMap()
* \see setRotationMap()
*/
bool useRotationMap() const;
/**
* Returns the mode used to align the picture to a map's North.
* \see setNorthMode()
* \see northOffset()
*/
NorthMode northMode() const { return mNorthMode; }
/**
* Sets the \a mode used to align the picture to a map's North.
* \see northMode()
* \see setNorthOffset()
*/
void setNorthMode( NorthMode mode );
/**
* Returns the offset added to the picture's rotation from a map's North.
* \see setNorthOffset()
* \see northMode()
*/
double northOffset() const { return mNorthOffset; }
/**
* Sets the \a offset added to the picture's rotation from a map's North.
* \see northOffset()
* \see setNorthMode()
*/
void setNorthOffset( double offset );
/**
* Returns the resize mode used for drawing the picture within the composer
* item's frame.
* \see setResizeMode()
*/
ResizeMode resizeMode() const { return mResizeMode; }
/**
* Sets the picture's \a anchor point, which controls how it is placed
* within the picture item's frame.
* \see pictureAnchor()
*/
void setPictureAnchor( QgsLayoutItem::ReferencePoint anchor );
/**
* Returns the picture's current anchor, which controls how it is placed
* within the picture item's frame.
* \see setPictureAnchor()
*/
QgsLayoutItem::ReferencePoint pictureAnchor() const { return mPictureAnchor; }
/**
* Returns the fill color used for parametrized SVG files.
* \see setSvgFillColor()
* \see svgStrokeColor()
*/
QColor svgFillColor() const { return mSvgFillColor; }
/**
* Sets the fill \a color used for parametrized SVG files.
* \note This setting only has an effect on parametrized SVG files, and is ignored for
* non-parametrized SVG files.
* \see svgFillColor()
* \see setSvgStrokeColor()
*/
void setSvgFillColor( const QColor &color );
/**
* Returns the stroke color used for parametrized SVG files.
* \see setSvgStrokeColor()
* \see svgFillColor()
*/
QColor svgStrokeColor() const { return mSvgStrokeColor; }
/**
* Sets the stroke \a color used for parametrized SVG files.
* \param color stroke color.
* \note This setting only has an effect on parametrized SVG files, and is ignored for
* non-parametrized SVG files.
* \see svgStrokelColor()
* \see setSvgFillColor()
*/
void setSvgStrokeColor( const QColor &color );
/**
* Returns the stroke width (in layout units) used for parametrized SVG files.
* \see setSvgStrokeWidth()
* \see svgStrokeColor()
*/
double svgStrokeWidth() const { return mSvgStrokeWidth; }
/**
* Sets the stroke \a width (in layout units) used for parametrized SVG files.
* \note This setting only has an effect on parametrized SVG files, and is ignored for
* non-parametrized SVG files.
* \see svgStrokeWidth()
* \see setSvgStrokeColor()
*/
void setSvgStrokeWidth( double width );
/**
* Returns the current picture mode (image format).
*/
Format mode() const { return mMode; }
public slots:
/**
* Sets the picture \a rotation within the item bounds, in degrees clockwise. This does not affect
* the item's frame, only the way the picture is drawn within the item.
* \see pictureRotation()
*/
void setPictureRotation( double rotation );
/**
* Sets the resize \a mode used for drawing the picture within the item bounds.
* \param mode ResizeMode to use for image file
* \see resizeMode
*/
void setResizeMode( ResizeMode mode );
/**
* Recalculates the source image (if using an expression for picture's source)
* and reloads and redraws the picture.
* \param context expression context for evaluating data defined picture sources
*/
void refreshPicture( const QgsExpressionContext *context = nullptr );
/**
* Forces a recalculation of the picture's frame size
*/
void recalculateSize();
void refreshDataDefinedProperty( const QgsLayoutObject::DataDefinedProperty property = QgsLayoutObject::AllProperties ) override;
signals:
//! Is emitted on picture rotation change
void pictureRotationChanged( double newRotation );
protected:
void draw( QgsRenderContext &context, const QStyleOptionGraphicsItem *itemStyle = nullptr ) override;
QSizeF applyItemSizeConstraint( const QSizeF &targetSize ) override;
bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
private:
QgsLayoutItemPicture() = delete;
//! Calculates bounding rect for svg file (mSourcefile) such that aspect ratio is correct
QRectF boundedSVGRect( double deviceWidth, double deviceHeight );
//! Calculates bounding rect for image such that aspect ratio is correct
QRectF boundedImageRect( double deviceWidth, double deviceHeight );
//! Returns size of current raster or svg picture
QSizeF pictureSize();
QImage mImage;
QSvgRenderer mSVG;
//! Absolute path to the image (may be also HTTP URL)
QString mSourcePath;
Format mMode = FormatUnknown;
QSize mDefaultSvgSize;
//! Image rotation
double mPictureRotation = 0;
//! Map that sets the rotation (or nullptr if this picture uses map independent rotation)
QPointer< QgsLayoutItemMap > mRotationMap;
//! Mode used to align to North
NorthMode mNorthMode = GridNorth;
//! Offset for north arrow
double mNorthOffset = 0.0;
//! Width of the picture (in mm)
double mPictureWidth = 0.0;
//! Height of the picture (in mm)
double mPictureHeight = 0.0;
ResizeMode mResizeMode = QgsLayoutItemPicture::Zoom;
QgsLayoutItem::ReferencePoint mPictureAnchor = UpperLeft;
QColor mSvgFillColor = QColor( 255, 255, 255 );
QColor mSvgStrokeColor = QColor( 0, 0, 0 );
double mSvgStrokeWidth = 0.2;
bool mHasExpressionError = false;
bool mLoaded = false;
bool mLoadingSvg = false;
//! Loads an image file into the picture item and redraws the item
void loadPicture( const QString &path );
/**
* Returns part of a raster image which will be shown, given current picture
* anchor settings
*/
QRect clippedImageRect( double &boundRectWidthMM, double &boundRectHeightMM, QSize imageRectPixels );
/**
* Loads a remote picture for the item
*/
void loadRemotePicture( const QString &url );
/**
* Loads a local picture for the item
*/
void loadLocalPicture( const QString &path );
private slots:
void updateMapRotation();
void shapeChanged();
};
#endif // QGSLAYOUTITEMPICTURE_H