Implementation of threaded rendering for annotation layers. More...
#include <qgsannotationlayerrenderer.h>
Public Member Functions | |
| QgsAnnotationLayerRenderer (QgsAnnotationLayer *layer, QgsRenderContext &context) | |
| Constructor for a QgsAnnotationLayerRenderer, for the specified layer. More... | |
| ~QgsAnnotationLayerRenderer () override | |
| QgsFeedback * | feedback () const override |
Access to feedback object of the layer renderer (may be nullptr) More... | |
| bool | forceRasterRender () const override |
Returns true if the renderer must be rendered to a raster paint device (e.g. More... | |
| bool | render () override |
| Do the rendering (based on data stored in the class). More... | |
 Public Member Functions inherited from QgsMapLayerRenderer | |
| QgsMapLayerRenderer (const QString &layerID, QgsRenderContext *context=nullptr) | |
| Constructor for QgsMapLayerRenderer, with the associated layerID and render context. More... | |
| virtual | ~QgsMapLayerRenderer ()=default |
| QStringList | errors () const |
| Returns list of errors (problems) that happened during the rendering. More... | |
| bool | isReadyToCompose () const |
| Returns whether the renderer has already drawn (at least partially) some data. More... | |
| QString | layerId () const |
| Gets access to the ID of the layer rendered by this class. More... | |
| QgsRenderContext * | renderContext () |
| Returns the render context associated with the renderer. More... | |
| const QgsRenderContext * | renderContext () const |
| Returns the render context associated with the renderer. More... | |
| virtual void | setLayerRenderingTimeHint (int time) |
| Sets approximate render time (in ms) for the layer to render. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from QgsMapLayerRenderer | |
| QStringList | mErrors |
| QString | mLayerID |
| bool | mReadyToCompose = true |
| The flag must be set to false in renderer's constructor if wants to use the smarter map redraws functionality https://github.com/qgis/QGIS-Enhancement-Proposals/issues/181. More... | |
| Static Protected Attributes inherited from QgsMapLayerRenderer | |
| static constexpr int | MAX_TIME_TO_USE_CACHED_PREVIEW_IMAGE = 3000 |
| Maximum time (in ms) to allow display of a previously cached preview image while rendering layers, before switching to a progressive rendering display. More... | |
Detailed Description
Implementation of threaded rendering for annotation layers.
- Note
- not available in Python bindings
- Since
- QGIS 3.16
Definition at line 36 of file qgsannotationlayerrenderer.h.
Constructor & Destructor Documentation
◆ QgsAnnotationLayerRenderer()
| QgsAnnotationLayerRenderer::QgsAnnotationLayerRenderer | ( | QgsAnnotationLayer * | layer, |
| QgsRenderContext & | context | ||
| ) |
Constructor for a QgsAnnotationLayerRenderer, for the specified layer.
Definition at line 21 of file qgsannotationlayerrenderer.cpp.
◆ ~QgsAnnotationLayerRenderer()
|
override |
Definition at line 38 of file qgsannotationlayerrenderer.cpp.
Member Function Documentation
◆ feedback()
|
overridevirtual |
Access to feedback object of the layer renderer (may be nullptr)
- Since
- QGIS 3.0
Reimplemented from QgsMapLayerRenderer.
Definition at line 43 of file qgsannotationlayerrenderer.cpp.
◆ forceRasterRender()
|
overridevirtual |
Returns true if the renderer must be rendered to a raster paint device (e.g.
QImage).
Some layer settings require layers to be effectively "flattened" while rendering maps, which is achieved by first rendering the layer onto a raster paint device and then compositing the resultant image onto the final map render.
E.g. if a layer contains features with transparency or alternative blending modes, and the effects of these opacity or blending modes should be restricted to only affect other features within the SAME layer, then a flattened raster based render is required.
Subclasses should return true whenever their corresponding layer settings require the layer to always be rendered using a raster paint device.
- Since
- QGIS 3.18
Reimplemented from QgsMapLayerRenderer.
Definition at line 66 of file qgsannotationlayerrenderer.cpp.
◆ render()
|
overridevirtual |
Do the rendering (based on data stored in the class).
Returns true if the layer was completely rendered successfully (i.e. the render was not canceled early).
Implements QgsMapLayerRenderer.
Definition at line 48 of file qgsannotationlayerrenderer.cpp.
The documentation for this class was generated from the following files:
- /build/qgis-3.20.0+99unstable/src/core/annotations/qgsannotationlayerrenderer.h
- /build/qgis-3.20.0+99unstable/src/core/annotations/qgsannotationlayerrenderer.cpp
