QGIS API Documentation 3.99.0-Master (d270888f95f)
Loading...
Searching...
No Matches
qgs25drenderer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgs25drenderer.cpp - qgs25drenderer
3 -----------------------------------
4
5 begin : 14.1.2016
6 Copyright : (C) 2016 Matthias Kuhn
7 Email : matthias at opengis dot ch
8 ***************************************************************************
9 * *
10 * This program is free software; you can redistribute it and/or modify *
11 * it under the terms of the GNU General Public License as published by *
12 * the Free Software Foundation; either version 2 of the License, or *
13 * (at your option) any later version. *
14 * *
15 ***************************************************************************/
16#include "qgs25drenderer.h"
17
18#include <memory>
19
20#include "qgseffectstack.h"
21#include "qgsfillsymbol.h"
22#include "qgsfillsymbollayer.h"
24#include "qgsgloweffect.h"
25#include "qgspainteffect.h"
26#include "qgsproperty.h"
28#include "qgssymbollayerutils.h"
29
30#include <QString>
31
32using namespace Qt::StringLiterals;
33
34#define ROOF_EXPRESSION \
35 "translate(" \
36 " @geometry," \
37 " cos( radians( eval( @qgis_25d_angle ) ) ) * eval( @qgis_25d_height )," \
38 " sin( radians( eval( @qgis_25d_angle ) ) ) * eval( @qgis_25d_height )" \
39 ")"
40
41#define WALL_EXPRESSION \
42 "order_parts( "\
43 " extrude(" \
44 " segments_to_lines( @geometry )," \
45 " cos( radians( eval( @qgis_25d_angle ) ) ) * eval( @qgis_25d_height )," \
46 " sin( radians( eval( @qgis_25d_angle ) ) ) * eval( @qgis_25d_height )" \
47 " )," \
48 " 'distance( @geometry, translate( @map_extent_center, 1000 * @map_extent_width * cos( radians( @qgis_25d_angle + 180 ) ), 1000 * @map_extent_width * sin( radians( @qgis_25d_angle + 180 ) ) ))'," \
49 " False" \
50 ")"
51
52#define ORDER_BY_EXPRESSION \
53 "distance(" \
54 " @geometry," \
55 " translate(" \
56 " @map_extent_center," \
57 " 1000 * @map_extent_width * cos( radians( @qgis_25d_angle + 180 ) )," \
58 " 1000 * @map_extent_width * sin( radians( @qgis_25d_angle + 180 ) )" \
59 " )" \
60 ")"
61
62#define WALL_SHADING_EXPRESSION \
63 "set_color_part( " \
64 " @symbol_color," \
65 " 'value'," \
66 " 40 + 19 * abs( $pi - azimuth( " \
67 " point_n( geometry_n(@geometry, @geometry_part_num) , 1 ), " \
68 " point_n( geometry_n(@geometry, @geometry_part_num) , 2 )" \
69 " ) ) " \
70 ")"
71
73 : QgsFeatureRenderer( u"25dRenderer"_s )
74{
75 mSymbol = std::make_unique<QgsFillSymbol>( );
76
77 mSymbol->deleteSymbolLayer( 0 ); // We never asked for the default layer
78
80
81 QVariantMap wallProperties;
82 wallProperties.insert( u"geometryModifier"_s, WALL_EXPRESSION );
83 wallProperties.insert( u"symbolType"_s, u"Fill"_s );
85
86 QVariantMap roofProperties;
87 roofProperties.insert( u"geometryModifier"_s, ROOF_EXPRESSION );
88 roofProperties.insert( u"symbolType"_s, u"Fill"_s );
90
91 floor->setLocked( true );
92
93 mSymbol->appendSymbolLayer( floor );
94 mSymbol->appendSymbolLayer( walls );
95 mSymbol->appendSymbolLayer( roof );
96
97 QgsEffectStack *effectStack = new QgsEffectStack();
98 QgsOuterGlowEffect *glowEffect = new QgsOuterGlowEffect();
99 glowEffect->setBlurLevel( 5 );
100 glowEffect->setSpreadUnit( Qgis::RenderUnit::MapUnits );
101 effectStack->appendEffect( glowEffect );
102 floor->setPaintEffect( effectStack );
103
104 // These methods must only be used after the above initialization!
105
106 setRoofColor( QColor( 177, 169, 124 ) );
107 setWallColor( QColor( 119, 119, 119 ) );
108
109 wallLayer()->setDataDefinedProperty( QgsSymbolLayer::Property::FillColor, QgsProperty::fromExpression( QString( WALL_SHADING_EXPRESSION ) ) );
110
111 setShadowSpread( 4 );
112 setShadowColor( QColor( 17, 17, 17 ) );
113
117 false );
118
120 setOrderByEnabled( true );
121}
122
123QDomElement Qgs25DRenderer::save( QDomDocument &doc, const QgsReadWriteContext &context )
124{
125 QDomElement rendererElem = doc.createElement( RENDERER_TAG_NAME );
126
127 rendererElem.setAttribute( u"type"_s, u"25dRenderer"_s );
128
129 const QDomElement symbolElem = QgsSymbolLayerUtils::saveSymbol( u"symbol"_s, mSymbol.get(), doc, context );
130
131 saveRendererData( doc, rendererElem, context );
132
133 rendererElem.appendChild( symbolElem );
134
135 return rendererElem;
136}
137
139{
141 if ( mSymbol && mSymbol->flags().testFlag( Qgis::SymbolFlag::AffectsLabeling ) )
143
144 return res;
145}
146
147QgsFeatureRenderer *Qgs25DRenderer::create( QDomElement &element, const QgsReadWriteContext &context )
148{
149 Qgs25DRenderer *renderer = new Qgs25DRenderer();
150
151 const QDomNodeList symbols = element.elementsByTagName( u"symbol"_s );
152 if ( symbols.size() )
153 {
154 renderer->mSymbol = QgsSymbolLayerUtils::loadSymbol( symbols.at( 0 ).toElement(), context );
155 }
156
157 return renderer;
158}
159
161{
162 QgsFeatureRenderer::startRender( context, fields );
163
164 mSymbol->startRender( context, fields );
165}
166
168{
170
171 mSymbol->stopRender( context );
172}
173
174QSet<QString> Qgs25DRenderer::usedAttributes( const QgsRenderContext &context ) const
175{
176 return mSymbol->usedAttributes( context );
177}
178
180{
182 c->mSymbol.reset( mSymbol->clone() );
183 return c;
184}
185
187{
188 Q_UNUSED( feature )
189 Q_UNUSED( context )
190 return mSymbol.get();
191}
192
194{
195 Q_UNUSED( context )
196 QgsSymbolList lst;
197 lst.append( mSymbol.get() );
198 return lst;
199}
200
202{
203 if ( mSymbol )
204 {
205 QgsStyleSymbolEntity entity( mSymbol.get() );
206 return visitor->visit( QgsStyleEntityVisitorInterface::StyleLeaf( &entity ) );
207 }
208 return true;
209}
210
211QgsFillSymbolLayer *Qgs25DRenderer::roofLayer() const
212{
213 return static_cast<QgsFillSymbolLayer *>( mSymbol->symbolLayer( 2 )->subSymbol()->symbolLayer( 0 ) );
214}
215
216QgsFillSymbolLayer *Qgs25DRenderer::wallLayer() const
217{
218 return static_cast<QgsFillSymbolLayer *>( mSymbol->symbolLayer( 1 )->subSymbol()->symbolLayer( 0 ) );
219}
220
221QgsOuterGlowEffect *Qgs25DRenderer::glowEffect() const
222{
223 QgsEffectStack *stack = static_cast<QgsEffectStack *>( mSymbol->symbolLayer( 0 )->paintEffect() );
224 return static_cast<QgsOuterGlowEffect *>( stack->effect( 0 ) );
225}
226
228{
229 return glowEffect()->enabled();
230}
231
232void Qgs25DRenderer::setShadowEnabled( bool value ) const
233{
234 glowEffect()->setEnabled( value );
235}
236
238{
239 return glowEffect()->color();
240}
241
243{
244 glowEffect()->setColor( shadowColor );
245}
246
248{
249 return glowEffect()->spread();
250}
251
252void Qgs25DRenderer::setShadowSpread( double spread ) const
253{
254 glowEffect()->setSpread( spread );
255}
256
258{
259 return wallLayer()->fillColor();
260}
261
262void Qgs25DRenderer::setWallColor( const QColor &wallColor ) const
263{
264 wallLayer()->setFillColor( wallColor );
265 wallLayer()->setStrokeColor( wallColor );
266}
267
269{
270 wallLayer()->dataDefinedProperties().property( QgsSymbolLayer::Property::FillColor ).setActive( enabled );
271}
272
274{
275 return wallLayer()->dataDefinedProperties().property( QgsSymbolLayer::Property::FillColor ).isActive();
276}
277
279{
280 return roofLayer()->fillColor();
281}
282
283void Qgs25DRenderer::setRoofColor( const QColor &roofColor ) const
284{
285 roofLayer()->setFillColor( roofColor );
286 roofLayer()->setStrokeColor( roofColor );
287}
288
290{
291 if ( renderer->type() == "25dRenderer"_L1 )
292 {
293 return static_cast<Qgs25DRenderer *>( renderer->clone() );
294 }
295 else
296 {
297 auto res = std::make_unique< Qgs25DRenderer >();
298 renderer->copyRendererData( res.get() );
299 return res.release();
300 }
301}
302
QFlags< FeatureRendererFlag > FeatureRendererFlags
Flags controlling behavior of vector feature renderers.
Definition qgis.h:857
@ AffectsLabeling
If present, indicates that the renderer will participate in the map labeling problem.
Definition qgis.h:848
@ MapUnits
Map units.
Definition qgis.h:5257
@ AffectsLabeling
If present, indicates that the symbol will participate in the map labeling problem.
Definition qgis.h:868
Qgis::FeatureRendererFlags flags() const override
Returns flags associated with the renderer.
QgsSymbolList symbols(QgsRenderContext &context) const override
Returns list of symbols used by the renderer.
QgsSymbol * symbolForFeature(const QgsFeature &feature, QgsRenderContext &context) const override
To be overridden.
void stopRender(QgsRenderContext &context) override
Must be called when a render cycle has finished, to allow the renderer to clean up.
void setShadowSpread(double shadowSpread) const
Set the shadow's spread distance in map units.
QColor roofColor() const
Gets the roof color.
void setWallShadingEnabled(bool enabled) const
Set wall shading enabled.
QColor shadowColor() const
Gets the shadow's color.
QgsFeatureRenderer * clone() const override
Create a deep copy of this renderer.
static Qgs25DRenderer * convertFromRenderer(QgsFeatureRenderer *renderer)
Try to convert from an existing renderer.
double shadowSpread() const
Gets the shadow's spread distance in map units.
void startRender(QgsRenderContext &context, const QgsFields &fields) override
Must be called when a new render cycle is started.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer...
static QgsFeatureRenderer * create(QDomElement &element, const QgsReadWriteContext &context)
Create a new 2.5D renderer from XML.
void setShadowColor(const QColor &shadowColor) const
Set the shadow's color.
QSet< QString > usedAttributes(const QgsRenderContext &context) const override
Returns a list of attributes required by this renderer.
bool wallShadingEnabled() const
Gets wall shading enabled.
bool shadowEnabled() const
Is the shadow enabled.
void setRoofColor(const QColor &roofColor) const
Set the roof color.
QDomElement save(QDomDocument &doc, const QgsReadWriteContext &context) override
Stores renderer properties to an XML element.
void setWallColor(const QColor &wallColor) const
Set the wall color.
QColor wallColor() const
Gets the wall color.
void setShadowEnabled(bool value) const
Enable or disable the shadow.
A paint effect which consists of a stack of other chained paint effects.
void appendEffect(QgsPaintEffect *effect)
Appends an effect to the end of the stack.
QgsPaintEffect * effect(int index) const
Returns a pointer to the effect at a specified index within the stack.
void setOrderBy(const QgsFeatureRequest::OrderBy &orderBy)
Define the order in which features shall be processed by this renderer.
void setOrderByEnabled(bool enabled)
Sets whether custom ordering should be applied before features are processed by this renderer.
QgsPaintEffect * paintEffect() const
Returns the current paint effect for the renderer.
QgsFeatureRenderer(const QString &type)
virtual void stopRender(QgsRenderContext &context)
Must be called when a render cycle has finished, to allow the renderer to clean up.
QString type() const
void copyRendererData(QgsFeatureRenderer *destRenderer) const
Clones generic renderer data to another renderer.
void saveRendererData(QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context)
Saves generic renderer data into the specified element.
virtual void startRender(QgsRenderContext &context, const QgsFields &fields)
Must be called when a new render cycle is started.
QgsFeatureRequest::OrderBy orderBy() const
Gets the order in which features shall be processed by this renderer.
virtual QgsFeatureRenderer * clone() const =0
Create a deep copy of this renderer.
The OrderByClause class represents an order by clause for a QgsFeatureRequest.
Represents a list of OrderByClauses, with the most important first and the least important last.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:60
Container of fields for a vector layer.
Definition qgsfields.h:46
Abstract base class for fill symbol layers.
static QgsSymbolLayer * create(const QVariantMap &properties)
Creates the symbol layer.
A paint effect which draws a glow outside of a picture.
bool enabled() const
Returns whether the effect is enabled.
static QgsProperty fromExpression(const QString &expression, bool isActive=true)
Returns a new ExpressionBasedProperty created from the specified expression.
A container for the context for various read/write operations on objects.
Contains information about the context of a rendering operation.
static QgsSymbolLayer * create(const QVariantMap &properties=QVariantMap())
Creates a new QgsSimpleFillSymbolLayer using the specified properties map containing symbol propertie...
An interface for classes which can visit style entity (e.g.
virtual bool visit(const QgsStyleEntityVisitorInterface::StyleLeaf &entity)
Called when the visitor will visit a style entity.
A symbol entity for QgsStyle databases.
Definition qgsstyle.h:1398
static std::unique_ptr< QgsSymbol > loadSymbol(const QDomElement &element, const QgsReadWriteContext &context)
Attempts to load a symbol from a DOM element.
static QDomElement saveSymbol(const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
Abstract base class for symbol layers.
void setPaintEffect(QgsPaintEffect *effect)
Sets the current paint effect for the layer.
void setLocked(bool locked)
Sets whether the layer's colors are locked.
Abstract base class for all rendered symbols.
Definition qgssymbol.h:231
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 WALL_SHADING_EXPRESSION
#define ORDER_BY_EXPRESSION
#define WALL_EXPRESSION
#define ROOF_EXPRESSION
#define RENDERER_TAG_NAME
Definition qgsrenderer.h:57
QList< QgsSymbol * > QgsSymbolList
Definition qgsrenderer.h:51
Contains information relating to the style entity currently being visited.