QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
Go to the documentation of this file.
29 return QStringLiteral(
"Single Box" );
34 return QObject::tr(
"Single Box" );
67 QPainter *painter = context.
painter();
78 std::unique_ptr< QgsLineSymbol > lineSymbol( settings.
lineSymbol()->
clone() );
79 lineSymbol->startRender( context );
81 std::unique_ptr< QgsFillSymbol > fillSymbol1( settings.
fillSymbol()->
clone() );
82 fillSymbol1->startRender( context );
85 fillSymbol2->startRender( context );
87 painter->setPen( Qt::NoPen );
88 painter->setBrush( Qt::NoBrush );
93 const QList<double> positions =
segmentPositions( context, scaleContext, settings );
94 const QList<double> widths =
segmentWidths( scaleContext, settings );
100 for (
int i = 0; i < positions.size(); ++i )
104 currentSymbol = fillSymbol1.get();
108 currentSymbol = fillSymbol2.get();
116 if ( i == positions.size() - 1 )
117 maxX = thisX + thisWidth;
119 const QRectF segmentRect( thisX, barTopPosition, thisWidth, barHeight );
121 << segmentRect.topLeft()
122 << segmentRect.topRight()
123 << segmentRect.bottomRight()
124 << segmentRect.bottomLeft()
125 << segmentRect.topLeft(),
nullptr,
nullptr, context );
126 useColor = !useColor;
131 for (
int layer = 0; layer < lineSymbol->symbolLayerCount(); ++layer )
133 for (
int i = 1; i < positions.size(); ++i )
136 lineSymbol->renderPolyline( QPolygonF()
137 << QPointF( lineX, barTopPosition )
138 << QPointF( lineX, barTopPosition + barHeight ),
139 nullptr, context, layer );
143 lineSymbol->renderPolyline( QPolygonF()
144 << QPointF( minX, barTopPosition )
145 << QPointF( maxX, barTopPosition )
146 << QPointF( maxX, barTopPosition + barHeight )
147 << QPointF( minX, barTopPosition + barHeight )
148 << QPointF( minX, barTopPosition ),
149 nullptr, context, layer );
152 lineSymbol->stopRender( context );
153 fillSymbol1->stopRender( context );
154 fillSymbol2->stopRender( context );
double height() const
Returns the scalebar height (in millimeters).
QgsLineSymbol * lineSymbol() const
Returns the line symbol used to render the scalebar (only used for some scalebar types).
void setPainterFlagsUsingContext(QPainter *painter=nullptr) const
Sets relevant flags on a destination painter, using the flags and settings currently defined for the ...
Contains parameters regarding scalebar calculations.
@ FlagUsesUnitLabel
Renderer uses the QgsScaleBarSettings::unitLabel() setting.
QList< double > segmentWidths(const QgsScaleBarRenderer::ScaleBarContext &scaleContext, const QgsScaleBarSettings &settings) const
Returns a list of widths of each segment of the scalebar.
QgsLineSymbol * clone() const override
Returns a deep copy of this symbol.
@ FlagUsesFillSymbol
Renderer utilizes the scalebar fill symbol (see QgsScaleBarSettings::fillSymbol() )
@ FlagUsesAlternateFillSymbol
Renderer utilizes the alternate scalebar fill symbol (see QgsScaleBarSettings::alternateFillSymbol() ...
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.
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.
Contains information about the context of a rendering operation.
QgsFillSymbol * fillSymbol() const
Returns the primary fill symbol used to render the scalebar (only used for some scalebar types).
@ RenderMillimeters
Millimeters.
@ FlagUsesLabelHorizontalPlacement
Renderer uses the QgsScaleBarSettings::labelHorizontalPlacement() setting.
QgsSingleBoxScaleBarRenderer()=default
Constructor for QgsSingleBoxScaleBarRenderer.
Flags flags() const override
Returns the scalebar rendering flags, which dictates the renderer's behavior.
double labelBarSpace() const
Returns the spacing (in millimeters) between labels and the scalebar.
@ FlagUsesLabelVerticalPlacement
Renderer uses the QgsScaleBarSettings::labelVerticalPlacement() setting.
double boxContentSpace() const
Returns the spacing (margin) between the scalebar box and content in millimeters.
Scalebar style that draws a single box with alternating color for the segments.
LabelVerticalPlacement labelVerticalPlacement() const
Returns the vertical placement of text labels.
QgsTextFormat & textFormat()
Returns the text format used for drawing text in the scalebar.
@ FlagUsesLineSymbol
Renderer utilizes the scalebar line symbol (see QgsScaleBarSettings::lineSymbol() )
QString visibleName() const override
Returns the user friendly, translated name for the renderer.
The QgsScaleBarSettings class stores the appearance and layout settings for scalebar drawing with Qgs...
QgsSingleBoxScaleBarRenderer * clone() const override
Returns a clone of the renderer.
@ FlagRespectsMapUnitsPerScaleBarUnit
Renderer respects the QgsScaleBarSettings::mapUnitsPerScaleBarUnit() setting.
Q_DECL_DEPRECATED double firstLabelXOffset(const QgsScaleBarSettings &settings) const
Returns the x-offset (in millimeters) used for the first label in the scalebar.
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.
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).
QString id() const override
Returns the unique ID for this renderer.
int sortKey() const override
Returns a sorting key value, where renderers with a lower sort key will be shown earlier in lists.
@ LabelAboveSegment
Labels are drawn above the scalebar.
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...
@ FlagRespectsUnits
Renderer respects the QgsScaleBarSettings::units() setting.
QgsFillSymbol * clone() const override
Returns a deep copy of this symbol.
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
@ FlagUsesLabelBarSpace
Renderer uses the QgsScaleBarSettings::labelBarSpace() setting.
@ FlagUsesSegments
Renderer uses the scalebar segments.
QPainter * painter()
Returns the destination QPainter for the render operation.
QgsFillSymbol * alternateFillSymbol() const
Returns the secondary fill symbol used to render the scalebar (only used for some scalebar types).
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.