QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
qgslayoutitemelevationprofile.h
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutitemelevationprofile.h
3 -------------------------------
4 begin : January 2023
5 copyright : (C) 2023 by 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 QGSLAYOUTITEMELEVATIONPROFILE_H
18#define QGSLAYOUTITEMELEVATIONPROFILE_H
19
20#include "qgis_core.h"
21#include "qgslayoutitem.h"
22#include "qgsmaplayerref.h"
23
24class QgsLayoutItemElevationProfilePlot;
25class Qgs2DPlot;
28
35{
36 Q_OBJECT
37
38 public:
39
44
46
52 static QgsLayoutItemElevationProfile *create( QgsLayout *layout ) SIP_FACTORY;
53
54 int type() const override;
55 QIcon icon() const override;
57 QgsLayoutItem::Flags itemFlags() const override;
58 bool requiresRasterization() const override;
59 bool containsAdvancedEffects() const override;
60
65 Qgs2DPlot *plot();
66
71 const Qgs2DPlot *plot() const SIP_SKIP;
72
78 QList< QgsMapLayer * > layers() const;
79
85 void setLayers( const QList< QgsMapLayer * > &layers );
86
96 void setProfileCurve( QgsCurve *curve SIP_TRANSFER );
97
105 QgsCurve *profileCurve() const;
106
114 void setCrs( const QgsCoordinateReferenceSystem &crs );
115
124
135 void setTolerance( double tolerance );
136
147 double tolerance() const;
148
154 bool atlasDriven() const { return mAtlasDriven; }
155
163 void setAtlasDriven( bool enabled );
164
168 QgsProfileRequest profileRequest() const;
169
170 void paint( QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget ) override;
171
178 Qgis::DistanceUnit distanceUnit() const;
179
186 void setDistanceUnit( Qgis::DistanceUnit unit );
187
188 public slots:
189
190 void refresh() override;
191 void invalidateCache() override;
192
193 signals:
194
201
202 protected:
203 void draw( QgsLayoutItemRenderContext &context ) override;
204 bool writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const override;
205 bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context ) override;
206
207 private slots:
208
209 void recreateCachedImageInBackground();
210 void profileGenerationFinished();
211 private:
212
213 std::unique_ptr< QgsLayoutItemElevationProfilePlot > mPlot;
214
215 QList< QgsMapLayerRef > mLayers;
216
219 std::unique_ptr< QgsCurve> mCurve;
220 bool mAtlasDriven = false;
221
222 double mTolerance = 0;
223
224 // render job handling
225
226 // see note in QgsLayoutItemMap about these!
227 std::unique_ptr< QImage > mCacheFinalImage;
228 std::unique_ptr< QImage > mCacheRenderingImage;
229 bool mUpdatesEnabled = true;
230 bool mCacheInvalidated = true;
231 bool mDrawing = false;
232 bool mDrawingPreview = false;
233 QTimer *mBackgroundUpdateTimer = nullptr;
234 double mPreviewScaleFactor = 0;
235 std::unique_ptr< QPainter > mPainter;
236 std::unique_ptr< QgsProfilePlotRenderer > mRenderJob;
237 bool mPainterCancelWait = false;
238
239
240};
241
242#endif //QGSLAYOUTITEMELEVATIONPROFILE_H
DistanceUnit
Units of distance.
Definition qgis.h:4358
@ Unknown
Unknown distance unit.
Base class for 2-dimensional plot/chart/graphs.
Definition qgsplot.h:278
This class represents a coordinate reference system (CRS).
Abstract base class for curved geometry type.
Definition qgscurve.h:35
A layout item subclass for elevation profile plots.
bool atlasDriven() const
Returns whether the profile curve is set to follow the current atlas feature.
void previewRefreshed()
Emitted whenever the item's preview has been refreshed.
Contains settings and helpers relating to a render of a QgsLayoutItem.
Base class for graphical items within a QgsLayout.
virtual void refreshDataDefinedProperty(QgsLayoutObject::DataDefinedProperty property=QgsLayoutObject::DataDefinedProperty::AllProperties)
Refreshes a data defined property for the item by reevaluating the property's value and redrawing the...
virtual QIcon icon() const
Returns the item's icon.
void paint(QPainter *painter, const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget) override
Handles preparing a paint surface for the layout item and painting the item's content.
virtual bool writePropertiesToElement(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const
Stores item state within an XML DOM element.
int type() const override
Returns a unique graphics item type identifier.
virtual bool requiresRasterization() const
Returns true if the item is drawn in such a way that forces the whole layout to be rasterized when ex...
virtual bool containsAdvancedEffects() const
Returns true if the item contains contents with blend modes or transparency effects which can only be...
virtual void invalidateCache()
Forces a deferred update of any cached image the item uses.
virtual Flags itemFlags() const
Returns the item's flags, which indicate how the item behaves.
virtual bool readPropertiesFromElement(const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context)
Sets item state from a DOM element.
QFlags< Flag > Flags
void refresh() override
Refreshes the item, causing a recalculation of any property overrides and recalculation of its positi...
friend class QgsLayoutItemElevationProfile
virtual void draw(QgsLayoutItemRenderContext &context)=0
Draws the item's contents using the specified item render context.
DataDefinedProperty
Data defined properties for different item types.
@ AllProperties
All properties for item.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49
Generates and renders elevation profile plots.
Encapsulates properties and constraints relating to fetching elevation profiles from different source...
The class is used as a container of context for various read/write operations on other objects.
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_FACTORY
Definition qgis_sip.h:76
const QgsCoordinateReferenceSystem & crs