QGIS API Documentation 4.3.0-Master (45633be667c)
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 "qgsscalebarsettings.h"
23#include "qgssymbol.h"
24#include "qgstextrenderer.h"
25
26#include <QList>
27#include <QPainter>
28#include <QString>
29
30using namespace Qt::StringLiterals;
31
33{
34 return u"Double Box"_s;
35}
36
38{
39 return QObject::tr( "Double Box" );
40}
41
55
57{
58 return 2;
59}
60
65
66void QgsDoubleBoxScaleBarRenderer::draw( QgsRenderContext &context, const QgsScaleBarSettings &settings, const ScaleBarContext &scaleContext ) const
67{
68 if ( !context.painter() )
69 {
70 return;
71 }
72 QPainter *painter = context.painter();
73
74 const double barTopPosition = verticalOffset( context, settings );
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
124 ->renderPolygon( QPolygonF() << segmentRectTop.topLeft() << segmentRectTop.topRight() << segmentRectTop.bottomRight() << segmentRectTop.bottomLeft() << segmentRectTop.topLeft(), nullptr, nullptr, context );
125 painter->drawRect( segmentRectTop );
126
127 //draw bottom half
128 if ( useColor )
129 {
130 //secondary symbol
131 currentSymbol = fillSymbol2.get();
132 }
133 else //primary symbol
134 {
135 currentSymbol = fillSymbol1.get();
136 ;
137 }
138
139 const QRectF segmentRectBottom( thisX, barTopPosition + segmentHeight, thisWidth, segmentHeight );
140
141 currentSymbol
142 ->renderPolygon( QPolygonF() << segmentRectBottom.topLeft() << segmentRectBottom.topRight() << segmentRectBottom.bottomRight() << segmentRectBottom.bottomLeft() << segmentRectBottom.topLeft(), nullptr, nullptr, context );
143 useColor = !useColor;
144 }
145
146
147 // and then the lines
148 // note that we do this layer-by-layer, to avoid ugliness where the lines touch the outer rect
149 for ( int layer = 0; layer < lineSymbol->symbolLayerCount(); ++layer )
150 {
151 // vertical lines
152 for ( int i = 1; i < positions.size(); ++i )
153 {
154 const double lineX = context.convertToPainterUnits( positions.at( i ), Qgis::RenderUnit::Millimeters ) + xOffset;
155 lineSymbol->renderPolyline( QPolygonF() << QPointF( lineX, barTopPosition ) << QPointF( lineX, barTopPosition + segmentHeight * 2 ), nullptr, context, layer );
156 }
157
158 // middle horizontal line
159 lineSymbol->renderPolyline( QPolygonF() << QPointF( minX, barTopPosition + segmentHeight ) << QPointF( maxX, barTopPosition + segmentHeight ), nullptr, context, layer );
160
161
162 // outside line
163 lineSymbol->renderPolyline(
164 QPolygonF()
165 << QPointF( minX, barTopPosition )
166 << QPointF( maxX, barTopPosition )
167 << QPointF( maxX, barTopPosition + segmentHeight * 2 )
168 << QPointF( minX, barTopPosition + segmentHeight * 2 )
169 << QPointF( minX, barTopPosition ),
170 nullptr,
171 context,
172 layer
173 );
174 }
175
176 lineSymbol->stopRender( context );
177 fillSymbol1->stopRender( context );
178 fillSymbol2->stopRender( context );
179
180 painter->restore();
181
182 //draw labels using the default method
183 drawDefaultLabels( context, settings, scaleContext );
184}
185
187{
188 QgsSimpleFillSymbolLayer *fill = dynamic_cast< QgsSimpleFillSymbolLayer * >( settings.fillSymbol()->symbolLayers().at( 0 ) );
189
190 // restore the fill symbols by default
191 if ( fill && fill->brushStyle() == Qt::NoBrush )
192 {
193 auto fillSymbol = std::make_unique< QgsFillSymbol >();
194 auto fillSymbolLayer = std::make_unique< QgsSimpleFillSymbolLayer >();
195 fillSymbolLayer->setColor( QColor( 0, 0, 0 ) );
196 fillSymbolLayer->setBrushStyle( Qt::SolidPattern );
197 fillSymbolLayer->setStrokeStyle( Qt::SolidLine );
198 fillSymbol->changeSymbolLayer( 0, fillSymbolLayer.release() );
199 settings.setFillSymbol( fillSymbol.release() );
200
201 fillSymbol = std::make_unique< QgsFillSymbol >();
202 fillSymbolLayer = std::make_unique< QgsSimpleFillSymbolLayer >();
203 fillSymbolLayer->setColor( QColor( 255, 255, 255 ) );
204 fillSymbolLayer->setStrokeStyle( Qt::NoPen );
205 fillSymbol->changeSymbolLayer( 0, fillSymbolLayer.release() );
206 settings.setAlternateFillSymbol( fillSymbol.release() );
207 }
208
209 return true;
210}
@ Millimeters
Millimeters.
Definition qgis.h:5739
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).
Renders polygons using a single fill and stroke color.
Qt::BrushStyle brushStyle() const
Contains parameters regarding scalebar calculations.