QGIS API Documentation 3.37.0-Master (684a802617f)
Loading...
Searching...
No Matches
qgslayoutitemshape.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutitemshape.cpp
3 -----------------------
4 begin : July 2017
5 copyright : (C) 2017 by Nyall Dawson
6 email : nyall dot dawson at gmail dot com
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
17#include "qgslayoutitemshape.h"
18#include "qgslayout.h"
19#include "qgslayoututils.h"
20#include "qgssymbollayerutils.h"
21#include "qgslayoutmodel.h"
23#include "qgsfillsymbol.h"
25
26#include <QPainter>
27
29 : QgsLayoutItem( layout )
30 , mCornerRadius( 0 )
31{
32 setBackgroundEnabled( false );
33 setFrameEnabled( false );
34 QVariantMap properties;
35 properties.insert( QStringLiteral( "color" ), QStringLiteral( "white" ) );
36 properties.insert( QStringLiteral( "style" ), QStringLiteral( "solid" ) );
37 properties.insert( QStringLiteral( "style_border" ), QStringLiteral( "solid" ) );
38 properties.insert( QStringLiteral( "color_border" ), QStringLiteral( "black" ) );
39 properties.insert( QStringLiteral( "width_border" ), QStringLiteral( "0.3" ) );
40 properties.insert( QStringLiteral( "joinstyle" ), QStringLiteral( "miter" ) );
41 mShapeStyleSymbol.reset( QgsFillSymbol::createSimple( properties ) );
42 refreshSymbol( false );
43
44 connect( this, &QgsLayoutItemShape::sizePositionChanged, this, [this]
45 {
46 updateBoundingRect();
47 update();
48 emit clipPathChanged();
49 } );
50}
51
53
58
63
65{
66 switch ( mShape )
67 {
68 case Ellipse:
69 return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemShapeEllipse.svg" ) );
70 case Rectangle:
71 return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemShapeRectangle.svg" ) );
72 case Triangle:
73 return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemShapeTriangle.svg" ) );
74 }
75
76 return QIcon();
77}
78
80{
81 if ( !id().isEmpty() )
82 {
83 return id();
84 }
85
86 switch ( mShape )
87 {
88 case Ellipse:
89 return tr( "<Ellipse>" );
90 case Rectangle:
91 return tr( "<Rectangle>" );
92 case Triangle:
93 return tr( "<Triangle>" );
94 }
95
96 return tr( "<Shape>" );
97}
98
105
107{
108 if ( type == mShape )
109 {
110 return;
111 }
112
113 mShape = type;
114
115 if ( mLayout && id().isEmpty() )
116 {
117 //notify the model that the display name has changed
118 mLayout->itemsModel()->updateItemDisplayName( this );
119 }
120
121 emit clipPathChanged();
122}
123
124void QgsLayoutItemShape::refreshSymbol( bool redraw )
125{
126 if ( auto *lLayout = layout() )
127 {
128 const QgsRenderContext rc = QgsLayoutUtils::createRenderContextForLayout( lLayout, nullptr, lLayout->renderContext().dpi() );
129 mMaxSymbolBleed = ( 25.4 / lLayout->renderContext().dpi() ) * QgsSymbolLayerUtils::estimateMaxSymbolBleed( mShapeStyleSymbol.get(), rc );
130 }
131
132 updateBoundingRect();
133
134 if ( redraw )
135 update();
136
137 emit frameChanged();
138}
139
140void QgsLayoutItemShape::updateBoundingRect()
141{
142 QRectF rectangle = rect();
143 rectangle.adjust( -mMaxSymbolBleed, -mMaxSymbolBleed, mMaxSymbolBleed, mMaxSymbolBleed );
144 if ( rectangle != mCurrentRectangle )
145 {
146 prepareGeometryChange();
147 mCurrentRectangle = rectangle;
148 }
149}
150
152{
153 if ( !symbol )
154 return;
155
156 mShapeStyleSymbol.reset( symbol->clone() );
157 refreshSymbol( true );
158}
159
161{
162 mCornerRadius = radius;
163 emit clipPathChanged();
164}
165
167{
168 QPolygonF shapePolygon = mapToScene( calculatePolygon( 1.0 ) );
169 // ensure polygon is closed
170 if ( shapePolygon.at( 0 ) != shapePolygon.constLast() )
171 shapePolygon << shapePolygon.at( 0 );
172 return QgsGeometry::fromQPolygonF( shapePolygon );
173}
174
176{
177 return mCurrentRectangle;
178}
179
181{
182 return mMaxSymbolBleed;
183}
184
186{
187 if ( mShapeStyleSymbol )
188 {
189 QgsStyleSymbolEntity entity( mShapeStyleSymbol.get() );
190 if ( !visitor->visit( QgsStyleEntityVisitorInterface::StyleLeaf( &entity, uuid(), displayName() ) ) )
191 return false;
192 }
193
194 return true;
195}
196
198{
199 QPainter *painter = context.renderContext().painter();
200 painter->setPen( Qt::NoPen );
201 painter->setBrush( Qt::NoBrush );
202
203 const double scale = context.renderContext().convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
204
205 const QVector<QPolygonF> rings; //empty list
206
207 symbol()->startRender( context.renderContext() );
208 symbol()->renderPolygon( calculatePolygon( scale ), &rings, nullptr, context.renderContext() );
209 symbol()->stopRender( context.renderContext() );
210}
211
212QPolygonF QgsLayoutItemShape::calculatePolygon( double scale ) const
213{
214 QPolygonF shapePolygon;
215
216 //shapes with curves must be enlarged before conversion to QPolygonF, or
217 //the curves are approximated too much and appear jaggy
218 const QTransform t = QTransform::fromScale( 100, 100 );
219 //inverse transform used to scale created polygons back to expected size
220 const QTransform ti = t.inverted();
221
222 switch ( mShape )
223 {
224 case Ellipse:
225 {
226 //create an ellipse
227 QPainterPath ellipsePath;
228 ellipsePath.addEllipse( QRectF( 0, 0, rect().width() * scale, rect().height() * scale ) );
229 const QPolygonF ellipsePoly = ellipsePath.toFillPolygon( t );
230 shapePolygon = ti.map( ellipsePoly );
231 break;
232 }
233 case Rectangle:
234 {
235 //if corner radius set, then draw a rounded rectangle
236 if ( mCornerRadius.length() > 0 )
237 {
238 QPainterPath roundedRectPath;
239 const double radius = mLayout->convertToLayoutUnits( mCornerRadius ) * scale;
240 roundedRectPath.addRoundedRect( QRectF( 0, 0, rect().width() * scale, rect().height() * scale ), radius, radius );
241 const QPolygonF roundedPoly = roundedRectPath.toFillPolygon( t );
242 shapePolygon = ti.map( roundedPoly );
243 }
244 else
245 {
246 shapePolygon = QPolygonF( QRectF( 0, 0, rect().width() * scale, rect().height() * scale ) );
247 }
248 break;
249 }
250 case Triangle:
251 {
252 shapePolygon << QPointF( 0, rect().height() * scale );
253 shapePolygon << QPointF( rect().width() * scale, rect().height() * scale );
254 shapePolygon << QPointF( rect().width() / 2.0 * scale, 0 );
255 shapePolygon << QPointF( 0, rect().height() * scale );
256 break;
257 }
258 }
259 return shapePolygon;
260}
261
262bool QgsLayoutItemShape::writePropertiesToElement( QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context ) const
263{
264 element.setAttribute( QStringLiteral( "shapeType" ), mShape );
265 element.setAttribute( QStringLiteral( "cornerRadiusMeasure" ), mCornerRadius.encodeMeasurement() );
266
267 const QDomElement shapeStyleElem = QgsSymbolLayerUtils::saveSymbol( QString(), mShapeStyleSymbol.get(), document, context );
268 element.appendChild( shapeStyleElem );
269
270 return true;
271}
272
273bool QgsLayoutItemShape::readPropertiesFromElement( const QDomElement &element, const QDomDocument &, const QgsReadWriteContext &context )
274{
275 mShape = static_cast< Shape >( element.attribute( QStringLiteral( "shapeType" ), QStringLiteral( "0" ) ).toInt() );
276 if ( element.hasAttribute( QStringLiteral( "cornerRadiusMeasure" ) ) )
277 mCornerRadius = QgsLayoutMeasurement::decodeMeasurement( element.attribute( QStringLiteral( "cornerRadiusMeasure" ), QStringLiteral( "0" ) ) );
278 else
279 mCornerRadius = QgsLayoutMeasurement( element.attribute( QStringLiteral( "cornerRadius" ), QStringLiteral( "0" ) ).toDouble() );
280
281 const QDomElement shapeStyleSymbolElem = element.firstChildElement( QStringLiteral( "symbol" ) );
282 if ( !shapeStyleSymbolElem.isNull() )
283 {
284 mShapeStyleSymbol.reset( QgsSymbolLayerUtils::loadSymbol<QgsFillSymbol>( shapeStyleSymbolElem, context ) );
285 refreshSymbol( false );
286 }
287
288 return true;
289}
@ Millimeters
Millimeters.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
A fill symbol type, for rendering Polygon and MultiPolygon geometries.
static QgsFillSymbol * createSimple(const QVariantMap &properties)
Create a fill symbol with one symbol layer: SimpleFill with specified properties.
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.
A geometry is the spatial representation of a feature.
static QgsGeometry fromQPolygonF(const QPolygonF &polygon)
Construct geometry from a QPolygonF.
Contains settings and helpers relating to a render of a QgsLayoutItem.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
Layout item for basic filled shapes (e.g.
QRectF boundingRect() const override
bool readPropertiesFromElement(const QDomElement &element, const QDomDocument &document, const QgsReadWriteContext &context) override
Sets item state from a DOM element.
static QgsLayoutItemShape * create(QgsLayout *layout)
Returns a new shape item for the specified layout.
double estimatedFrameBleed() const override
Returns the estimated amount the item's frame bleeds outside the item's actual rectangle.
QgsFillSymbol * symbol()
Returns the fill symbol used to draw the shape.
~QgsLayoutItemShape() override
void setShapeType(QgsLayoutItemShape::Shape type)
Sets the type of shape (e.g.
QString displayName() const override
Gets item display name.
QgsLayoutItemShape(QgsLayout *layout)
Constructor for QgsLayoutItemShape, with the specified parent layout.
QgsGeometry clipPath() const override
Returns the clipping path generated by this item, in layout coordinates.
bool writePropertiesToElement(QDomElement &element, QDomDocument &document, const QgsReadWriteContext &context) const override
Stores item state within an XML DOM element.
void setSymbol(QgsFillSymbol *symbol)
Sets the fill symbol used to draw the shape.
QIcon icon() const override
Returns the item's icon.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified style entity visitor, causing it to visit all style entities associated with th...
int type() const override
@ Ellipse
Ellipse shape.
@ Rectangle
Rectangle shape.
@ Triangle
Triangle shape.
QgsLayoutItem::Flags itemFlags() const override
Returns the item's flags, which indicate how the item behaves.
void draw(QgsLayoutItemRenderContext &context) override
Draws the item's contents using the specified item render context.
void setCornerRadius(QgsLayoutMeasurement radius)
Sets the corner radius for rounded rectangle corners.
Base class for graphical items within a QgsLayout.
virtual void redraw()
Triggers a redraw (update) of the item.
virtual void setFrameEnabled(bool drawFrame)
Sets whether this item has a frame drawn around it or not.
@ FlagProvidesClipPath
Item can act as a clipping path provider (see clipPath())
void sizePositionChanged()
Emitted when the item's size or position changes.
virtual QString uuid() const
Returns the item identification string.
QString id() const
Returns the item's ID name.
void frameChanged()
Emitted if the item's frame style changes.
virtual Flags itemFlags() const
Returns the item's flags, which indicate how the item behaves.
void clipPathChanged()
Emitted when the item's clipping path has changed.
QFlags< Flag > Flags
void setBackgroundEnabled(bool drawBackground)
Sets whether this item has a background drawn under it or not.
This class provides a method of storing measurements for use in QGIS layouts using a variety of diffe...
static QgsLayoutMeasurement decodeMeasurement(const QString &string)
Decodes a measurement from a string.
QString encodeMeasurement() const
Encodes the layout measurement to a string.
double length() const
Returns the length of the measurement.
const QgsLayout * layout() const
Returns the layout the object is attached to.
QPointer< QgsLayout > mLayout
static QgsRenderContext createRenderContextForLayout(QgsLayout *layout, QPainter *painter, double dpi=-1)
Creates a render context suitable for the specified layout and painter destination.
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
Definition qgslayout.h:49
The class is used as a container of context for various read/write operations on other objects.
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.
An interface for classes which can visit style entity (e.g.
virtual bool visit(const QgsStyleEntityVisitorInterface::StyleLeaf &entity)
Called when the visitor will visit a style entity.
A symbol entity for QgsStyle databases.
Definition qgsstyle.h:1372
static QDomElement saveSymbol(const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
static double estimateMaxSymbolBleed(QgsSymbol *symbol, const QgsRenderContext &context)
Returns the maximum estimated bleed for the symbol.
void stopRender(QgsRenderContext &context)
Ends the rendering process.
void startRender(QgsRenderContext &context, const QgsFields &fields=QgsFields())
Begins the rendering process for the symbol.
Contains information relating to the style entity currently being visited.