QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
qgsrenderedfeaturehandlerinterface.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsrenderedfeaturehandlerinterface.h
3
--------------------------------------
4
Date : August 2019
5
Copyright : (C) 2019 by Nyall Dawson
6
Email : nyall dot dawson 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 QGSRENDEREDFEATUREHANDLERINTERFACE_H
17
#define QGSRENDEREDFEATUREHANDLERINTERFACE_H
18
19
#include "qgis_core.h"
20
#include "
qgis_sip.h
"
21
22
#include <QSet>
23
#include <QString>
24
25
class
QgsFeature
;
26
class
QgsGeometry
;
27
class
QgsRenderContext
;
28
class
QgsVectorLayer
;
29
47
class
CORE_EXPORT
QgsRenderedFeatureHandlerInterface
48
{
49
public
:
50
virtual
~QgsRenderedFeatureHandlerInterface
() =
default
;
51
52
struct
CORE_EXPORT
RenderedFeatureContext
53
{
58
RenderedFeatureContext
(
const
QgsRenderContext
&
renderContext
)
59
:
renderContext
(
renderContext
)
60
{}
61
65
const
QgsRenderContext
&
renderContext
;
66
67
private
:
68
#ifdef SIP_RUN
69
RenderedFeatureContext
&operator=(
const
RenderedFeatureContext
& );
70
#endif
71
};
72
87
virtual
void
handleRenderedFeature
(
const
QgsFeature
&feature,
const
QgsGeometry
&renderedBounds,
const
QgsRenderedFeatureHandlerInterface::RenderedFeatureContext
&context ) = 0;
88
93
virtual
QSet<QString>
usedAttributes
(
QgsVectorLayer
*layer,
const
QgsRenderContext
&context )
const
94
{
95
Q_UNUSED( layer );
96
Q_UNUSED( context );
97
return
QSet< QString >();
98
}
99
};
100
101
#endif
// QGSRENDEREDFEATUREHANDLERINTERFACE_H
QgsFeature
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition
qgsfeature.h:60
QgsGeometry
A geometry is the spatial representation of a feature.
Definition
qgsgeometry.h:267
QgsRenderContext
Contains information about the context of a rendering operation.
Definition
qgsrendercontext.h:63
QgsRenderedFeatureHandlerInterface
An interface for classes which provide custom handlers for features rendered as part of a map render ...
Definition
qgsrenderedfeaturehandlerinterface.h:48
QgsRenderedFeatureHandlerInterface::usedAttributes
virtual QSet< QString > usedAttributes(QgsVectorLayer *layer, const QgsRenderContext &context) const
Returns a list of attributes required by this handler, for the specified layer.
Definition
qgsrenderedfeaturehandlerinterface.h:93
QgsRenderedFeatureHandlerInterface::~QgsRenderedFeatureHandlerInterface
virtual ~QgsRenderedFeatureHandlerInterface()=default
QgsRenderedFeatureHandlerInterface::handleRenderedFeature
virtual void handleRenderedFeature(const QgsFeature &feature, const QgsGeometry &renderedBounds, const QgsRenderedFeatureHandlerInterface::RenderedFeatureContext &context)=0
Called whenever a feature is rendered during a map render job.
QgsVectorLayer
Represents a vector layer which manages a vector based dataset.
Definition
qgsvectorlayer.h:414
qgis_sip.h
QgsRenderedFeatureHandlerInterface::RenderedFeatureContext
Definition
qgsrenderedfeaturehandlerinterface.h:53
QgsRenderedFeatureHandlerInterface::RenderedFeatureContext::renderContext
const QgsRenderContext & renderContext
The render context which was used while rendering feature.
Definition
qgsrenderedfeaturehandlerinterface.h:65
QgsRenderedFeatureHandlerInterface::RenderedFeatureContext::RenderedFeatureContext
RenderedFeatureContext(const QgsRenderContext &renderContext)
Constructor for RenderedFeatureContext.
Definition
qgsrenderedfeaturehandlerinterface.h:58
Generated on
for QGIS API Documentation by
1.17.0