QGIS API Documentation 4.3.0-Master (35968c35f7e)
Loading...
Searching...
No Matches
qgsdoubleboxscalebarrenderer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsdoubleboxscalebarrenderer.cpp
3 --------------------------------
4 begin : June 2008
5 copyright : (C) 2008 by Marco Hugentobler
6 email : marco.hugentobler@karto.baug.ethz.ch
7 ***************************************************************************/
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
18
19#include "qgsfillsymbol.h"
20#include "qgsfillsymbollayer.h"
21#include "qgslinesymbol.h"
22#include "qgspainting.h"
23#include "qgsscalebarsettings.h"
24#include "qgssymbol.h"
25#include "qgstextrenderer.h"
26
27#include <QList>
28#include <QPainter>
29#include <QString>
30
31using namespace Qt::StringLiterals;
32
34{
35 return u"Double Box"_s;
36}
37
39{
40 return QObject::tr( "Double Box" );
41}
42
56
58{
59 return 2;
60}
61
66
67void QgsDoubleBoxScaleBarRenderer::draw( QgsRenderContext &context, const QgsScaleBarSettings &settings, const ScaleBarContext &scaleContext ) const
68{
69 if ( !context.painter() )
70 {
71 return;
72 }
73 QPainter *painter = context.painter();
74
75 const double barTopPosition = verticalOffset( context, settings );
76 const double segmentHeight = context.convertToPainterUnits( settings.height() / 2, Qgis::RenderUnit::Millimeters );
77
78 QgsScopedQPainterState painterState( painter );
79 context.setPainterFlagsUsingContext( painter );
80
81 std::unique_ptr< QgsLineSymbol > lineSymbol( settings.lineSymbol()->clone() );
82 lineSymbol->startRender( context );
83
84 std::unique_ptr< QgsFillSymbol > fillSymbol1( settings.fillSymbol()->clone() );
85 fillSymbol1->startRender( context );
86
87 std::unique_ptr< QgsFillSymbol > fillSymbol2( settings.alternateFillSymbol()->clone() );
88 fillSymbol2->startRender( context );
89
90 painter->setPen( Qt::NoPen );
91 painter->setBrush( Qt::NoBrush );
92
93 bool useColor = true; //alternate brush color/white
94
95 const double xOffset = firstLabelXOffset( settings, context, scaleContext );
96
97 const QList<double> positions = segmentPositions( context, scaleContext, settings );
98 const QList<double> widths = segmentWidths( scaleContext, settings );
99
100 double minX = 0;
101 double maxX = 0;
102 QgsFillSymbol *currentSymbol = nullptr;
103 for ( int i = 0; i < positions.size(); ++i )
104 {
105 //draw top half
106 if ( useColor )
107 {
108 currentSymbol = fillSymbol1.get();
109 }
110 else //secondary symbol
111 {
112 currentSymbol = fillSymbol2.get();
113 }
114
115 const double thisX = context.convertToPainterUnits( positions.at( i ), Qgis::RenderUnit::Millimeters ) + xOffset;
116 const double thisWidth = context.convertToPainterUnits( widths.at( i ), Qgis::RenderUnit::Millimeters );
117
118 if ( i == 0 )
119 minX = thisX;
120 if ( i == positions.size() - 1 )
121 maxX = thisX + thisWidth;
122
123 const QRectF segmentRectTop( thisX, barTopPosition, thisWidth, segmentHeight );
124 currentSymbol
125 ->renderPolygon( QPolygonF() << segmentRectTop.topLeft() << segmentRectTop.topRight() << segmentRectTop.bottomRight() << segmentRectTop.bottomLeft() << segmentRectTop.topLeft(), nullptr, nullptr, context );
126 painter->drawRect( segmentRectTop );
127
128 //draw bottom half
129 if ( useColor )
130 {
131 //secondary symbol
132 currentSymbol = fillSymbol2.get();
133 }
134 else //primary symbol
135 {
136 currentSymbol = fillSymbol1.get();
137 ;
138 }
139
140 const QRectF segmentRectBottom( thisX, barTopPosition + segmentHeight, thisWidth, segmentHeight );
141
142 currentSymbol
143 ->renderPolygon( QPolygonF() << segmentRectBottom.topLeft() << segmentRectBottom.topRight() << segmentRectBottom.bottomRight() << segmentRectBottom.bottomLeft() << segmentRectBottom.topLeft(), nullptr, nullptr, context );
144 useColor = !useColor;
145 }
146
147
148 // and then the lines
149 // note that we do this layer-by-layer, to avoid ugliness where the lines touch the outer rect
150 for ( int layer = 0; layer < lineSymbol->symbolLayerCount(); ++layer )
151 {
152 // vertical lines
153 for ( int i = 1; i < positions.size(); ++i )
154 {
155 const double lineX = context.convertToPainterUnits( positions.at( i ), Qgis::RenderUnit::Millimeters ) + xOffset;
156 lineSymbol->renderPolyline( QPolygonF() << QPointF( lineX, barTopPosition ) << QPointF( lineX, barTopPosition + segmentHeight * 2 ), nullptr, context, layer );
157 }
158
159 // middle horizontal line
160 lineSymbol->renderPolyline( QPolygonF() << QPointF( minX, barTopPosition + segmentHeight ) << QPointF( maxX, barTopPosition + segmentHeight ), nullptr, context, layer );
161
162
163 // outside line
164 lineSymbol->renderPolyline(
165 QPolygonF()
166 << QPointF( minX, barTopPosition )
167 << QPointF( maxX, barTopPosition )
168 << QPointF( maxX, barTopPosition + segmentHeight * 2 )
169 << QPointF( minX, barTopPosition + segmentHeight * 2 )
170 << QPointF( minX, barTopPosition ),
171 nullptr,
172 context,
173 layer
174 );
175 }
176
177 lineSymbol->stopRender( context );
178 fillSymbol1->stopRender( context );
179 fillSymbol2->stopRender( context );
180
181 painterState.restore();
182
183 //draw labels using the default method
184 drawDefaultLabels( context, settings, scaleContext );
185}
186
188{
189 QgsSimpleFillSymbolLayer *fill = dynamic_cast< QgsSimpleFillSymbolLayer * >( settings.fillSymbol()->symbolLayers().at( 0 ) );
190
191 // restore the fill symbols by default
192 if ( fill && fill->brushStyle() == Qt::NoBrush )
193 {
194 auto fillSymbol = std::make_unique< QgsFillSymbol >();
195 auto fillSymbolLayer = std::make_unique< QgsSimpleFillSymbolLayer >();
196 fillSymbolLayer->setColor( QColor( 0, 0, 0 ) );
197 fillSymbolLayer->setBrushStyle( Qt::SolidPattern );
198 fillSymbolLayer->setStrokeStyle( Qt::SolidLine );
199 fillSymbol->changeSymbolLayer( 0, fillSymbolLayer.release() );
200 settings.setFillSymbol( fillSymbol.release() );
201
202 fillSymbol = std::make_unique< QgsFillSymbol >();
203 fillSymbolLayer = std::make_unique< QgsSimpleFillSymbolLayer >();
204 fillSymbolLayer->setColor( QColor( 255, 255, 255 ) );
205 fillSymbolLayer->setStrokeStyle( Qt::NoPen );
206 fillSymbol->changeSymbolLayer( 0, fillSymbolLayer.release() );
207 settings.setAlternateFillSymbol( fillSymbol.release() );
208 }
209
210 return true;
211}
@ Millimeters
Millimeters.
Definition qgis.h:5759
Flags flags() const override
Returns the scalebar rendering flags, which dictates the renderer's behavior.
void draw(QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const override
Draws the scalebar using the specified settings and scaleContext to a destination render context.
bool applyDefaultSettings(QgsScaleBarSettings &settings) const override
Applies any default settings relating to the scalebar to the passed settings object.
QString id() const override
Returns the unique ID for this renderer.
QString visibleName() const override
Returns the user friendly, translated name for the renderer.
QgsDoubleBoxScaleBarRenderer * clone() const override
Returns a clone of the renderer.
int sortKey() const override
Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists.
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
void renderPolygon(const QPolygonF &points, const QVector< QPolygonF > *rings, const QgsFeature *f, QgsRenderContext &context, int layer=-1, bool selected=false)
Renders the symbol using the given render context.
QgsFillSymbol * clone() const override
Returns a deep copy of this symbol.
QgsLineSymbol * clone() const override
Returns a deep copy of this symbol.
Contains information about the context of a rendering operation.
double convertToPainterUnits(double size, Qgis::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
QPainter * painter()
Returns the destination QPainter for the render operation.
void setPainterFlagsUsingContext(QPainter *painter=nullptr) const
Sets relevant flags on a destination painter, using the flags and settings currently defined for the ...
double verticalOffset(QgsRenderContext &context, const QgsScaleBarSettings &settings) const
Calculates the vertical offset to the top of the bar, accounting for text placed above the bar.
void drawDefaultLabels(QgsRenderContext &context, const QgsScaleBarSettings &settings, const QgsScaleBarRenderer::ScaleBarContext &scaleContext) const
Draws default scalebar labels using the specified settings and scaleContext to a destination render c...
QList< double > segmentWidths(const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
Returns a list of widths of each segment of the scalebar.
Q_DECL_DEPRECATED QList< double > segmentPositions(const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
Returns a list of positions for each segment within the scalebar.
Q_DECL_DEPRECATED double firstLabelXOffset(const QgsScaleBarSettings &settings) const
Returns the x-offset (in millimeters) used for the first label in the scalebar.
@ FlagUsesLabelVerticalPlacement
Renderer uses the QgsScaleBarSettings::labelVerticalPlacement() setting.
@ FlagUsesLabelHorizontalPlacement
Renderer uses the QgsScaleBarSettings::labelHorizontalPlacement() setting.
@ FlagUsesLineSymbol
Renderer utilizes the scalebar line symbol (see QgsScaleBarSettings::lineSymbol() ).
@ FlagUsesUnitLabel
Renderer uses the QgsScaleBarSettings::unitLabel() setting.
@ FlagUsesSegments
Renderer uses the scalebar segments.
@ FlagUsesLabelBarSpace
Renderer uses the QgsScaleBarSettings::labelBarSpace() setting.
@ FlagUsesFillSymbol
Renderer utilizes the scalebar fill symbol (see QgsScaleBarSettings::fillSymbol() ).
@ FlagRespectsMapUnitsPerScaleBarUnit
Renderer respects the QgsScaleBarSettings::mapUnitsPerScaleBarUnit() setting.
@ FlagRespectsUnits
Renderer respects the QgsScaleBarSettings::units() setting.
@ FlagUsesAlternateFillSymbol
Renderer utilizes the alternate scalebar fill symbol (see QgsScaleBarSettings::alternateFillSymbol() ...
Stores the appearance and layout settings for scalebar drawing with QgsScaleBarRenderer.
QgsLineSymbol * lineSymbol() const
Returns the line symbol used to render the scalebar (only used for some scalebar types).
void setAlternateFillSymbol(QgsFillSymbol *symbol)
Sets the secondary fill symbol used to render the scalebar (only used for some scalebar types).
void setFillSymbol(QgsFillSymbol *symbol)
Sets the primary fill symbol used to render the scalebar (only used for some scalebar types).
QgsFillSymbol * alternateFillSymbol() const
Returns the secondary fill symbol used to render the scalebar (only used for some scalebar types).
QgsFillSymbol * fillSymbol() const
Returns the primary fill symbol used to render the scalebar (only used for some scalebar types).
double height() const
Returns the scalebar height (in millimeters).
Scoped object for saving and restoring a QPainter object's state.
void restore()
Performs a manual restore on the painter state, popping the latest state from the painter.
Renders polygons using a single fill and stroke color.
Qt::BrushStyle brushStyle() const
Contains parameters regarding scalebar calculations.