QGIS API Documentation 3.27.0-Master (75dc696944)
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
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#include "qgsscalebarsettings.h"
19#include "qgslayoututils.h"
20#include "qgssymbol.h"
21#include "qgstextrenderer.h"
22#include "qgslinesymbol.h"
23#include "qgsfillsymbol.h"
24#include <QList>
25#include <QPainter>
26
28{
29 return QStringLiteral( "Double Box" );
30}
31
33{
34 return QObject::tr( "Double Box" );
35}
36
37QgsScaleBarRenderer::Flags QgsDoubleBoxScaleBarRenderer::flags() const
38{
49}
50
52{
53 return 2;
54}
55
57{
58 return new QgsDoubleBoxScaleBarRenderer( *this );
59}
60
61void QgsDoubleBoxScaleBarRenderer::draw( QgsRenderContext &context, const QgsScaleBarSettings &settings, const ScaleBarContext &scaleContext ) const
62{
63 if ( !context.painter() )
64 {
65 return;
66 }
67 QPainter *painter = context.painter();
68
69 const double scaledLabelBarSpace = context.convertToPainterUnits( settings.labelBarSpace(), QgsUnitTypes::RenderMillimeters );
70 const double scaledBoxContentSpace = context.convertToPainterUnits( settings.boxContentSpace(), QgsUnitTypes::RenderMillimeters );
71 const QFontMetricsF fontMetrics = QgsTextRenderer::fontMetrics( context, settings.textFormat() );
72 const double barTopPosition = scaledBoxContentSpace + ( settings.labelVerticalPlacement() == QgsScaleBarSettings::LabelAboveSegment ? fontMetrics.ascent() + scaledLabelBarSpace : 0 );
73 const double segmentHeight = context.convertToPainterUnits( settings.height() / 2, QgsUnitTypes::RenderMillimeters );
74
75 painter->save();
76 context.setPainterFlagsUsingContext( painter );
77
78 std::unique_ptr< QgsLineSymbol > lineSymbol( settings.lineSymbol()->clone() );
79 lineSymbol->startRender( context );
80
81 std::unique_ptr< QgsFillSymbol > fillSymbol1( settings.fillSymbol()->clone() );
82 fillSymbol1->startRender( context );
83
84 std::unique_ptr< QgsFillSymbol > fillSymbol2( settings.alternateFillSymbol()->clone() );
85 fillSymbol2->startRender( context );
86
87 painter->setPen( Qt::NoPen );
88 painter->setBrush( Qt::NoBrush );
89
90 bool useColor = true; //alternate brush color/white
91
92 const double xOffset = firstLabelXOffset( settings, context, scaleContext );
93
94 const QList<double> positions = segmentPositions( context, scaleContext, settings );
95 const QList<double> widths = segmentWidths( scaleContext, settings );
96
97 double minX = 0;
98 double maxX = 0;
99 QgsFillSymbol *currentSymbol = nullptr;
100 for ( int i = 0; i < positions.size(); ++i )
101 {
102 //draw top half
103 if ( useColor )
104 {
105 currentSymbol = fillSymbol1.get();
106 }
107 else //secondary symbol
108 {
109 currentSymbol = fillSymbol2.get();
110 }
111
112 const double thisX = context.convertToPainterUnits( positions.at( i ), QgsUnitTypes::RenderMillimeters ) + xOffset;
113 const double thisWidth = context.convertToPainterUnits( widths.at( i ), QgsUnitTypes::RenderMillimeters );
114
115 if ( i == 0 )
116 minX = thisX;
117 if ( i == positions.size() - 1 )
118 maxX = thisX + thisWidth;
119
120 const QRectF segmentRectTop( thisX, barTopPosition, thisWidth, segmentHeight );
121 currentSymbol->renderPolygon( QPolygonF()
122 << segmentRectTop.topLeft()
123 << segmentRectTop.topRight()
124 << segmentRectTop.bottomRight()
125 << segmentRectTop.bottomLeft()
126 << segmentRectTop.topLeft(),
127 nullptr, nullptr, context );
128 painter->drawRect( segmentRectTop );
129
130 //draw bottom half
131 if ( useColor )
132 {
133 //secondary symbol
134 currentSymbol = fillSymbol2.get();
135 }
136 else //primary symbol
137 {
138 currentSymbol = fillSymbol1.get(); ;
139 }
140
141 const QRectF segmentRectBottom( thisX, barTopPosition + segmentHeight, thisWidth, segmentHeight );
142
143 currentSymbol->renderPolygon( QPolygonF()
144 << segmentRectBottom.topLeft()
145 << segmentRectBottom.topRight()
146 << segmentRectBottom.bottomRight()
147 << segmentRectBottom.bottomLeft()
148 << segmentRectBottom.topLeft(),
149 nullptr, nullptr, context );
150 useColor = !useColor;
151 }
152
153
154 // and then the lines
155 // note that we do this layer-by-layer, to avoid ugliness where the lines touch the outer rect
156 for ( int layer = 0; layer < lineSymbol->symbolLayerCount(); ++layer )
157 {
158 // vertical lines
159 for ( int i = 1; i < positions.size(); ++i )
160 {
161 const double lineX = context.convertToPainterUnits( positions.at( i ), QgsUnitTypes::RenderMillimeters ) + xOffset;
162 lineSymbol->renderPolyline( QPolygonF()
163 << QPointF( lineX, barTopPosition )
164 << QPointF( lineX, barTopPosition + segmentHeight * 2 ),
165 nullptr, context, layer );
166 }
167
168 // middle horizontal line
169 lineSymbol->renderPolyline( QPolygonF()
170 << QPointF( minX, barTopPosition + segmentHeight )
171 << QPointF( maxX, barTopPosition + segmentHeight ),
172 nullptr, context, layer );
173
174
175 // outside line
176 lineSymbol->renderPolyline( QPolygonF()
177 << QPointF( minX, barTopPosition )
178 << QPointF( maxX, barTopPosition )
179 << QPointF( maxX, barTopPosition + segmentHeight * 2 )
180 << QPointF( minX, barTopPosition + segmentHeight * 2 )
181 << QPointF( minX, barTopPosition ),
182 nullptr, context, layer );
183 }
184
185 lineSymbol->stopRender( context );
186 fillSymbol1->stopRender( context );
187 fillSymbol2->stopRender( context );
188
189 painter->restore();
190
191 //draw labels using the default method
192 drawDefaultLabels( context, settings, scaleContext );
193}
Double box with alternating colors.
Flags flags() const override
Returns the scalebar rendering flags, which dictates the renderer's behavior.
QgsDoubleBoxScaleBarRenderer()=default
Constructor for QgsDoubleBoxScaleBarRenderer.
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.
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.
Definition: qgsfillsymbol.h:30
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.
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 convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale(), Qgis::RenderSubcomponentProperty property=Qgis::RenderSubcomponentProperty::Generic) const
Converts a size from the specified units to painter units (pixels).
@ 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() ...
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.
The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with Qgs...
QgsLineSymbol * lineSymbol() const
Returns the line symbol used to render the scalebar (only used for some scalebar types).
QgsTextFormat & textFormat()
Returns the text format used for drawing text in the scalebar.
double boxContentSpace() const
Returns the spacing (margin) between the scalebar box and content in millimeters.
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).
LabelVerticalPlacement labelVerticalPlacement() const
Returns the vertical placement of text labels.
@ LabelAboveSegment
Labels are drawn above the scalebar.
double labelBarSpace() const
Returns the spacing (in millimeters) between labels and the scalebar.
double height() const
Returns the scalebar height (in millimeters).
static QFontMetricsF fontMetrics(QgsRenderContext &context, const QgsTextFormat &format, double scaleFactor=1.0)
Returns the font metrics for the given text format, when rendered in the specified render context.
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:169
Contains parameters regarding scalebar calculations.