QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgswmsrendercontext.h
Go to the documentation of this file.
1/***************************************************************************
2 qgswmsrendercontext.h
3 ---------------------
4 begin : March 22, 2019
5 copyright : (C) 2019 by Paul Blottiere
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
18#ifndef QGSWMSRENDERCONTEXT_H
19#define QGSWMSRENDERCONTEXT_H
20
21#include "qgswmsparameters.h"
22#include "qgsproject.h"
23#include "qgsserverinterface.h"
24
25namespace QgsWms
26{
27
35 {
36 public:
54 Q_DECLARE_FLAGS( Flags, Flag )
55
57
64
69
74
78 const QgsServerSettings &settings() const;
79
83 const QgsProject *project() const;
84
88 void setFlag( Flag flag, bool on = true );
89
95 bool testFlag( Flag flag ) const;
96
100 QList<QgsMapLayer *> layers() const;
101
106 QList<QgsMapLayer *> layersToRender() const;
107
112 QDomElement sld( const QgsMapLayer &layer ) const;
113
118 QString style( const QgsMapLayer &layer ) const;
119
124 double scaleDenominator() const;
125
131
136 bool updateExtent() const;
137
143
148 int imageQuality() const;
149
155 int tileBuffer() const;
156
166 bool renderMapTiles() const;
167
171 int precision() const;
172
177 QString layerNickname( const QgsMapLayer &layer ) const;
178
183 QgsMapLayer *layer( const QString &nickname ) const;
184
188 bool isValidLayer( const QString &nickname ) const;
189
194 QList<QgsMapLayer *> layersFromGroup( const QString &nickname ) const;
195
199 bool isValidGroup( const QString &name ) const;
200
204 qreal dotsPerMm() const;
205
210 QStringList flattenedQueryLayers( const QStringList &layerNames ) const;
211
212#ifdef HAVE_SERVER_PYTHON_PLUGINS
213
217 QgsAccessControl *accessControl() const;
218#endif
219
224 QMap<QString, QList<QgsMapLayer *> > layerGroups() const;
225
230 double mapTileBuffer( int mapWidth ) const;
231
237 QSize mapSize( bool aspectRatio = true ) const;
238
244 bool isValidWidthHeight() const;
245
252 bool isValidWidthHeight( int width, int height ) const;
253
257 int mapWidth() const;
258
262 int mapHeight() const;
263
268 bool isExternalLayer( const QString &name ) const;
269
274 void setSocketFeedback( QgsFeedback *feedback );
275
281
282 private:
283 void initNicknameLayers();
284 void initRestrictedLayers();
285 void initLayerGroupsRecursive( const QgsLayerTreeGroup *group, const QString &groupName );
286
287 void searchLayersToRender();
288 void searchLayersToRenderSld();
289 void searchLayersToRenderStyle();
290 void removeUnwantedLayers();
291
296 bool addLayerToRender( QgsMapLayer *layer );
297
302 bool checkLayerReadPermissions( QgsMapLayer *layer ) const;
303
304 bool layerScaleVisibility( const QString &name ) const;
305
306 const QgsProject *mProject = nullptr;
307 QgsServerInterface *mInterface = nullptr;
308 QgsWmsParameters mParameters;
309 Flags mFlags = Flags();
310 double mScaleDenominator = -1.0;
311
312 // nickname of all layers defined within the project
313 QMultiMap<QString, QgsMapLayer *> mNicknameLayers;
314
315 // map of layers to use for rendering
316 QList<QgsMapLayer *> mLayersToRender;
317
318 // list of layers which are not usable
319 QStringList mRestrictedLayers;
320
321 QMap<QString, QList<QgsMapLayer *> > mLayerGroups;
322
323 QMap<QString, QDomElement> mSlds;
324 QMap<QString, QString> mStyles;
325
326 // list for external layers
327 QList<QgsMapLayer *> mExternalLayers;
328
329 QgsFeedback *mSocketFeedback = nullptr;
330 };
331};
332
333#endif
A helper class that centralizes restrictions given by all the access control filter plugins.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:44
Layer tree group node serves as a container for layers and further groups.
Base class for all map layer types.
Definition qgsmaplayer.h:76
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
QgsServerInterface Class defining interfaces exposed by QGIS Server and made available to plugins.
Provides a way to retrieve settings by prioritizing according to environment variables,...
Provides an interface to retrieve and manipulate WMS parameters received from the client.
Rendering context for the WMS renderer.
QSize mapSize(bool aspectRatio=true) const
Returns the size (in pixels) of the map to render, according to width and height WMS parameters as we...
bool isExternalLayer(const QString &name) const
Returns true if the layer is an external layer, false otherwise.
bool isValidGroup(const QString &name) const
Returns true if name is a group.
QStringList flattenedQueryLayers(const QStringList &layerNames) const
Returns a list of query layer names where group names are replaced by the names of their layer compon...
QgsFeedback * socketFeedback() const
Returns the response feedback if any.
QList< QgsMapLayer * > layers() const
Returns a list of all layers read from the project.
void setParameters(const QgsWmsParameters &parameters)
Sets WMS parameters.
QList< QgsMapLayer * > layersToRender() const
Returns a list of all layers to actually render according to the current configuration.
int mapWidth() const
Returns WIDTH or SRCWIDTH according to UseSrcWidthHeight flag.
QgsMapLayer * layer(const QString &nickname) const
Returns the layer corresponding to the nickname, or a nullptr if not found or if the layer do not nee...
int tileBuffer() const
Returns the tile buffer value to use for rendering according to the current configuration.
bool updateExtent() const
Returns true if the extent has to be updated before the rendering, false otherwise.
const QgsServerSettings & settings() const
Returns settings of the server.
void setFlag(Flag flag, bool on=true)
Sets or unsets a rendering flag according to the on value.
bool isValidWidthHeight() const
Returns true if width and height are valid according to the maximum values defined within the project...
QList< QgsMapLayer * > layersFromGroup(const QString &nickname) const
Returns the group's layers list corresponding to the nickname, or an empty list if not found.
QgsWmsParameters parameters() const
Returns WMS parameters.
void setScaleDenominator(double scaleDenominator)
Sets a custom scale denominator.
QString style(const QgsMapLayer &layer) const
Returns a style's name for a specific layer.
QMap< QString, QList< QgsMapLayer * > > layerGroups() const
Returns a map having layer group names as keys and a list of layers as values.
double mapTileBuffer(int mapWidth) const
Returns the tile buffer in geographical units for the given map width in pixels.
QString layerNickname(const QgsMapLayer &layer) const
Returns the nickname (short name, id or name) of the layer according to the current configuration.
void setSocketFeedback(QgsFeedback *feedback)
Sets the response feedback.
double scaleDenominator() const
Returns the scale denominator to use for rendering according to the current configuration.
qreal dotsPerMm() const
Returns default dots per mm according to the current configuration.
bool testFlag(Flag flag) const
Returns the status of a rendering flag.
QDomElement sld(const QgsMapLayer &layer) const
Returns a SLD document for a specific layer.
bool isValidLayer(const QString &nickname) const
Returns true if the layer has to be rendered, false otherwise.
const QgsProject * project() const
Returns the project.
int precision() const
Returns the precision to use according to the current configuration.
int imageQuality() const
Returns the image quality to use for rendering according to the current configuration.
int mapHeight() const
Returns HEIGHT or SRCHEIGHT according to UseSrcWidthHeight flag.
bool renderMapTiles() const
Returns true if WMS requests should use the QgsMapSettings::RenderMapTile flag, so that no visible ar...
Flag
Available rendering options.
@ AddAllLayers
For GetPrint: add layers from LAYER(S) parameter.
Median cut implementation.