QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
qgslayoutrendercontext.cpp
Go to the documentation of this file.
1 /***************************************************************************
2  qgslayoutrendercontext.cpp
3  --------------------
4  begin : July 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 /***************************************************************************
9  * *
10  * This program is free software; you can redistribute it and/or modify *
11  * it under the terms of the GNU General Public License as published by *
12  * the Free Software Foundation; either version 2 of the License, or *
13  * (at your option) any later version. *
14  * *
15  ***************************************************************************/
16 
17 #include "qgslayoutrendercontext.h"
18 #include "qgslayout.h"
19 
21  : QObject( layout )
22  , mFlags( FlagAntialiasing | FlagUseAdvancedEffects )
23  , mLayout( layout )
24 {
26 }
27 
28 void QgsLayoutRenderContext::setFlags( const QgsLayoutRenderContext::Flags flags )
29 {
30  if ( flags == mFlags )
31  return;
32 
33  mFlags = flags;
34  emit flagsChanged( mFlags );
35 }
36 
38 {
39  Flags newFlags = mFlags;
40  if ( on )
41  newFlags |= flag;
42  else
43  newFlags &= ~flag;
44 
45  if ( newFlags == mFlags )
46  return;
47 
48  mFlags = newFlags;
49  emit flagsChanged( mFlags );
50 }
51 
52 QgsLayoutRenderContext::Flags QgsLayoutRenderContext::flags() const
53 {
54  return mFlags;
55 }
56 
58 {
59  return mFlags.testFlag( flag );
60 }
61 
62 QgsRenderContext::Flags QgsLayoutRenderContext::renderContextFlags() const
63 {
64  QgsRenderContext::Flags flags = nullptr;
65  if ( mFlags & FlagAntialiasing )
66  flags = flags | QgsRenderContext::Antialiasing;
67  if ( mFlags & FlagUseAdvancedEffects )
69 
70  // TODO - expose as layout context flag?
72  return flags;
73 }
74 
76 {
77  if ( qgsDoubleNear( dpi, mMeasurementConverter.dpi() ) )
78  return;
79 
80  mMeasurementConverter.setDpi( dpi );
81  emit dpiChanged();
82 }
83 
85 {
86  return mMeasurementConverter.dpi();
87 }
88 
90 {
91  return mGridVisible;
92 }
93 
95 {
96  mGridVisible = visible;
97 }
98 
100 {
101  return mBoundingBoxesVisible;
102 }
103 
105 {
106  mBoundingBoxesVisible = visible;
107 }
108 
110 {
111  mPagesVisible = visible;
112 }
113 
115 {
116  return mExportThemes;
117 }
118 
120 {
121  mExportThemes = exportThemes;
122 }
123 
124 void QgsLayoutRenderContext::setPredefinedScales( const QVector<qreal> &scales )
125 {
126  if ( scales == mPredefinedScales )
127  return;
128 
129  mPredefinedScales = scales;
130  // make sure the list is sorted
131  std::sort( mPredefinedScales.begin(), mPredefinedScales.end() ); // clazy:exclude=detaching-member
133 }
void setPredefinedScales(const QVector< qreal > &scales)
Sets the list of predefined scales to use with the layout.
void setDpi(double dpi)
Sets the dpi for outputting the layout.
Enable layer opacity and blending effects.
void setExportThemes(const QStringList &themes)
Sets a list of map themes to use during the export.
void setFlag(QgsLayoutRenderContext::Flag flag, bool on=true)
Enables or disables a particular rendering flag for the layout.
Use antialiasing while drawing.
bool qgsDoubleNear(double a, double b, double epsilon=4 *std::numeric_limits< double >::epsilon())
Compare two doubles (but allow some difference)
Definition: qgis.h:280
Flag
Flags for controlling how a layout is rendered.
void setSimplifyHints(SimplifyHints simplifyHints)
Sets the simplification hints of the vector layer managed.
void flagsChanged(QgsLayoutRenderContext::Flags flags)
Emitted whenever the context&#39;s flags change.
void setDpi(const double dpi)
Sets the dots per inch (dpi) for the measurement converter.
bool boundingBoxesVisible() const
Returns true if the item bounding boxes should be drawn.
void setGridVisible(bool visible)
Sets whether the page grid should be visible.
void setPagesVisible(bool visible)
Sets whether the page items should be visible in the layout.
void dpiChanged()
Emitted when the context&#39;s DPI is changed.
bool gridVisible() const
Returns true if the page grid should be drawn.
No simplification can be applied.
void setBoundingBoxesVisible(bool visible)
Sets whether the item bounding boxes should be visible.
QgsLayoutRenderContext::Flags flags() const
Returns the current combination of flags used for rendering the layout.
double dpi() const
Returns the dpi for outputting the layout.
QgsRenderContext::Flags renderContextFlags() const
Returns the combination of render context flags matched to the layout context&#39;s settings.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition: qgslayout.h:49
Vector graphics should not be cached and drawn as raster images.
void predefinedScalesChanged()
Emitted when the list of predefined scales changes.
Use antialiasing when drawing items.
double dpi() const
Returns the Dots per inch (DPI) of the measurement converter.
void setFlags(QgsLayoutRenderContext::Flags flags)
Sets the combination of flags that will be used for rendering the layout.
Enable advanced effects such as blend modes.
bool testFlag(Flag flag) const
Check whether a particular rendering flag is enabled for the layout.
QStringList exportThemes() const
Returns a list of map themes to use during the export.
QgsLayoutRenderContext(QgsLayout *layout)
Constructor for QgsLayoutRenderContext.