|
QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
Rendering context for the WMS renderer. More...
#include <qgswmsrendercontext.h>
Public Types | |
| enum | Flag { UseScaleDenominator = 0x01, UseOpacity = 0x02, UseFilter = 0x04, UseSelection = 0x08, AddHighlightLayers = 0x10, UpdateExtent = 0x20, SetAccessControl = 0x40, AddQueryLayers = 0x80, UseWfsLayersOnly = 0x100, AddExternalLayers = 0x200, UseSrcWidthHeight = 0x400, UseTileBuffer = 0x800 } |
| Available rendering options. More... | |
Public Member Functions | |
| QgsWmsRenderContext (const QgsProject *project, QgsServerInterface *interface) | |
| Constructor for QgsWmsRenderContext. More... | |
| ~QgsWmsRenderContext () | |
| Destructor for QgsWmsRenderContext. More... | |
| qreal | dotsPerMm () const |
| Returns default dots per mm according to the current configuration. More... | |
| QStringList | flattenedQueryLayers () const |
| Returns a list of query layer names where group names are replaced by the names of their layer components. More... | |
| int | imageQuality () const |
| Returns the image quality to use for rendering according to the current configuration. More... | |
| bool | isExternalLayer (const QString &name) const |
| Returns true if the layer is an external layer, false otherwise. More... | |
| bool | isValidGroup (const QString &name) const |
| Returns true if name is a group. More... | |
| bool | isValidLayer (const QString &nickname) const |
| Returns true if the layer has to be rendered, false otherwise. More... | |
| bool | isValidWidthHeight () const |
| Returns true if width and height are valid according to the maximum values defined within the project, false otherwise. More... | |
| 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 need to be rendered. More... | |
| QMap< QString, QList< QgsMapLayer * > > | layerGroups () const |
| Returns a map having layer group names as keys and a list of layers as values. More... | |
| QString | layerNickname (const QgsMapLayer &layer) const |
| Returns the nickname (short name, id or name) of the layer according to the current configuration. More... | |
| QList< QgsMapLayer * > | layers () const |
| Returns a list of all layers read from the project. More... | |
| QList< QgsMapLayer * > | layersFromGroup (const QString &nickname) const |
| Returns the group's layers list corresponding to the nickname, or an empty list if not found. More... | |
| QList< QgsMapLayer * > | layersToRender () const |
| Returns a list of all layers to actually render according to the current configuration. More... | |
| int | mapHeight () const |
| Returns HEIGHT or SRCHEIGHT according to UseSrcWidthHeight flag. More... | |
| QSize | mapSize (bool aspectRatio=true) const |
| Returns the size (in pixels) of the map to render, according to width and height WMS parameters as well as the aspectRatio option. More... | |
| double | mapTileBuffer (int mapWidth) const |
| Returns the tile buffer in geographical units for the given map width in pixels. More... | |
| int | mapWidth () const |
| Returns WIDTH or SRCWIDTH according to UseSrcWidthHeight flag. More... | |
| QgsWmsParameters | parameters () const |
| Returns WMS parameters. More... | |
| QgsWmsParametersLayer | parameters (const QgsMapLayer &layer) const |
| Returns WMS parameters for a specific layer. More... | |
| int | precision () const |
| Returns the precision to use according to the current configuration. More... | |
| const QgsProject * | project () const |
| Returns the project. More... | |
| double | scaleDenominator () const |
| Returns the scale denominator to use for rendering according to the current configuration. More... | |
| void | setFlag (Flag flag, bool on=true) |
| Sets or unsets a rendering flag according to the on value. More... | |
| void | setParameters (const QgsWmsParameters ¶meters) |
| Sets WMS parameters. More... | |
| void | setScaleDenominator (double scaleDenominator) |
| Sets a custom scale denominator. More... | |
| const QgsServerSettings & | settings () const |
| Returns settings of the server. More... | |
| QDomElement | sld (const QgsMapLayer &layer) const |
| Returns a SLD document for a specific layer. More... | |
| QString | style (const QgsMapLayer &layer) const |
| Returns a style's name for a specific layer. More... | |
| bool | testFlag (Flag flag) const |
| Returns the status of a rendering flag. More... | |
| int | tileBuffer () const |
| Returns the tile buffer value to use for rendering according to the current configuration. More... | |
| bool | updateExtent () const |
| Returns true if the extent has to be updated before the rendering, false otherwise. More... | |
Rendering context for the WMS renderer.
Definition at line 34 of file qgswmsrendercontext.h.
Available rendering options.
| Enumerator | |
|---|---|
| UseScaleDenominator | |
| UseOpacity | |
| UseFilter | |
| UseSelection | |
| AddHighlightLayers | |
| UpdateExtent | |
| SetAccessControl | |
| AddQueryLayers | |
| UseWfsLayersOnly | |
| AddExternalLayers | |
| UseSrcWidthHeight | |
| UseTileBuffer | |
Definition at line 38 of file qgswmsrendercontext.h.
| QgsWmsRenderContext::~QgsWmsRenderContext | ( | ) |
Destructor for QgsWmsRenderContext.
Definition at line 35 of file qgswmsrendercontext.cpp.
| QgsWmsRenderContext::QgsWmsRenderContext | ( | const QgsProject * | project, |
| QgsServerInterface * | interface | ||
| ) |
Constructor for QgsWmsRenderContext.
| project | The project to use for the rendering |
| interface | The server interface |
Definition at line 28 of file qgswmsrendercontext.cpp.
| qreal QgsWmsRenderContext::dotsPerMm | ( | ) | const |
Returns default dots per mm according to the current configuration.
Definition at line 165 of file qgswmsrendercontext.cpp.
| QStringList QgsWmsRenderContext::flattenedQueryLayers | ( | ) | const |
Returns a list of query layer names where group names are replaced by the names of their layer components.
Definition at line 180 of file qgswmsrendercontext.cpp.
| int QgsWmsRenderContext::imageQuality | ( | ) | const |
Returns the image quality to use for rendering according to the current configuration.
Definition at line 129 of file qgswmsrendercontext.cpp.
| bool QgsWmsRenderContext::isExternalLayer | ( | const QString & | name | ) | const |
Returns true if the layer is an external layer, false otherwise.
Definition at line 793 of file qgswmsrendercontext.cpp.
| bool QgsWmsRenderContext::isValidGroup | ( | const QString & | name | ) | const |
Returns true if name is a group.
Definition at line 302 of file qgswmsrendercontext.cpp.
| bool QgsWmsRenderContext::isValidLayer | ( | const QString & | nickname | ) | const |
Returns true if the layer has to be rendered, false otherwise.
Definition at line 292 of file qgswmsrendercontext.cpp.
| bool QgsWmsRenderContext::isValidWidthHeight | ( | ) | const |
Returns true if width and height are valid according to the maximum values defined within the project, false otherwise.
Definition at line 604 of file qgswmsrendercontext.cpp.
| QgsMapLayer * QgsWmsRenderContext::layer | ( | const QString & | nickname | ) | const |
Returns the layer corresponding to the nickname, or a nullptr if not found or if the layer do not need to be rendered.
Definition at line 276 of file qgswmsrendercontext.cpp.
| QMap< QString, QList< QgsMapLayer * > > QgsWmsRenderContext::layerGroups | ( | ) | const |
Returns a map having layer group names as keys and a list of layers as values.
Definition at line 573 of file qgswmsrendercontext.cpp.
| QString QgsWmsRenderContext::layerNickname | ( | const QgsMapLayer & | layer | ) | const |
Returns the nickname (short name, id or name) of the layer according to the current configuration.
Definition at line 261 of file qgswmsrendercontext.cpp.
| QList< QgsMapLayer * > QgsWmsRenderContext::layers | ( | ) | const |
Returns a list of all layers read from the project.
Definition at line 222 of file qgswmsrendercontext.cpp.
| QList< QgsMapLayer * > QgsWmsRenderContext::layersFromGroup | ( | const QString & | nickname | ) | const |
Returns the group's layers list corresponding to the nickname, or an empty list if not found.
Definition at line 297 of file qgswmsrendercontext.cpp.
| QList< QgsMapLayer * > QgsWmsRenderContext::layersToRender | ( | ) | const |
Returns a list of all layers to actually render according to the current configuration.
Definition at line 217 of file qgswmsrendercontext.cpp.
| int QgsWmsRenderContext::mapHeight | ( | ) | const |
Returns HEIGHT or SRCHEIGHT according to UseSrcWidthHeight flag.
Definition at line 591 of file qgswmsrendercontext.cpp.
| QSize QgsWmsRenderContext::mapSize | ( | bool | aspectRatio = true | ) | const |
Returns the size (in pixels) of the map to render, according to width and height WMS parameters as well as the aspectRatio option.
Definition at line 698 of file qgswmsrendercontext.cpp.
| double QgsWmsRenderContext::mapTileBuffer | ( | int | mapWidth | ) | const |
Returns the tile buffer in geographical units for the given map width in pixels.
Definition at line 678 of file qgswmsrendercontext.cpp.
| int QgsWmsRenderContext::mapWidth | ( | ) | const |
Returns WIDTH or SRCWIDTH according to UseSrcWidthHeight flag.
Definition at line 578 of file qgswmsrendercontext.cpp.
| QgsWmsParameters QgsWmsRenderContext::parameters | ( | ) | const |
Returns WMS parameters.
Definition at line 72 of file qgswmsrendercontext.cpp.
| QgsWmsParametersLayer QgsWmsRenderContext::parameters | ( | const QgsMapLayer & | layer | ) | const |
Returns WMS parameters for a specific layer.
An empty instance is returned if not available.
Definition at line 113 of file qgswmsrendercontext.cpp.
| int QgsWmsRenderContext::precision | ( | ) | const |
Returns the precision to use according to the current configuration.
Definition at line 153 of file qgswmsrendercontext.cpp.
| const QgsProject * QgsWmsRenderContext::project | ( | ) | const |
Returns the project.
Definition at line 82 of file qgswmsrendercontext.cpp.
| double QgsWmsRenderContext::scaleDenominator | ( | ) | const |
Returns the scale denominator to use for rendering according to the current configuration.
Definition at line 227 of file qgswmsrendercontext.cpp.
| void QgsWmsRenderContext::setFlag | ( | Flag | flag, |
| bool | on = true |
||
| ) |
Sets or unsets a rendering flag according to the on value.
Definition at line 55 of file qgswmsrendercontext.cpp.
| void QgsWmsRenderContext::setParameters | ( | const QgsWmsParameters & | parameters | ) |
Sets WMS parameters.
Definition at line 41 of file qgswmsrendercontext.cpp.
| void QgsWmsRenderContext::setScaleDenominator | ( | double | scaleDenominator | ) |
Sets a custom scale denominator.
In this case, layers to render are updated according to their scale visibility.
Definition at line 243 of file qgswmsrendercontext.cpp.
| const QgsServerSettings & QgsWmsRenderContext::settings | ( | ) | const |
Returns settings of the server.
Definition at line 77 of file qgswmsrendercontext.cpp.
| QDomElement QgsWmsRenderContext::sld | ( | const QgsMapLayer & | layer | ) | const |
Returns a SLD document for a specific layer.
An empty document is returned if not available.
Definition at line 87 of file qgswmsrendercontext.cpp.
| QString QgsWmsRenderContext::style | ( | const QgsMapLayer & | layer | ) | const |
Returns a style's name for a specific layer.
An empty string is returned if not available.
Definition at line 100 of file qgswmsrendercontext.cpp.
| bool QgsWmsRenderContext::testFlag | ( | Flag | flag | ) | const |
Returns the status of a rendering flag.
| flag | The flag to test |
Definition at line 67 of file qgswmsrendercontext.cpp.
| int QgsWmsRenderContext::tileBuffer | ( | ) | const |
Returns the tile buffer value to use for rendering according to the current configuration.
Definition at line 141 of file qgswmsrendercontext.cpp.
| bool QgsWmsRenderContext::updateExtent | ( | ) | const |
Returns true if the extent has to be updated before the rendering, false otherwise.
Definition at line 249 of file qgswmsrendercontext.cpp.
1.8.20