QGIS API Documentation  2.99.0-Master (9f5e33a)
qgsmapsettings.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsmapsettings.h
3  --------------------------------------
4  Date : December 2013
5  Copyright : (C) 2013 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSMAPSETTINGS_H
17 #define QGSMAPSETTINGS_H
18 
19 #include "qgis_core.h"
20 #include "qgis_sip.h"
21 #include <QColor>
22 #include <QImage>
23 #include <QPointer>
24 #include <QSize>
25 #include <QStringList>
26 
27 #include "qgsabstractgeometry.h"
29 #include "qgsdatumtransformstore.h"
31 #include "qgsmaptopixel.h"
32 #include "qgsrectangle.h"
33 #include "qgsscalecalculator.h"
34 #include "qgsexpressioncontext.h"
35 #include "qgsmaplayer.h"
36 
37 class QPainter;
38 
40 class QgsScaleCalculator;
41 class QgsMapRendererJob;
42 
43 
58 class CORE_EXPORT QgsMapSettings
59 {
60  public:
62 
67  QgsRectangle extent() const;
72  void setExtent( const QgsRectangle &rect, bool magnified = true );
73 
75  QSize outputSize() const;
77  void setOutputSize( QSize size );
78 
84  double rotation() const;
85 
91  void setRotation( double rotation );
92 
95  double outputDpi() const;
97  void setOutputDpi( double dpi );
98 
105  void setMagnificationFactor( double factor );
106 
110  double magnificationFactor() const;
111 
114  QStringList layerIds() const;
117  QList<QgsMapLayer *> layers() const;
120  void setLayers( const QList<QgsMapLayer *> &layers );
121 
124  QMap<QString, QString> layerStyleOverrides() const;
127  void setLayerStyleOverrides( const QMap<QString, QString> &overrides );
128 
134  QString customRenderFlags() const { return mCustomRenderFlags; }
135 
141  void setCustomRenderFlags( const QString &customRenderFlags ) { mCustomRenderFlags = customRenderFlags; }
142 
144  void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
146  QgsCoordinateReferenceSystem destinationCrs() const;
147 
149  QgsUnitTypes::DistanceUnit mapUnits() const;
150 
152  void setBackgroundColor( const QColor &color ) { mBackgroundColor = color; }
154  QColor backgroundColor() const { return mBackgroundColor; }
155 
157  void setSelectionColor( const QColor &color ) { mSelectionColor = color; }
159  QColor selectionColor() const { return mSelectionColor; }
160 
162  enum Flag
163  {
164  Antialiasing = 0x01,
165  DrawEditingInfo = 0x02,
166  ForceVectorOutput = 0x04,
167  UseAdvancedEffects = 0x08,
168  DrawLabeling = 0x10,
169  UseRenderingOptimization = 0x20,
170  DrawSelection = 0x40,
171  DrawSymbolBounds = 0x80,
172  RenderMapTile = 0x100,
173  RenderPartialOutput = 0x200,
174  // TODO: ignore scale-based visibility (overview)
175  };
176  Q_DECLARE_FLAGS( Flags, Flag )
177 
178 
179  void setFlags( QgsMapSettings::Flags flags );
181  void setFlag( Flag flag, bool on = true );
183  Flags flags() const;
185  bool testFlag( Flag flag ) const;
186 
188  void setOutputImageFormat( QImage::Format format ) { mImageFormat = format; }
190  QImage::Format outputImageFormat() const { return mImageFormat; }
191 
193  bool hasValidSettings() const;
195  QgsRectangle visibleExtent() const;
198  QPolygonF visiblePolygon() const;
200  double mapUnitsPerPixel() const;
201 
206  double scale() const;
207 
213  void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; }
214 
220  const QgsExpressionContext &expressionContext() const { return mExpressionContext; }
221 
222  // -- utility functions --
223 
225  const QgsDatumTransformStore &datumTransformStore() const { return mDatumTransformStore; } SIP_SKIP
226  QgsDatumTransformStore &datumTransformStore() { return mDatumTransformStore; }
227 
228  const QgsMapToPixel &mapToPixel() const { return mMapToPixel; }
229 
235  double layerToMapUnits( const QgsMapLayer *layer, const QgsRectangle &referenceExtent = QgsRectangle() ) const;
236 
242  QgsRectangle layerExtentToOutputExtent( const QgsMapLayer *layer, QgsRectangle extent ) const;
243 
249  QgsRectangle outputExtentToLayerExtent( const QgsMapLayer *layer, QgsRectangle extent ) const;
250 
255  QgsPointXY layerToMapCoordinates( const QgsMapLayer *layer, QgsPointXY point ) const;
256 
262  QgsRectangle layerToMapCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const;
263 
268  QgsPointXY mapToLayerCoordinates( const QgsMapLayer *layer, QgsPointXY point ) const;
269 
275  QgsRectangle mapToLayerCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const;
276 
282  QgsCoordinateTransform layerTransform( const QgsMapLayer *layer ) const;
283 
285  QgsRectangle fullExtent() const;
286 
287  /* serialization */
288 
289  void readXml( QDomNode &node );
290 
291  void writeXml( QDomNode &node, QDomDocument &doc );
292 
295  void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; }
297  double segmentationTolerance() const { return mSegmentationTolerance; }
298 
301  void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; }
303  QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; }
304 
309  void setLabelingEngineSettings( const QgsLabelingEngineSettings &settings ) { mLabelingEngineSettings = settings; }
310 
315  const QgsLabelingEngineSettings &labelingEngineSettings() const { return mLabelingEngineSettings; }
316 
317  protected:
318 
319  double mDpi;
320 
321  QSize mSize;
322 
324 
325  double mRotation;
327 
330  QMap<QString, QString> mLayerStyleOverrides;
333 
336 
339 
340  Flags mFlags;
341 
342  QImage::Format mImageFormat;
343 
346 
348 
349  // derived properties
350  bool mValid;
353  double mScale;
354 
355  // utiity stuff
358 
359  void updateDerived();
360 };
361 
362 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapSettings::Flags )
363 
364 
365 #endif // QGSMAPSETTINGS_H
double mMagnificationFactor
A rectangle specified with double values.
Definition: qgsrectangle.h:38
Base class for all map layer types.
Definition: qgsmaplayer.h:54
QgsDatumTransformStore & datumTransformStore()
QgsRectangle mVisibleExtent
Extent with some additional white space that matches the output aspect ratio.
void setSegmentationToleranceType(QgsAbstractGeometry::SegmentationToleranceType type)
Sets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
QgsMapToPixel mMapToPixel
Abstract base class for map rendering implementations.
const QgsExpressionContext & expressionContext() const
Gets the expression context.
void setExpressionContext(const QgsExpressionContext &context)
Sets the expression context.
QgsCoordinateReferenceSystem mDestCRS
A class to represent a 2D point.
Definition: qgspointxy.h:42
QMap< QString, QString > mLayerStyleOverrides
QColor backgroundColor() const
Get the background color of the map.
void setCustomRenderFlags(const QString &customRenderFlags)
Sets the custom rendering flags.
const QgsDatumTransformStore & datumTransformStore() const
SegmentationToleranceType
Segmentation tolerance as maximum angle or maximum difference between approximation and circle...
QgsLabelingEngineSettings mLabelingEngineSettings
The QgsMapSettings class contains configuration for rendering of the map.
QString customRenderFlags() const
Get custom rendering flags.
Perform transforms between map coordinates and device coordinates.
Definition: qgsmaptopixel.h:35
QImage::Format mImageFormat
bool mValid
Whether the actual settings are valid (set in updateDerived())
QgsRectangle mExtent
Flag
Enumeration of flags that adjust the way the map is rendered.
#define SIP_SKIP
Definition: qgis_sip.h:107
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
void setSegmentationTolerance(double tolerance)
Sets the segmentation tolerance applied when rendering curved geometries.
QImage::Format outputImageFormat() const
format of internal QImage, default QImage::Format_ARGB32_Premultiplied
void setOutputImageFormat(QImage::Format format)
sets format of internal QImage
QgsExpressionContext mExpressionContext
QgsScaleCalculator mScaleCalculator
const QgsMapToPixel & mapToPixel() const
QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const
Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation...
Calculates scale for a given combination of canvas size, map extent, and monitor dpi.
DistanceUnit
Units of distance.
Definition: qgsunittypes.h:42
void setBackgroundColor(const QColor &color)
Set the background color of the map.
void setLabelingEngineSettings(const QgsLabelingEngineSettings &settings)
Sets global configuration of the labeling engine.
double segmentationTolerance() const
Gets the segmentation tolerance applied when rendering curved geometries.
double mMapUnitsPerPixel
double mSegmentationTolerance
void setSelectionColor(const QColor &color)
Set color that is used for drawing of selected vector features.
QList< QgsWeakMapLayerPointer > QgsWeakMapLayerPointerList
A list of weak pointers to QgsMapLayers.
Definition: qgsmaplayer.h:1105
The QgsDatumTransformStore class keeps track of datum transformations as chosen by the user...
QgsWeakMapLayerPointerList mLayers
list of layers to be rendered (stored as weak pointers)
Stores global configuration for labeling engine.
This class represents a coordinate reference system (CRS).
QColor mBackgroundColor
Class for doing transforms between two map coordinate systems.
QColor selectionColor() const
Get color that is used for drawing of selected vector features.
QColor mSelectionColor
QgsDatumTransformStore mDatumTransformStore
QString mCustomRenderFlags
QgsAbstractGeometry::SegmentationToleranceType mSegmentationToleranceType
const QgsLabelingEngineSettings & labelingEngineSettings() const
Returns global configuration of the labeling engine.