QGIS API Documentation  3.14.0-Pi (9f7028fd23)
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 : [email protected]
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 <QList>
23 #include <QPainter>
24 
26 {
27  return QStringLiteral( "Double Box" );
28 }
29 
31 {
32  return QObject::tr( "Double Box" );
33 }
34 
35 QgsScaleBarRenderer::Flags QgsDoubleBoxScaleBarRenderer::flags() const
36 {
47 }
48 
50 {
51  return 2;
52 }
53 
55 {
56  return new QgsDoubleBoxScaleBarRenderer( *this );
57 }
58 
59 void QgsDoubleBoxScaleBarRenderer::draw( QgsRenderContext &context, const QgsScaleBarSettings &settings, const ScaleBarContext &scaleContext ) const
60 {
61  if ( !context.painter() )
62  {
63  return;
64  }
65  QPainter *painter = context.painter();
66 
67  const double scaledLabelBarSpace = context.convertToPainterUnits( settings.labelBarSpace(), QgsUnitTypes::RenderMillimeters );
68  const double scaledBoxContentSpace = context.convertToPainterUnits( settings.boxContentSpace(), QgsUnitTypes::RenderMillimeters );
69  const QFontMetricsF fontMetrics = QgsTextRenderer::fontMetrics( context, settings.textFormat() );
70  const double barTopPosition = scaledBoxContentSpace + ( settings.labelVerticalPlacement() == QgsScaleBarSettings::LabelAboveSegment ? fontMetrics.ascent() + scaledLabelBarSpace : 0 );
71  const double segmentHeight = context.convertToPainterUnits( settings.height() / 2, QgsUnitTypes::RenderMillimeters );
72 
73  painter->save();
74  if ( context.flags() & QgsRenderContext::Antialiasing )
75  painter->setRenderHint( QPainter::Antialiasing, true );
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 
91  const double xOffset = firstLabelXOffset( settings, context, scaleContext );
92 
93  const QList<double> positions = segmentPositions( context, scaleContext, settings );
94  const QList<double> widths = segmentWidths( scaleContext, settings );
95 
96  double minX = 0;
97  double maxX = 0;
98  QgsFillSymbol *currentSymbol = nullptr;
99  for ( int i = 0; i < positions.size(); ++i )
100  {
101  //draw top half
102  if ( useColor )
103  {
104  currentSymbol = fillSymbol1.get();
105  }
106  else //secondary symbol
107  {
108  currentSymbol = fillSymbol2.get();
109  }
110 
111  const double thisX = context.convertToPainterUnits( positions.at( i ), QgsUnitTypes::RenderMillimeters ) + xOffset;
112  const double thisWidth = context.convertToPainterUnits( widths.at( i ), QgsUnitTypes::RenderMillimeters );
113 
114  if ( i == 0 )
115  minX = thisX;
116  if ( i == positions.size() - 1 )
117  maxX = thisX + thisWidth;
118 
119  const QRectF segmentRectTop( thisX, barTopPosition, thisWidth, segmentHeight );
120  currentSymbol->renderPolygon( QPolygonF()
121  << segmentRectTop.topLeft()
122  << segmentRectTop.topRight()
123  << segmentRectTop.bottomRight()
124  << segmentRectTop.bottomLeft()
125  << segmentRectTop.topLeft(),
126  nullptr, nullptr, context );
127  painter->drawRect( segmentRectTop );
128 
129  //draw bottom half
130  if ( useColor )
131  {
132  //secondary symbol
133  currentSymbol = fillSymbol2.get();
134  }
135  else //primary symbol
136  {
137  currentSymbol = fillSymbol1.get(); ;
138  }
139 
140  const QRectF segmentRectBottom( thisX, barTopPosition + segmentHeight, thisWidth, segmentHeight );
141 
142  currentSymbol->renderPolygon( QPolygonF()
143  << segmentRectBottom.topLeft()
144  << segmentRectBottom.topRight()
145  << segmentRectBottom.bottomRight()
146  << segmentRectBottom.bottomLeft()
147  << segmentRectBottom.topLeft(),
148  nullptr, nullptr, context );
149  useColor = !useColor;
150  }
151 
152 
153  // and then the lines
154  // note that we do this layer-by-layer, to avoid ugliness where the lines touch the outer rect
155  for ( int layer = 0; layer < lineSymbol->symbolLayerCount(); ++layer )
156  {
157  // vertical lines
158  for ( int i = 1; i < positions.size(); ++i )
159  {
160  const double lineX = context.convertToPainterUnits( positions.at( i ), QgsUnitTypes::RenderMillimeters ) + xOffset;
161  lineSymbol->renderPolyline( QPolygonF()
162  << QPointF( lineX, barTopPosition )
163  << QPointF( lineX, barTopPosition + segmentHeight * 2 ),
164  nullptr, context, layer );
165  }
166 
167  // middle horizontal line
168  lineSymbol->renderPolyline( QPolygonF()
169  << QPointF( minX, barTopPosition + segmentHeight )
170  << QPointF( maxX, barTopPosition + segmentHeight ),
171  nullptr, context, layer );
172 
173 
174  // outside line
175  lineSymbol->renderPolyline( QPolygonF()
176  << QPointF( minX, barTopPosition )
177  << QPointF( maxX, barTopPosition )
178  << QPointF( maxX, barTopPosition + segmentHeight * 2 )
179  << QPointF( minX, barTopPosition + segmentHeight * 2 )
180  << QPointF( minX, barTopPosition ),
181  nullptr, context, layer );
182  }
183 
184  lineSymbol->stopRender( context );
185  fillSymbol1->stopRender( context );
186  fillSymbol2->stopRender( context );
187 
188  painter->restore();
189 
190  //draw labels using the default method
191  drawDefaultLabels( context, settings, scaleContext );
192 }
QgsScaleBarSettings::height
double height() const
Returns the scalebar height (in millimeters).
Definition: qgsscalebarsettings.h:550
QgsScaleBarSettings::lineSymbol
QgsLineSymbol * lineSymbol() const
Returns the line symbol used to render the scalebar (only used for some scalebar types).
Definition: qgsscalebarsettings.cpp:191
QgsDoubleBoxScaleBarRenderer::clone
QgsDoubleBoxScaleBarRenderer * clone() const override
Returns a clone of the renderer.
Definition: qgsdoubleboxscalebarrenderer.cpp:54
QgsRenderContext::convertToPainterUnits
double convertToPainterUnits(double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale &scale=QgsMapUnitScale()) const
Converts a size from the specified units to painter units (pixels).
Definition: qgsrendercontext.cpp:287
QgsScaleBarRenderer::ScaleBarContext
Contains parameters regarding scalebar calculations.
Definition: qgsscalebarrenderer.h:70
QgsScaleBarRenderer::Flag::FlagUsesUnitLabel
@ FlagUsesUnitLabel
Renderer uses the QgsScaleBarSettings::unitLabel() setting.
qgstextrenderer.h
QgsDoubleBoxScaleBarRenderer::id
QString id() const override
Returns the unique ID for this renderer.
Definition: qgsdoubleboxscalebarrenderer.cpp:25
QgsScaleBarRenderer::segmentWidths
QList< double > segmentWidths(const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
Returns a list of widths of each segment of the scalebar.
Definition: qgsscalebarrenderer.cpp:394
QgsLineSymbol::clone
QgsLineSymbol * clone() const override
Returns a deep copy of this symbol.
Definition: qgssymbol.cpp:2139
QgsScaleBarRenderer::Flag::FlagUsesFillSymbol
@ FlagUsesFillSymbol
Renderer utilizes the scalebar fill symbol (see QgsScaleBarSettings::fillSymbol() )
QgsScaleBarRenderer::Flag::FlagUsesAlternateFillSymbol
@ FlagUsesAlternateFillSymbol
Renderer utilizes the alternate scalebar fill symbol (see QgsScaleBarSettings::alternateFillSymbol() ...
QgsRenderContext
Definition: qgsrendercontext.h:57
QgsScaleBarSettings::fillSymbol
QgsFillSymbol * fillSymbol() const
Returns the primary fill symbol used to render the scalebar (only used for some scalebar types).
Definition: qgsscalebarsettings.cpp:221
QgsUnitTypes::RenderMillimeters
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:168
QgsDoubleBoxScaleBarRenderer::flags
Flags flags() const override
Returns the scalebar rendering flags, which dictates the renderer's behavior.
Definition: qgsdoubleboxscalebarrenderer.cpp:35
QgsScaleBarRenderer::Flag::FlagUsesLabelHorizontalPlacement
@ FlagUsesLabelHorizontalPlacement
Renderer uses the QgsScaleBarSettings::labelHorizontalPlacement() setting.
QgsDoubleBoxScaleBarRenderer::sortKey
int sortKey() const override
Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists.
Definition: qgsdoubleboxscalebarrenderer.cpp:49
QgsTextRenderer::fontMetrics
static QFontMetricsF fontMetrics(QgsRenderContext &context, const QgsTextFormat &format)
Returns the font metrics for the given text format, when rendered in the specified render context.
Definition: qgstextrenderer.cpp:231
qgsscalebarsettings.h
qgslayoututils.h
QgsScaleBarSettings::labelBarSpace
double labelBarSpace() const
Returns the spacing (in millimeters) between labels and the scalebar.
Definition: qgsscalebarsettings.h:562
QgsScaleBarRenderer::Flag::FlagUsesLabelVerticalPlacement
@ FlagUsesLabelVerticalPlacement
Renderer uses the QgsScaleBarSettings::labelVerticalPlacement() setting.
QgsScaleBarSettings::boxContentSpace
double boxContentSpace() const
Returns the spacing (margin) between the scalebar box and content in millimeters.
Definition: qgsscalebarsettings.h:602
QgsScaleBarSettings::labelVerticalPlacement
LabelVerticalPlacement labelVerticalPlacement() const
Returns the vertical placement of text labels.
Definition: qgsscalebarsettings.h:575
QgsScaleBarSettings::textFormat
QgsTextFormat & textFormat()
Returns the text format used for drawing text in the scalebar.
Definition: qgsscalebarsettings.h:268
QgsScaleBarRenderer::Flag::FlagUsesLineSymbol
@ FlagUsesLineSymbol
Renderer utilizes the scalebar line symbol (see QgsScaleBarSettings::lineSymbol() )
QgsDoubleBoxScaleBarRenderer
Definition: qgsdoubleboxscalebarrenderer.h:30
QgsScaleBarSettings
Definition: qgsscalebarsettings.h:40
QgsScaleBarRenderer::Flag::FlagRespectsMapUnitsPerScaleBarUnit
@ FlagRespectsMapUnitsPerScaleBarUnit
Renderer respects the QgsScaleBarSettings::mapUnitsPerScaleBarUnit() setting.
qgsdoubleboxscalebarrenderer.h
QgsScaleBarRenderer::firstLabelXOffset
Q_DECL_DEPRECATED double firstLabelXOffset(const QgsScaleBarSettings &settings) const
Returns the x-offset (in millimeters) used for the first label in the scalebar.
Definition: qgsscalebarrenderer.cpp:309
QgsFillSymbol::renderPolygon
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.
Definition: qgssymbol.cpp:2161
QgsScaleBarSettings::LabelAboveSegment
@ LabelAboveSegment
Labels are drawn above the scalebar.
Definition: qgsscalebarsettings.h:68
QgsDoubleBoxScaleBarRenderer::QgsDoubleBoxScaleBarRenderer
QgsDoubleBoxScaleBarRenderer()=default
Constructor for QgsDoubleBoxScaleBarRenderer.
QgsScaleBarRenderer::drawDefaultLabels
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...
Definition: qgsscalebarrenderer.cpp:28
QgsScaleBarRenderer::Flag::FlagRespectsUnits
@ FlagRespectsUnits
Renderer respects the QgsScaleBarSettings::units() setting.
QgsFillSymbol::clone
QgsFillSymbol * clone() const override
Returns a deep copy of this symbol.
Definition: qgssymbol.cpp:2263
QgsFillSymbol
Definition: qgssymbol.h:1212
QgsRenderContext::Antialiasing
@ Antialiasing
Use antialiasing while drawing.
Definition: qgsrendercontext.h:78
QgsScaleBarRenderer::Flag::FlagUsesLabelBarSpace
@ FlagUsesLabelBarSpace
Renderer uses the QgsScaleBarSettings::labelBarSpace() setting.
QgsScaleBarRenderer::Flag::FlagUsesSegments
@ FlagUsesSegments
Renderer uses the scalebar segments.
QgsRenderContext::painter
QPainter * painter()
Returns the destination QPainter for the render operation.
Definition: qgsrendercontext.h:174
QgsScaleBarSettings::alternateFillSymbol
QgsFillSymbol * alternateFillSymbol() const
Returns the secondary fill symbol used to render the scalebar (only used for some scalebar types).
Definition: qgsscalebarsettings.cpp:231
qgssymbol.h
QgsDoubleBoxScaleBarRenderer::draw
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.
Definition: qgsdoubleboxscalebarrenderer.cpp:59
QgsDoubleBoxScaleBarRenderer::visibleName
QString visibleName() const override
Returns the user friendly, translated name for the renderer.
Definition: qgsdoubleboxscalebarrenderer.cpp:30
QgsRenderContext::flags
Flags flags() const
Returns combination of flags used for rendering.
Definition: qgsrendercontext.cpp:160
QgsScaleBarRenderer::segmentPositions
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.
Definition: qgsscalebarrenderer.cpp:339