QGIS API Documentation 3.99.0-Master (26c88405ac0)
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
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 "qgsscalebarsettings.h"
23#include "qgssymbol.h"
24#include "qgstextrenderer.h"
25
26#include <QList>
27#include <QPainter>
28
30{
31 return QStringLiteral( "Double Box" );
32}
33
35{
36 return QObject::tr( "Double Box" );
37}
38
52
54{
55 return 2;
56}
57
62
63void QgsDoubleBoxScaleBarRenderer::draw( QgsRenderContext &context, const QgsScaleBarSettings &settings, const ScaleBarContext &scaleContext ) const
64{
65 if ( !context.painter() )
66 {
67 return;
68 }
69 QPainter *painter = context.painter();
70
71 const double scaledLabelBarSpace = context.convertToPainterUnits( settings.labelBarSpace(), Qgis::RenderUnit::Millimeters );
72 const double scaledBoxContentSpace = context.convertToPainterUnits( settings.boxContentSpace(), Qgis::RenderUnit::Millimeters );
73 const QFontMetricsF fontMetrics = QgsTextRenderer::fontMetrics( context, settings.textFormat() );
74 const double barTopPosition = scaledBoxContentSpace + ( settings.labelVerticalPlacement() == Qgis::ScaleBarDistanceLabelVerticalPlacement::AboveSegment ? fontMetrics.ascent() + scaledLabelBarSpace : 0 );
75 const double segmentHeight = context.convertToPainterUnits( settings.height() / 2, Qgis::RenderUnit::Millimeters );
76
77 painter->save();
78 context.setPainterFlagsUsingContext( painter );
79
80 std::unique_ptr< QgsLineSymbol > lineSymbol( settings.lineSymbol()->clone() );
81 lineSymbol->startRender( context );
82
83 std::unique_ptr< QgsFillSymbol > fillSymbol1( settings.fillSymbol()->clone() );
84 fillSymbol1->startRender( context );
85
86 std::unique_ptr< QgsFillSymbol > fillSymbol2( settings.alternateFillSymbol()->clone() );
87 fillSymbol2->startRender( context );
88
89 painter->setPen( Qt::NoPen );
90 painter->setBrush( Qt::NoBrush );
91
92 bool useColor = true; //alternate brush color/white
93
94 const double xOffset = firstLabelXOffset( settings, context, scaleContext );
95
96 const QList<double> positions = segmentPositions( context, scaleContext, settings );
97 const QList<double> widths = segmentWidths( scaleContext, settings );
98
99 double minX = 0;
100 double maxX = 0;
101 QgsFillSymbol *currentSymbol = nullptr;
102 for ( int i = 0; i < positions.size(); ++i )
103 {
104 //draw top half
105 if ( useColor )
106 {
107 currentSymbol = fillSymbol1.get();
108 }
109 else //secondary symbol
110 {
111 currentSymbol = fillSymbol2.get();
112 }
113
114 const double thisX = context.convertToPainterUnits( positions.at( i ), Qgis::RenderUnit::Millimeters ) + xOffset;
115 const double thisWidth = context.convertToPainterUnits( widths.at( i ), Qgis::RenderUnit::Millimeters );
116
117 if ( i == 0 )
118 minX = thisX;
119 if ( i == positions.size() - 1 )
120 maxX = thisX + thisWidth;
121
122 const QRectF segmentRectTop( thisX, barTopPosition, thisWidth, segmentHeight );
123 currentSymbol->renderPolygon( QPolygonF()
124 << segmentRectTop.topLeft()
125 << segmentRectTop.topRight()
126 << segmentRectTop.bottomRight()
127 << segmentRectTop.bottomLeft()
128 << segmentRectTop.topLeft(),
129 nullptr, nullptr, context );
130 painter->drawRect( segmentRectTop );
131
132 //draw bottom half
133 if ( useColor )
134 {
135 //secondary symbol
136 currentSymbol = fillSymbol2.get();
137 }
138 else //primary symbol
139 {
140 currentSymbol = fillSymbol1.get(); ;
141 }
142
143 const QRectF segmentRectBottom( thisX, barTopPosition + segmentHeight, thisWidth, segmentHeight );
144
145 currentSymbol->renderPolygon( QPolygonF()
146 << segmentRectBottom.topLeft()
147 << segmentRectBottom.topRight()
148 << segmentRectBottom.bottomRight()
149 << segmentRectBottom.bottomLeft()
150 << segmentRectBottom.topLeft(),
151 nullptr, nullptr, context );
152 useColor = !useColor;
153 }
154
155
156 // and then the lines
157 // note that we do this layer-by-layer, to avoid ugliness where the lines touch the outer rect
158 for ( int layer = 0; layer < lineSymbol->symbolLayerCount(); ++layer )
159 {
160 // vertical lines
161 for ( int i = 1; i < positions.size(); ++i )
162 {
163 const double lineX = context.convertToPainterUnits( positions.at( i ), Qgis::RenderUnit::Millimeters ) + xOffset;
164 lineSymbol->renderPolyline( QPolygonF()
165 << QPointF( lineX, barTopPosition )
166 << QPointF( lineX, barTopPosition + segmentHeight * 2 ),
167 nullptr, context, layer );
168 }
169
170 // middle horizontal line
171 lineSymbol->renderPolyline( QPolygonF()
172 << QPointF( minX, barTopPosition + segmentHeight )
173 << QPointF( maxX, barTopPosition + segmentHeight ),
174 nullptr, context, layer );
175
176
177 // outside line
178 lineSymbol->renderPolyline( QPolygonF()
179 << QPointF( minX, barTopPosition )
180 << QPointF( maxX, barTopPosition )
181 << QPointF( maxX, barTopPosition + segmentHeight * 2 )
182 << QPointF( minX, barTopPosition + segmentHeight * 2 )
183 << QPointF( minX, barTopPosition ),
184 nullptr, context, layer );
185 }
186
187 lineSymbol->stopRender( context );
188 fillSymbol1->stopRender( context );
189 fillSymbol2->stopRender( context );
190
191 painter->restore();
192
193 //draw labels using the default method
194 drawDefaultLabels( context, settings, scaleContext );
195}
196
198{
199 QgsSimpleFillSymbolLayer *fill = dynamic_cast< QgsSimpleFillSymbolLayer * >( settings.fillSymbol()->symbolLayers().at( 0 ) );
200
201 // restore the fill symbols by default
202 if ( fill && fill->brushStyle() == Qt::NoBrush )
203 {
204 auto fillSymbol = std::make_unique< QgsFillSymbol >();
205 auto fillSymbolLayer = std::make_unique< QgsSimpleFillSymbolLayer >();
206 fillSymbolLayer->setColor( QColor( 0, 0, 0 ) );
207 fillSymbolLayer->setBrushStyle( Qt::SolidPattern );
208 fillSymbolLayer->setStrokeStyle( Qt::SolidLine );
209 fillSymbol->changeSymbolLayer( 0, fillSymbolLayer.release() );
210 settings.setFillSymbol( fillSymbol.release() );
211
212 fillSymbol = std::make_unique< QgsFillSymbol >();
213 fillSymbolLayer = std::make_unique< QgsSimpleFillSymbolLayer >();
214 fillSymbolLayer->setColor( QColor( 255, 255, 255 ) );
215 fillSymbolLayer->setStrokeStyle( Qt::NoPen );
216 fillSymbol->changeSymbolLayer( 0, fillSymbolLayer.release() );
217 settings.setAlternateFillSymbol( fillSymbol.release() );
218 }
219
220 return true;
221}
@ AboveSegment
Labels are drawn above the scalebar.
Definition qgis.h:5332
@ Millimeters
Millimeters.
Definition qgis.h:5184
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 ...
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).
Qgis::ScaleBarDistanceLabelVerticalPlacement labelVerticalPlacement() const
Returns the vertical placement of text labels.
void setFillSymbol(QgsFillSymbol *symbol)
Sets the primary fill 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).
double labelBarSpace() const
Returns the spacing (in millimeters) between labels and the scalebar.
double height() const
Returns the scalebar height (in millimeters).
Renders polygons using a single fill and stroke color.
Qt::BrushStyle brushStyle() const
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.