QGIS API Documentation 3.41.0-Master (181b2f43d8e)
Loading...
Searching...
No Matches
qgssymbolrendercontext.h
Go to the documentation of this file.
1/***************************************************************************
2 qgssymbolrendercontext.h
3 ---------------------
4 begin : November 2009
5 copyright : (C) 2009 by Martin Dobias
6 email : wonder dot sk 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 QGSSYMBOLRENDERCONTEXT_H
17#define QGSSYMBOLRENDERCONTEXT_H
18
19#include "qgis_core.h"
20#include "qgis.h"
21#include "qgsmapunitscale.h"
22#include "qgsfields.h"
23
25class QgsFeature;
28
33class CORE_EXPORT QgsSymbolRenderContext
34{
35 public:
36
37 //TODO QGIS 4.0 - remove mapUnitScale and renderunit
38
50 QgsSymbolRenderContext( QgsRenderContext &c, Qgis::RenderUnit u, qreal opacity = 1.0, bool selected = false, Qgis::SymbolRenderHints renderHints = Qgis::SymbolRenderHints(), const QgsFeature *f = nullptr, const QgsFields &fields = QgsFields(), const QgsMapUnitScale &mapUnitScale = QgsMapUnitScale() );
51
53
55
59 QgsRenderContext &renderContext() { return mRenderContext; }
60
65 const QgsRenderContext &renderContext() const { return mRenderContext; } SIP_SKIP
66
72 void setOriginalValueVariable( const QVariant &value );
73
78 Q_DECL_DEPRECATED Qgis::RenderUnit outputUnit() const SIP_DEPRECATED { return mOutputUnit; }
79
84 Q_DECL_DEPRECATED void setOutputUnit( Qgis::RenderUnit u ) SIP_DEPRECATED { mOutputUnit = u; }
85
89 Q_DECL_DEPRECATED QgsMapUnitScale mapUnitScale() const SIP_DEPRECATED { return mMapUnitScale; }
90
94 Q_DECL_DEPRECATED void setMapUnitScale( const QgsMapUnitScale &scale ) SIP_DEPRECATED { mMapUnitScale = scale; }
95
101 qreal opacity() const { return mOpacity; }
102
108 void setOpacity( qreal opacity ) { mOpacity = opacity; }
109
114 bool selected() const { return mSelected; }
115
120 void setSelected( bool selected ) { mSelected = selected; }
121
126 Qgis::SymbolRenderHints renderHints() const { return mRenderHints; }
127
134 bool forceVectorRendering() const;
135
140 void setRenderHints( Qgis::SymbolRenderHints hints ) { mRenderHints = hints; }
141
148 void setRenderHint( Qgis::SymbolRenderHint hint, bool enabled = true ) { mRenderHints.setFlag( hint, enabled ); }
149
150 void setFeature( const QgsFeature *f ) { mFeature = f; }
151
155 const QgsFeature *feature() const { return mFeature; }
156
161 void setOriginalGeometryType( Qgis::GeometryType type ) { mOriginalGeometryType = type; }
162
170 Qgis::GeometryType originalGeometryType() const { return mOriginalGeometryType; }
171
177 QgsFields fields() const { return mFields; }
178
182 int geometryPartCount() const { return mGeometryPartCount; }
183
187 void setGeometryPartCount( int count ) { mGeometryPartCount = count; }
188
192 int geometryPartNum() const { return mGeometryPartNum; }
193
197 void setGeometryPartNum( int num ) { mGeometryPartNum = num; }
198
202 Q_DECL_DEPRECATED double outputLineWidth( double width ) const SIP_DEPRECATED;
203
207 Q_DECL_DEPRECATED double outputPixelSize( double size ) const SIP_DEPRECATED;
208
209 // workaround for sip 4.7. Don't use assignment - will fail with assertion error
211
217 QgsExpressionContextScope *expressionContextScope();
218
226 void setExpressionContextScope( QgsExpressionContextScope *contextScope SIP_TRANSFER );
227
234 const QgsLegendPatchShape *patchShape() const;
235
242 void setPatchShape( const QgsLegendPatchShape &shape );
243
244 private:
245
246#ifdef SIP_RUN
248#endif
249
250 QgsRenderContext &mRenderContext;
251 std::unique_ptr< QgsExpressionContextScope > mExpressionContextScope;
252 Qgis::RenderUnit mOutputUnit;
253 QgsMapUnitScale mMapUnitScale;
254 qreal mOpacity = 1.0;
255 bool mSelected;
256 Qgis::SymbolRenderHints mRenderHints;
257 const QgsFeature *mFeature; //current feature
258 QgsFields mFields;
259 int mGeometryPartCount;
260 int mGeometryPartNum;
261 Qgis::GeometryType mOriginalGeometryType = Qgis::GeometryType::Unknown;
262 std::unique_ptr< QgsLegendPatchShape > mPatchShape;
263};
264
265
266#endif // QGSSYMBOLRENDERCONTEXT_H
267
SymbolRenderHint
Flags controlling behavior of symbols during rendering.
Definition qgis.h:733
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:337
@ Unknown
Unknown types.
RenderUnit
Rendering size units.
Definition qgis.h:4892
QFlags< SymbolRenderHint > SymbolRenderHints
Symbol render hints.
Definition qgis.h:741
Single scope for storing variables and functions for use within a QgsExpressionContext.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Container of fields for a vector layer.
Definition qgsfields.h:46
Represents a patch shape for use in map legends.
Struct for storing maximum and minimum scales for measurements in map units.
Contains information about the context of a rendering operation.
void setOpacity(qreal opacity)
Sets the opacity for the symbol.
void setRenderHint(Qgis::SymbolRenderHint hint, bool enabled=true)
Sets a rendering hint flag for the symbol.
const QgsFeature * feature() const
Returns the current feature being rendered.
Q_DECL_DEPRECATED void setMapUnitScale(const QgsMapUnitScale &scale)
Qgis::GeometryType originalGeometryType() const
Returns the geometry type for the original feature geometry being rendered.
QgsFields fields() const
Fields of the layer.
void setSelected(bool selected)
Sets whether symbols should be rendered using the selected symbol coloring and style.
void setOriginalGeometryType(Qgis::GeometryType type)
Sets the geometry type for the original feature geometry being rendered.
int geometryPartNum() const
Part number of current geometry.
bool selected() const
Returns true if symbols should be rendered using the selected symbol coloring and style.
Qgis::SymbolRenderHints renderHints() const
Returns the rendering hint flags for the symbol.
Q_DECL_DEPRECATED QgsMapUnitScale mapUnitScale() const
int geometryPartCount() const
Part count of current geometry.
void setRenderHints(Qgis::SymbolRenderHints hints)
Sets rendering hint flags for the symbol.
void setGeometryPartCount(int count)
Sets the part count of current geometry.
const QgsRenderContext & renderContext() const
Returns a reference to the context's render context.
void setGeometryPartNum(int num)
Sets the part number of current geometry.
Q_DECL_DEPRECATED Qgis::RenderUnit outputUnit() const
Returns the output unit for the context.
QgsSymbolRenderContext(const QgsSymbolRenderContext &rh)=delete
Q_DECL_DEPRECATED void setOutputUnit(Qgis::RenderUnit u)
Sets the output unit for the context.
void setFeature(const QgsFeature *f)
qreal opacity() const
Returns the opacity for the symbol.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
#define SIP_DEPRECATED
Definition qgis_sip.h:106
#define SIP_FORCE
Definition qgis_sip.h:131
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_TRANSFER
Definition qgis_sip.h:36