17#ifndef QGSLAYOUTITEMMAP_H
18#define QGSLAYOUTITEMMAP_H
63 void setEnabled(
bool enabled );
84 bool forceLabelsInsideFeature()
const;
91 void setForceLabelsInsideFeature(
bool forceInside );
99 bool restrictToLayers()
const;
107 void setRestrictToLayers(
bool enabled );
117 QList< QgsMapLayer * > layersToClip()
const;
127 void setLayersToClip(
const QList< QgsMapLayer * > &layers );
134 bool writeXml( QDomElement &element, QDomDocument &document,
const QgsReadWriteContext &context )
const;
141 bool readXml(
const QDomElement &element,
const QDomDocument &doc,
const QgsReadWriteContext &context );
151 void layersAboutToBeRemoved(
const QList<QgsMapLayer *> &layers );
156 bool mClipToAtlasFeature =
false;
157 bool mRestrictToLayers =
false;
158 QList< QgsMapLayerRef > mLayersToClip;
160 bool mForceLabelsInsideFeature =
false;
187 bool isActive()
const;
194 bool enabled()
const;
201 void setEnabled(
bool enabled );
262 bool forceLabelsInsideClipPath()
const;
269 void setForceLabelsInsideClipPath(
bool forceInside );
276 bool writeXml( QDomElement &element, QDomDocument &document,
const QgsReadWriteContext &context )
const;
284 bool readXml(
const QDomElement &element,
const QDomDocument &doc,
const QgsReadWriteContext &context );
290 void finalizeRestoreFromXml();
302 bool mEnabled =
false;
304 bool mForceLabelsInsideClipPath =
false;
306 QPointer< QgsLayoutItem > mClipPathSource;
307 QString mClipPathUuid;
354 ShowPartialLabels = 1 << 0,
355 ShowUnplacedLabels = 1 << 1,
357 Q_DECLARE_FLAGS( MapItemFlags, MapItemFlag )
365 int type()
const override;
366 QIcon icon()
const override;
367 QgsLayoutItem::Flags itemFlags()
const override;
374 QgsLayoutItemMap::MapItemFlags mapFlags()
const;
381 void setMapFlags( QgsLayoutItemMap::MapItemFlags flags );
389 QString displayName()
const override;
399 void paint( QPainter *painter,
const QStyleOptionGraphicsItem *itemStyle, QWidget *pWidget )
override;
400 Q_DECL_DEPRECATED
int numberExportLayers() const override
SIP_DEPRECATED;
401 void startLayeredExport() override;
402 void stopLayeredExport() override;
403 bool nextExportPart() override;
404 ExportLayerBehavior exportLayerBehavior() const override;
405 QgsLayoutItem::ExportLayerDetail exportLayerDetails() const override;
413 double scale() const;
422 void setScale(
double scale,
bool forceUpdate = true );
457 QPolygonF visibleExtentPolygon() const;
514 QList<QgsMapLayer *> layers()
const;
525 void setLayers(
const QList<QgsMapLayer *> &layers );
549 void setLayerStyleOverrides(
const QMap<QString, QString> &overrides );
554 void storeCurrentLayerStyles();
571 void setFollowVisibilityPreset(
bool follow );
588 void setFollowVisibilityPresetName(
const QString &name );
590 void moveContent(
double dx,
double dy )
override;
591 void setMoveContentPreviewOffset(
double dx,
double dy )
override;
593 void zoomContent(
double factor, QPointF point )
override;
597 bool containsWmsLayer()
const;
599 bool requiresRasterization()
const override;
600 bool containsAdvancedEffects()
const override;
608 void setMapRotation(
double rotation );
647 void setAtlasDriven(
bool enabled );
751 double mapUnitsToLayoutUnits()
const;
762 void finalizeRestoreFromXml()
override;
851 QTransform layoutToMapCoordsTransform()
const;
868 double estimatedFrameBleed()
const override;
873 bool writePropertiesToElement( QDomElement &element, QDomDocument &document,
const QgsReadWriteContext &context )
const override;
874 bool readPropertiesFromElement(
const QDomElement &element,
const QDomDocument &document,
const QgsReadWriteContext &context )
override;
875 QPainterPath framePath()
const override;
881 QRectF boundingRect()
const override;
884 QPolygonF transformedMapPolygon()
const;
887 QPointF mapToItemCoords( QPointF mapCoords )
const;
945 void refresh()
override;
947 void invalidateCache()
override;
950 void updateBoundingRect();
955 void layersAboutToBeRemoved(
const QList<QgsMapLayer *> &layers );
957 void painterJobFinished();
961 void mapThemeChanged(
const QString &theme );
964 void currentMapThemeRenamed(
const QString &theme,
const QString &newTheme );
967 void recreateCachedImageInBackground();
969 void updateAtlasFeature();
972 QgsLayoutItemMap::MapItemFlags mMapFlags = QgsLayoutItemMap::MapItemFlags();
977 std::unique_ptr< QgsLayoutItemMapGridStack > mGridStack;
978 std::unique_ptr< QgsLayoutItemMapOverviewStack > mOverviewStack;
1000 std::unique_ptr< QImage > mCacheFinalImage;
1001 std::unique_ptr< QImage > mCacheRenderingImage;
1002 bool mUpdatesEnabled =
true;
1005 bool mCacheInvalidated =
true;
1008 int mNumCachedLayers;
1011 bool mDrawing =
false;
1013 QTimer *mBackgroundUpdateTimer =
nullptr;
1014 double mPreviewScaleFactor = 0;
1016 bool mDrawingPreview =
false;
1019 double mXOffset = 0.0;
1021 double mYOffset = 0.0;
1023 double mLastRenderedImageOffsetX = 0.0;
1024 double mLastRenderedImageOffsetY = 0.0;
1027 double mMapRotation = 0;
1033 double mEvaluatedMapRotation = 0;
1036 bool mKeepLayerSet =
false;
1039 QList< QgsMapLayerRef > mLayers;
1041 bool mKeepLayerStyles =
false;
1043 QMap<QString, QString> mLayerStyleOverrides;
1046 mutable QString mCachedLayerStyleOverridesPresetName;
1048 mutable QMap<QString, QString> mCachedPresetLayerStyleOverrides;
1055 bool mFollowVisibilityPreset =
false;
1061 QString mFollowVisibilityPresetName;
1064 QString mLastEvaluatedThemeName;
1073 void drawMap( QPainter *painter,
const QgsRectangle &extent, QSizeF size,
double dpi );
1076 void connectUpdateSlot();
1079 void syncLayerSet();
1091 QList< QgsLabelBlockingRegion > createLabelBlockingRegions(
const QgsMapSettings &mapSettings )
const;
1094 QRectF mCurrentRectangle;
1096 bool mDrawAnnotations =
true;
1099 bool mAtlasDriven =
false;
1103 double mAtlasMargin = 0.10;
1105 std::unique_ptr< QPainter > mPainter;
1106 std::unique_ptr< QgsMapRendererCustomPainterJob > mPainterJob;
1107 bool mPainterCancelWait =
false;
1112 QStringList mBlockingLabelItemUuids;
1113 QList< QPointer< QgsLayoutItem > > mBlockingLabelItems;
1118 QList< QgsRenderedFeatureHandlerInterface * > mRenderedFeatureHandlers;
1120 std::unique_ptr< QgsMapRendererStagedRenderJob > mStagedRendererJob;
1122 std::unique_ptr< QgsLabelingResults > mPreviewLabelingResults;
1123 std::unique_ptr< QgsLabelingResults > mExportLabelingResults;
1128 void updateToolTip();
1133 QMap<QString, QString> layerStyleOverridesToRender(
const QgsExpressionContext &context )
const;
1139 void mapPolygon(
const QgsRectangle &extent, QPolygonF &poly )
const;
1146 void transformShift(
double &xShift,
double &yShift )
const;
1148 void drawAnnotations( QPainter *painter );
1150 QPointF layoutMapPosForItem(
const QgsAnnotation *item )
const;
1152 void drawMapFrame( QPainter *p );
1153 void drawMapBackground( QPainter *p );
1169 bool shouldDrawPart( PartType part )
const;
1171 PartType mCurrentExportPart = NotLayered;
1172 QStringList mExportThemes;
1173 QStringList::iterator mExportThemeIt;
1184 void refreshLabelMargin(
bool updateItem );
1188 void createStagedRenderJob(
const QgsRectangle &extent,
const QSizeF size,
double dpi );
1190 QPolygonF calculateVisibleExtentPolygon(
bool includeClipping )
const;
1195 std::map<QString, std::unique_ptr<QgsGroupLayer>> mGroupLayers;
1200 friend class TestQgsLayoutMap;
1202 friend class QgsGeoPdfRenderedFeatureHandler;
Abstract base class for annotation items which are drawn over a map.
QgsCompositionConverter class converts a QGIS 2.x composition to a QGIS 3.x layout.
This class represents a coordinate reference system (CRS).
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
A geometry is the spatial representation of a feature.
Class that stores computed placement from labeling engine.
Handles rendering and exports of layouts to various formats.
A layout item subclass for map legends.
Contains settings relating to clipping a layout map by the current atlas feature.
void changed()
Emitted when the atlas clipping settings are changed.
A collection of grids which is drawn above the map content in a QgsLayoutItemMap.
An individual grid which is drawn above the map content in a QgsLayoutItemMap.
Contains settings relating to clipping a layout map by another layout item.
void changed()
Emitted when the item clipping settings are changed.
A collection of overviews which are drawn above the map content in a QgsLayoutItemMap.
An individual overview which is drawn above the map content in a QgsLayoutItemMap,...
Layout graphical items for displaying a map.
void extentChanged()
Emitted when the map's extent changes.
void preparedForAtlas()
Emitted when the map has been prepared for atlas rendering, just before actual rendering.
QgsMapRendererJob::Errors renderingErrors() const
Returns map rendering errors.
bool keepLayerSet() const
Returns whether a stored layer set should be used or the current layer set from the project associate...
void setKeepLayerSet(bool enabled)
Sets whether the stored layer set should be used or the current layer set of the associated project.
AtlasScalingMode
Scaling modes used for the serial rendering (atlas)
@ Predefined
A scale is chosen from the predefined scales.
@ Fixed
The current scale of the map is used for each feature of the atlas.
void layerStyleOverridesChanged()
Emitted when layer style overrides are changed... a means to let associated legend items know they sh...
void mapRotationChanged(double newRotation)
Emitted when the map's rotation changes.
bool isDrawing() const
True if a draw is already in progress.
QString followVisibilityPresetName() const
Preset name that decides which layers and layer styles are used for map rendering.
void previewRefreshed()
Emitted whenever the item's map preview has been refreshed.
void setDrawAnnotations(bool draw)
Sets whether annotations are drawn within the map.
bool followVisibilityPreset() const
Returns whether the map should follow a map theme.
void crsChanged()
Emitted when the map's coordinate reference system is changed.
QgsLayoutItemMapOverviewStack * overviews()
Returns the map item's overview stack, which is used to control how overviews are drawn over the map'...
bool atlasDriven() const
Returns whether the map extent is set to follow the current atlas feature.
bool keepLayerStyles() const
Returns whether current styles of layers should be overridden by previously stored styles.
QMap< QString, QString > layerStyleOverrides() const
Returns stored overrides of styles for layers.
AtlasScalingMode atlasScalingMode() const
Returns the current atlas scaling mode.
void setAtlasScalingMode(AtlasScalingMode mode)
Sets the current atlas scaling mode.
void themeChanged(const QString &theme)
Emitted when the map's associated theme is changed.
MapItemFlag
Various flags that affect drawing of map items.
bool drawAnnotations() const
Returns whether annotations are drawn within the map.
QgsLayoutItemMapGridStack * grids()
Returns the map item's grid stack, which is used to control how grids are drawn over the map's conten...
QgsLayoutItemMapAtlasClippingSettings * atlasClippingSettings()
Returns the map's atlas clipping settings.
void setAtlasMargin(double margin)
Sets the margin size (percentage) used when the map is in atlas mode.
void setKeepLayerStyles(bool enabled)
Sets whether current styles of layers should be overridden by previously stored styles.
QgsLayoutItemMapItemClipPathSettings * itemClippingSettings()
Returns the map's item based clip path settings.
Contains settings and helpers relating to a render of a QgsLayoutItem.
Base class for graphical items within a QgsLayout.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
DataDefinedProperty
Data defined properties for different item types.
@ AllProperties
All properties for item.
PropertyValueType
Specifies whether the value returned by a function should be the original, user set value,...
@ EvaluatedValue
Return the current evaluated value for the property.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
A map clipping region (in map coordinates and CRS).
FeatureClippingType
Feature clipping behavior, which controls how features from vector layers will be clipped.
@ ClipPainterOnly
Applying clipping on the painter only (i.e. feature boundaries will be unchanged, but may be invisibl...
QList< QgsMapRendererJob::Error > Errors
The QgsMapSettings class contains configuration for rendering of the map.
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
Contains information about the context of a rendering operation.
An interface for classes which provider custom handlers for features rendered as part of a map render...
An interface for classes which can visit style entity (e.g.
Base class for objects with an associated (optional) temporal range.
Q_DECLARE_OPERATORS_FOR_FLAGS(QgsTextRendererUtils::CurvedTextFlags)
const QgsCoordinateReferenceSystem & crs