QGIS API Documentation 3.41.0-Master (3440c17df1d)
Loading...
Searching...
No Matches
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
18#include "moc_qgslayoutitempolygon.cpp"
20#include "qgslayoututils.h"
21#include "qgslayout.h"
23#include "qgsreadwritecontext.h"
24#include "qgssymbollayerutils.h"
25#include "qgssymbol.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
49
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
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
133
135{
136 // A Polygon is valid if it has at least 3 unique points
137 QList<QPointF> uniquePoints;
138 int seen = 0;
139 for ( QPointF point : mPolygon )
140 {
141 if ( !uniquePoints.contains( point ) )
142 {
143 uniquePoints.append( point );
144 if ( ++seen > 2 )
145 return true;
146 }
147 }
148 return false;
149}
150
152{
153 return mPolygonStyleSymbol.get();
154}
155
156void QgsLayoutItemPolygon::_draw( QgsLayoutItemRenderContext &context, const QStyleOptionGraphicsItem * )
157{
158 QgsRenderContext renderContext = context.renderContext();
159 // symbol clipping messes with geometry generators used in the symbol for this item, and has no
160 // valid use here. See https://github.com/qgis/QGIS/issues/58909
162
163 //setup painter scaling to dots so that raster symbology is drawn to scale
164 const double scale = renderContext.convertToPainterUnits( 1, Qgis::RenderUnit::Millimeters );
165 const QTransform t = QTransform::fromScale( scale, scale );
166
167 const QVector<QPolygonF> rings; //empty
168 QPainterPath polygonPath;
169 polygonPath.addPolygon( mPolygon );
170
171 mPolygonStyleSymbol->startRender( renderContext );
172 mPolygonStyleSymbol->renderPolygon( polygonPath.toFillPolygon( t ), &rings,
173 nullptr, renderContext );
174 mPolygonStyleSymbol->stopRender( renderContext );
175}
176
177void QgsLayoutItemPolygon::_readXmlStyle( const QDomElement &elmt, const QgsReadWriteContext &context )
178{
179 mPolygonStyleSymbol.reset( QgsSymbolLayerUtils::loadSymbol<QgsFillSymbol>( elmt, context ) );
180}
181
183{
184 mPolygonStyleSymbol.reset( static_cast<QgsFillSymbol *>( symbol->clone() ) );
185 refreshSymbol();
186}
187
188void QgsLayoutItemPolygon::_writeXmlStyle( QDomDocument &doc, QDomElement &elmt, const QgsReadWriteContext &context ) const
189{
190 const QDomElement pe = QgsSymbolLayerUtils::saveSymbol( QString(),
191 mPolygonStyleSymbol.get(),
192 doc,
193 context );
194 elmt.appendChild( pe );
195}
196
198{
199 if ( index < 0 || index >= mPolygon.size() || mPolygon.size() <= 3 )
200 return false;
201
202 mPolygon.remove( index );
203
204 int newSelectNode = index;
205 if ( index == mPolygon.size() )
206 newSelectNode = 0;
207 setSelectedNode( newSelectNode );
208
209 return true;
210}
211
@ Millimeters
Millimeters.
@ DisableSymbolClippingToExtent
Force symbol clipping to map extent to be disabled in all situations. This will result in slower rend...
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.
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.
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.
bool isValid() const override
Must be reimplemented in subclasses.
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.
QgsRenderContext & renderContext()
Returns a reference to the context's render context.
@ 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.
QFlags< Flag > Flags
An abstract layout item that provides generic methods for node based shapes such as polygon or polyli...
QgsLayoutItem::Flags itemFlags() const override
Returns the item's flags, which indicate how the item behaves.
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: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).
void setFlag(Qgis::RenderContextFlag flag, bool on=true)
Enable or disable a particular flag (other flags are not affected)
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:1396
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.
Contains information relating to the style entity currently being visited.