QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
qgssingleboxscalebarrenderer.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgssingleboxscalebarrenderer.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 "qgssymbol.h"
20#include "qgstextrenderer.h"
21#include "qgslinesymbol.h"
22#include "qgsfillsymbol.h"
23#include <QList>
24#include <QPainter>
25
27{
28 return QStringLiteral( "Single Box" );
29}
30
32{
33 return QObject::tr( "Single Box" );
34}
35
37{
38 return 1;
39}
40
54
59
60void QgsSingleBoxScaleBarRenderer::draw( QgsRenderContext &context, const QgsScaleBarSettings &settings, const ScaleBarContext &scaleContext ) const
61{
62 if ( !context.painter() )
63 {
64 return;
65 }
66 QPainter *painter = context.painter();
67
68 const double scaledLabelBarSpace = context.convertToPainterUnits( settings.labelBarSpace(), Qgis::RenderUnit::Millimeters );
69 const double scaledBoxContentSpace = context.convertToPainterUnits( settings.boxContentSpace(), Qgis::RenderUnit::Millimeters );
70 const QFontMetricsF fontMetrics = QgsTextRenderer::fontMetrics( context, settings.textFormat() );
71 const double barTopPosition = scaledBoxContentSpace + ( settings.labelVerticalPlacement() == Qgis::ScaleBarDistanceLabelVerticalPlacement::AboveSegment ? fontMetrics.ascent() + scaledLabelBarSpace : 0 );
72 const double barHeight = context.convertToPainterUnits( settings.height(), Qgis::RenderUnit::Millimeters );
73
74 painter->save();
75 context.setPainterFlagsUsingContext( painter );
76
77 std::unique_ptr< QgsLineSymbol > lineSymbol( settings.lineSymbol()->clone() );
78 lineSymbol->startRender( context );
79
80 std::unique_ptr< QgsFillSymbol > fillSymbol1( settings.fillSymbol()->clone() );
81 fillSymbol1->startRender( context );
82
83 std::unique_ptr< QgsFillSymbol > fillSymbol2( settings.alternateFillSymbol()->clone() );
84 fillSymbol2->startRender( context );
85
86 painter->setPen( Qt::NoPen );
87 painter->setBrush( Qt::NoBrush );
88
89 bool useColor = true; //alternate brush color/white
90 const double xOffset = firstLabelXOffset( settings, context, scaleContext );
91
92 const QList<double> positions = segmentPositions( context, scaleContext, settings );
93 const QList<double> widths = segmentWidths( scaleContext, settings );
94
95 // draw the fill
96 double minX = 0;
97 double maxX = 0;
98 QgsFillSymbol *currentSymbol = nullptr;
99 for ( int i = 0; i < positions.size(); ++i )
100 {
101 if ( useColor ) //alternating colors
102 {
103 currentSymbol = fillSymbol1.get();
104 }
105 else //secondary fill
106 {
107 currentSymbol = fillSymbol2.get();
108 }
109
110 const double thisX = context.convertToPainterUnits( positions.at( i ), Qgis::RenderUnit::Millimeters ) + xOffset;
111 const double thisWidth = context.convertToPainterUnits( widths.at( i ), Qgis::RenderUnit::Millimeters );
112
113 if ( i == 0 )
114 minX = thisX;
115 if ( i == positions.size() - 1 )
116 maxX = thisX + thisWidth;
117
118 const QRectF segmentRect( thisX, barTopPosition, thisWidth, barHeight );
119 currentSymbol->renderPolygon( QPolygonF()
120 << segmentRect.topLeft()
121 << segmentRect.topRight()
122 << segmentRect.bottomRight()
123 << segmentRect.bottomLeft()
124 << segmentRect.topLeft(), nullptr, nullptr, context );
125 useColor = !useColor;
126 }
127
128 // and then the lines
129 // note that we do this layer-by-layer, to avoid ugliness where the lines touch the outer rect
130 for ( int layer = 0; layer < lineSymbol->symbolLayerCount(); ++layer )
131 {
132 for ( int i = 1; i < positions.size(); ++i )
133 {
134 const double lineX = context.convertToPainterUnits( positions.at( i ), Qgis::RenderUnit::Millimeters ) + xOffset;
135 lineSymbol->renderPolyline( QPolygonF()
136 << QPointF( lineX, barTopPosition )
137 << QPointF( lineX, barTopPosition + barHeight ),
138 nullptr, context, layer );
139 }
140
141 // outside line
142 lineSymbol->renderPolyline( QPolygonF()
143 << QPointF( minX, barTopPosition )
144 << QPointF( maxX, barTopPosition )
145 << QPointF( maxX, barTopPosition + barHeight )
146 << QPointF( minX, barTopPosition + barHeight )
147 << QPointF( minX, barTopPosition ),
148 nullptr, context, layer );
149 }
150
151 lineSymbol->stopRender( context );
152 fillSymbol1->stopRender( context );
153 fillSymbol2->stopRender( context );
154 painter->restore();
155
156 //draw labels using the default method
157 drawDefaultLabels( context, settings, scaleContext );
158}
159
160
161
@ AboveSegment
Labels are drawn above the scalebar.
@ Millimeters
Millimeters.
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 ...
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() ...
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).
Qgis::ScaleBarDistanceLabelVerticalPlacement labelVerticalPlacement() const
Returns the vertical placement of text labels.
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).
double labelBarSpace() const
Returns the spacing (in millimeters) between labels and the scalebar.
double height() const
Returns the scalebar height (in millimeters).
Scalebar style that draws a single box with alternating color for the segments.
QString id() const override
Returns the unique ID for this renderer.
QString visibleName() const override
Returns the user friendly, translated name for the renderer.
int sortKey() const override
Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists.
Flags flags() const override
Returns the scalebar rendering flags, which dictates the renderer's behavior.
QgsSingleBoxScaleBarRenderer * clone() const override
Returns a clone of the renderer.
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.
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.
Contains parameters regarding scalebar calculations.