QGIS API Documentation 3.29.0-Master (8c80f25a4f)
qgslayoutitempolygon.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgslayoutitempolygon.cpp
3 begin : March 2016
4 copyright : (C) 2016 Paul Blottiere, Oslandia
5 email : paul dot blottiere at oslandia dot com
6 ***************************************************************************/
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
19#include "qgslayoututils.h"
20#include "qgslayout.h"
21#include "qgspathresolver.h"
22#include "qgsreadwritecontext.h"
23#include "qgssymbollayerutils.h"
24#include "qgssymbol.h"
25#include "qgsmapsettings.h"
27#include "qgsfillsymbol.h"
28
29#include <limits>
30
32 : QgsLayoutNodesItem( layout )
33{
34 createDefaultPolygonStyleSymbol();
35}
36
37QgsLayoutItemPolygon::QgsLayoutItemPolygon( const QPolygonF &polygon, QgsLayout *layout )
38 : QgsLayoutNodesItem( polygon, layout )
39{
40 createDefaultPolygonStyleSymbol();
41}
42
44
46{
47 return new QgsLayoutItemPolygon( layout );
48}
49
51{
53}
54
56{
57 return QgsApplication::getThemeIcon( QStringLiteral( "/mLayoutItemPolygon.svg" ) );
58}
59
60bool QgsLayoutItemPolygon::_addNode( const int indexPoint,
61 QPointF newPoint,
62 const double radius )
63{
64 Q_UNUSED( radius )
65 mPolygon.insert( indexPoint + 1, newPoint );
66 return true;
67}
68
69void QgsLayoutItemPolygon::createDefaultPolygonStyleSymbol()
70{
71 QVariantMap properties;
72 properties.insert( QStringLiteral( "color" ), QStringLiteral( "white" ) );
73 properties.insert( QStringLiteral( "style" ), QStringLiteral( "solid" ) );
74 properties.insert( QStringLiteral( "style_border" ), QStringLiteral( "solid" ) );
75 properties.insert( QStringLiteral( "color_border" ), QStringLiteral( "black" ) );
76 properties.insert( QStringLiteral( "width_border" ), QStringLiteral( "0.3" ) );
77 properties.insert( QStringLiteral( "joinstyle" ), QStringLiteral( "miter" ) );
78
79 mPolygonStyleSymbol.reset( QgsFillSymbol::createSimple( properties ) );
80
81 refreshSymbol();
82}
83
84void QgsLayoutItemPolygon::refreshSymbol()
85{
86 if ( auto *lLayout = layout() )
87 {
88 const QgsRenderContext rc = QgsLayoutUtils::createRenderContextForLayout( lLayout, nullptr, lLayout->renderContext().dpi() );
89 mMaxSymbolBleed = ( 25.4 / lLayout->renderContext().dpi() ) * QgsSymbolLayerUtils::estimateMaxSymbolBleed( mPolygonStyleSymbol.get(), rc );
90 }
91
93
94 emit frameChanged();
95}
96
98{
99 if ( !id().isEmpty() )
100 return id();
101
102 return tr( "<Polygon>" );
103}
104
106{
107 if ( mPolygonStyleSymbol )
108 {
109 QgsStyleSymbolEntity entity( mPolygonStyleSymbol.get() );
110 if ( !visitor->visit( QgsStyleEntityVisitorInterface::StyleLeaf( &entity, uuid(), displayName() ) ) )
111 return false;
112 }
113
114 return true;
115}
116
117QgsLayoutItem::Flags QgsLayoutItemPolygon::itemFlags() const
118{
119 QgsLayoutItem::Flags flags = QgsLayoutNodesItem::itemFlags();
121 return flags;
122}
123
125{
126 QPolygonF path = mapToScene( mPolygon );
127 // ensure polygon is closed
128 if ( path.at( 0 ) != path.constLast() )
129 path << path.at( 0 );
130 return QgsGeometry::fromQPolygonF( path );
131}
132
134{
135 return mPolygonStyleSymbol.get();
136}
137
138void QgsLayoutItemPolygon::_draw( QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem * )
139{
140 //setup painter scaling to dots so that raster symbology is drawn to scale
141 const double scale = context.renderContext().convertToPainterUnits( 1, QgsUnitTypes::RenderMillimeters );
142 const QTransform t = QTransform::fromScale( scale, scale );
143
144 const QVector<QPolygonF> rings; //empty
145 QPainterPath polygonPath;
146 polygonPath.addPolygon( mPolygon );
147
148 mPolygonStyleSymbol->startRender( context.renderContext() );
149 mPolygonStyleSymbol->renderPolygon( polygonPath.toFillPolygon( t ), &rings,
150 nullptr, context.renderContext() );
151 mPolygonStyleSymbol->stopRender( context.renderContext() );
152}
153
154void QgsLayoutItemPolygon::_readXmlStyle( const QDomElement &elmt, const QgsReadWriteContext &context )
155{
156 mPolygonStyleSymbol.reset( QgsSymbolLayerUtils::loadSymbol<QgsFillSymbol>( elmt, context ) );
157}
158
160{
161 mPolygonStyleSymbol.reset( static_cast<QgsFillSymbol *>( symbol->clone() ) );
162 refreshSymbol();
163}
164
165void QgsLayoutItemPolygon::_writeXmlStyle( QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context ) const
166{
167 const QDomElement pe = QgsSymbolLayerUtils::saveSymbol( QString(),
168 mPolygonStyleSymbol.get(),
169 doc,
170 context );
171 elmt.appendChild( pe );
172}
173
175{
176 if ( index < 0 || index >= mPolygon.size() )
177 return false;
178
179 mPolygon.remove( index );
180
181 if ( mPolygon.size() < 3 )
182 mPolygon.clear();
183 else
184 {
185 int newSelectNode = index;
186 if ( index == mPolygon.size() )
187 newSelectNode = 0;
188 setSelectedNode( newSelectNode );
189 }
190
191 return true;
192}
193
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.
Definition: qgsfillsymbol.h:30
static QgsFillSymbol * createSimple(const QVariantMap &properties)
Create a fill symbol with one symbol layer: SimpleFill with specified properties.
QgsFillSymbol * clone() const override
Returns a deep copy of this symbol.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:164
static QgsGeometry fromQPolygonF(const QPolygonF &polygon)
Construct geometry from a QPolygonF.
Layout item for node based polygon shapes.
QIcon icon() const override
Returns the item's icon.
int type() const override
static QgsLayoutItemPolygon * create(QgsLayout *layout)
Returns a new polygon item for the specified layout.
QgsLayoutItemPolygon(QgsLayout *layout)
Constructor for QgsLayoutItemPolygon for the specified layout.
bool accept(QgsStyleEntityVisitorInterface *visitor) const override
Accepts the specified style entity visitor, causing it to visit all style entities associated with th...
QgsGeometry clipPath() const override
Returns the clipping path generated by this item, in layout coordinates.
void setSymbol(QgsFillSymbol *symbol)
Sets the symbol used to draw the shape.
QgsFillSymbol * symbol()
Returns the fill symbol used to draw the shape.
bool _removeNode(int nodeIndex) override
Method called in removeNode.
void _draw(QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem *itemStyle=nullptr) override
Method called in paint.
~QgsLayoutItemPolygon() override
bool _addNode(int indexPoint, QPointF newPoint, double radius) override
Method called in addNode.
void _writeXmlStyle(QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context) const override
Method called in writeXml.
void _readXmlStyle(const QDomElement &elmt, const QgsReadWriteContext &context) override
Method called in readXml.
QgsLayoutItem::Flags itemFlags() const override
Returns the item's flags, which indicate how the item behaves.
QString displayName() const override
Gets item display name.
@ LayoutPolygon
Polygon shape item.
Contains settings and helpers relating to a render of a QgsLayoutItem.
Definition: qgslayoutitem.h:45
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
Definition: qgslayoutitem.h:72
@ FlagProvidesClipPath
Item can act as a clipping path provider (see clipPath())
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.
An abstract layout item that provides generic methods for node based shapes such as polygon or polyli...
double mMaxSymbolBleed
Max symbol bleed.
bool setSelectedNode(int index)
Selects a node by index.
void updateSceneRect()
Update the current scene rectangle for this item.
QPolygonF mPolygon
Shape's nodes.
const QgsLayout * layout() const
Returns the layout the object is attached to.
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:51
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, 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).
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:1342
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.
@ RenderMillimeters
Millimeters.
Definition: qgsunittypes.h:169
Contains information relating to the style entity currently being visited.