38 props.insert( QStringLiteral(
"color" ), QStringLiteral(
"white" ) );
39 props.insert( QStringLiteral(
"style" ), QStringLiteral(
"solid" ) );
40 props.insert( QStringLiteral(
"style_border" ), QStringLiteral(
"solid" ) );
41 props.insert( QStringLiteral(
"color_border" ), QStringLiteral(
"black" ) );
42 props.insert( QStringLiteral(
"width_border" ), QStringLiteral(
"0.3" ) );
43 props.insert( QStringLiteral(
"joinstyle" ), QStringLiteral(
"miter" ) );
60 if ( mHasFixedMapPosition == fixed )
63 mHasFixedMapPosition = fixed;
69 mMapPosition = position;
75 mMapPositionCrs =
crs;
81 mRelativePosition = position;
93 return mOffsetFromReferencePoint / 3.7795275;
98 mOffsetFromReferencePoint = offset;
112 return mFrameSize / 3.7795275;
125 mContentsMargins = margins;
131 mFillSymbol.reset( symbol );
137 return mFillSymbol.get();
142 QPainter *painter = context.
painter();
151 drawFrame( context );
152 if ( mHasFixedMapPosition )
154 drawMarkerSymbol( context );
156 if ( mHasFixedMapPosition )
178 mMarkerSymbol.reset( symbol );
221 return QSizeF( 0, 0 );
229 auto scaleSize = [&context](
double size )->
double
234 const QRectF frameRect( mHasFixedMapPosition ? scaleSize( mOffsetFromReferencePoint.x() ) : 0,
235 mHasFixedMapPosition ? scaleSize( mOffsetFromReferencePoint.y() ) : 0,
236 scaleSize( mFrameSize.width() ),
237 scaleSize( mFrameSize.height() ) );
242 mFillSymbol->startRender( context );
243 const QVector<QPolygonF> rings;
244 mFillSymbol->renderPolygon( poly, &rings,
nullptr, context );
245 mFillSymbol->stopRender( context );
257 mMarkerSymbol->startRender( context );
258 mMarkerSymbol->renderPoint( QPointF( 0, 0 ),
nullptr, context );
259 mMarkerSymbol->stopRender( context );
265 if ( itemElem.isNull() )
269 QDomElement annotationElem = doc.createElement( QStringLiteral(
"AnnotationItem" ) );
270 annotationElem.setAttribute( QStringLiteral(
"mapPositionFixed" ), mHasFixedMapPosition );
271 annotationElem.setAttribute( QStringLiteral(
"mapPosX" ),
qgsDoubleToString( mMapPosition.
x() ) );
272 annotationElem.setAttribute( QStringLiteral(
"mapPosY" ),
qgsDoubleToString( mMapPosition.
y() ) );
273 if ( mMapPositionCrs.
isValid() )
274 mMapPositionCrs.
writeXml( annotationElem, doc );
275 annotationElem.setAttribute( QStringLiteral(
"offsetXMM" ),
qgsDoubleToString( mOffsetFromReferencePoint.x() ) );
276 annotationElem.setAttribute( QStringLiteral(
"offsetYMM" ),
qgsDoubleToString( mOffsetFromReferencePoint.y() ) );
277 annotationElem.setAttribute( QStringLiteral(
"frameWidthMM" ),
qgsDoubleToString( mFrameSize.width() ) );
278 annotationElem.setAttribute( QStringLiteral(
"frameHeightMM" ),
qgsDoubleToString( mFrameSize.height() ) );
279 annotationElem.setAttribute( QStringLiteral(
"canvasPosX" ),
qgsDoubleToString( mRelativePosition.x() ) );
280 annotationElem.setAttribute( QStringLiteral(
"canvasPosY" ),
qgsDoubleToString( mRelativePosition.y() ) );
281 annotationElem.setAttribute( QStringLiteral(
"contentsMargin" ), mContentsMargins.
toString() );
282 annotationElem.setAttribute( QStringLiteral(
"visible" ),
isVisible() );
285 annotationElem.setAttribute( QStringLiteral(
"mapLayer" ), mMapLayer->id() );
290 if ( !symbolElem.isNull() )
292 annotationElem.appendChild( symbolElem );
297 QDomElement fillElem = doc.createElement( QStringLiteral(
"fillSymbol" ) );
299 if ( !symbolElem.isNull() )
301 fillElem.appendChild( symbolElem );
302 annotationElem.appendChild( fillElem );
305 itemElem.appendChild( annotationElem );
310 if ( annotationElem.isNull() )
315 pos.setX( annotationElem.attribute( QStringLiteral(
"canvasPosX" ), QStringLiteral(
"0" ) ).toDouble() );
316 pos.setY( annotationElem.attribute( QStringLiteral(
"canvasPosY" ), QStringLiteral(
"0" ) ).toDouble() );
317 if ( pos.x() >= 1 || pos.x() < 0 || pos.y() < 0 || pos.y() >= 1 )
318 mRelativePosition = QPointF();
320 mRelativePosition = pos;
322 mapPos.
setX( annotationElem.attribute( QStringLiteral(
"mapPosX" ), QStringLiteral(
"0" ) ).toDouble() );
323 mapPos.
setY( annotationElem.attribute( QStringLiteral(
"mapPosY" ), QStringLiteral(
"0" ) ).toDouble() );
324 mMapPosition = mapPos;
326 if ( !mMapPositionCrs.
readXml( annotationElem ) )
331 mContentsMargins =
QgsMargins::fromString( annotationElem.attribute( QStringLiteral(
"contentsMargin" ) ) );
333 if ( annotationElem.hasAttribute( QStringLiteral(
"frameWidthMM" ) ) )
334 mFrameSize.setWidth( annotationElem.attribute( QStringLiteral(
"frameWidthMM" ), QStringLiteral(
"5" ) ).toDouble() );
336 mFrameSize.setWidth( dpiScale * annotationElem.attribute( QStringLiteral(
"frameWidth" ), QStringLiteral(
"50" ) ).toDouble() );
337 if ( annotationElem.hasAttribute( QStringLiteral(
"frameHeightMM" ) ) )
338 mFrameSize.setHeight( annotationElem.attribute( QStringLiteral(
"frameHeightMM" ), QStringLiteral(
"3" ) ).toDouble() );
340 mFrameSize.setHeight( dpiScale * annotationElem.attribute( QStringLiteral(
"frameHeight" ), QStringLiteral(
"50" ) ).toDouble() );
342 if ( annotationElem.hasAttribute( QStringLiteral(
"offsetXMM" ) ) )
343 mOffsetFromReferencePoint.setX( annotationElem.attribute( QStringLiteral(
"offsetXMM" ), QStringLiteral(
"0" ) ).toDouble() );
345 mOffsetFromReferencePoint.setX( dpiScale * annotationElem.attribute( QStringLiteral(
"offsetX" ), QStringLiteral(
"0" ) ).toDouble() );
346 if ( annotationElem.hasAttribute( QStringLiteral(
"offsetYMM" ) ) )
347 mOffsetFromReferencePoint.setY( annotationElem.attribute( QStringLiteral(
"offsetYMM" ), QStringLiteral(
"0" ) ).toDouble() );
349 mOffsetFromReferencePoint.setY( dpiScale * annotationElem.attribute( QStringLiteral(
"offsetY" ), QStringLiteral(
"0" ) ).toDouble() );
351 mHasFixedMapPosition = annotationElem.attribute( QStringLiteral(
"mapPositionFixed" ), QStringLiteral(
"1" ) ).toInt();
352 mVisible = annotationElem.attribute( QStringLiteral(
"visible" ), QStringLiteral(
"1" ) ).toInt();
353 if ( annotationElem.hasAttribute( QStringLiteral(
"mapLayer" ) ) )
360 const QDomElement symbolElem = annotationElem.firstChildElement( QStringLiteral(
"symbol" ) );
361 if ( !symbolElem.isNull() )
363 QgsMarkerSymbol *symbol = QgsSymbolLayerUtils::loadSymbol<QgsMarkerSymbol>( symbolElem, context );
366 mMarkerSymbol.reset( symbol );
371 mFillSymbol.reset(
nullptr );
372 const QDomElement fillElem = annotationElem.firstChildElement( QStringLiteral(
"fillSymbol" ) );
373 if ( !fillElem.isNull() )
375 const QDomElement symbolElem = fillElem.firstChildElement( QStringLiteral(
"symbol" ) );
376 if ( !symbolElem.isNull() )
378 QgsFillSymbol *symbol = QgsSymbolLayerUtils::loadSymbol<QgsFillSymbol>( symbolElem, context );
381 mFillSymbol.reset( symbol );
388 frameColor.setNamedColor( annotationElem.attribute( QStringLiteral(
"frameColor" ), QStringLiteral(
"#000000" ) ) );
389 frameColor.setAlpha( annotationElem.attribute( QStringLiteral(
"frameColorAlpha" ), QStringLiteral(
"255" ) ).toInt() );
390 QColor frameBackgroundColor;
391 frameBackgroundColor.setNamedColor( annotationElem.attribute( QStringLiteral(
"frameBackgroundColor" ) ) );
392 frameBackgroundColor.setAlpha( annotationElem.attribute( QStringLiteral(
"frameBackgroundColorAlpha" ), QStringLiteral(
"255" ) ).toInt() );
393 double frameBorderWidth = annotationElem.attribute( QStringLiteral(
"frameBorderWidth" ), QStringLiteral(
"0.5" ) ).toDouble();
395 frameBorderWidth = frameBorderWidth * 25.4 / 96.0;
397 props.insert( QStringLiteral(
"color" ), frameBackgroundColor.name() );
398 props.insert( QStringLiteral(
"style" ), QStringLiteral(
"solid" ) );
399 props.insert( QStringLiteral(
"style_border" ), QStringLiteral(
"solid" ) );
400 props.insert( QStringLiteral(
"color_border" ), frameColor.name() );
401 props.insert( QStringLiteral(
"width_border" ), QString::number( frameBorderWidth ) );
402 props.insert( QStringLiteral(
"joinstyle" ), QStringLiteral(
"miter" ) );
411 target->mVisible = mVisible;
412 target->mHasFixedMapPosition = mHasFixedMapPosition;
413 target->mMapPosition = mMapPosition;
414 target->mMapPositionCrs = mMapPositionCrs;
415 target->mRelativePosition = mRelativePosition;
416 target->mOffsetFromReferencePoint = mOffsetFromReferencePoint;
417 target->mFrameSize = mFrameSize;
418 target->mMarkerSymbol.reset( mMarkerSymbol ? mMarkerSymbol->clone() :
nullptr );
419 target->mContentsMargins = mContentsMargins;
420 target->mFillSymbol.reset( mFillSymbol ? mFillSymbol->clone() :
nullptr );
421 target->mSegmentPointWidthMm = mSegmentPointWidthMm;
422 target->mMapLayer = mMapLayer;
423 target->mFeature = mFeature;
Abstract base class for annotation items which are drawn over a map.
void appearanceChanged()
Emitted whenever the annotation's appearance changes.
Q_DECL_DEPRECATED void setFrameSize(QSizeF size)
Sets the size (in pixels) of the annotation's frame (the main area in which the annotation's content ...
void setFillSymbol(QgsFillSymbol *symbol)
Sets the fill symbol used for rendering the annotation frame.
Q_DECL_DEPRECATED void setFrameOffsetFromReferencePoint(QPointF offset)
Sets the annotation's frame's offset (in pixels) from the mapPosition() reference point.
void setRelativePosition(QPointF position)
Sets the relative position of the annotation, if it is not attached to a fixed map position.
virtual void renderAnnotation(QgsRenderContext &context, QSizeF size) const =0
Renders the annotation's contents to a target /a context at the specified /a size.
void setMapPosition(const QgsPointXY &position)
Sets the map position of the annotation, if it is attached to a fixed map position.
void moved()
Emitted when the annotation's position has changed and items need to be moved to reflect this.
Q_DECL_DEPRECATED QPointF frameOffsetFromReferencePoint() const
Returns the annotation's frame's offset (in pixels) from the mapPosition() reference point.
void _writeXml(QDomElement &itemElem, QDomDocument &doc, const QgsReadWriteContext &context) const
Writes common annotation properties to a DOM element.
virtual bool accept(QgsStyleEntityVisitorInterface *visitor) const
Accepts the specified style entity visitor, causing it to visit all style entities associated within ...
void setContentsMargin(const QgsMargins &margins)
Sets the margins (in millimeters) between the outside of the frame and the annotation content.
void setFrameSizeMm(QSizeF size)
Sets the size (in millimeters) of the annotation's frame (the main area in which the annotation's con...
virtual void setAssociatedFeature(const QgsFeature &feature)
Sets the feature associated with the annotation.
void setFrameOffsetFromReferencePointMm(QPointF offset)
Sets the annotation's frame's offset (in millimeters) from the mapPosition() reference point.
void setMapPositionCrs(const QgsCoordinateReferenceSystem &crs)
Sets the CRS of the map position.
~QgsAnnotation() override
void _readXml(const QDomElement &annotationElem, const QgsReadWriteContext &context)
Reads common annotation properties from a DOM element.
void copyCommonProperties(QgsAnnotation *target) const
Copies common annotation properties to the targe annotation.
void render(QgsRenderContext &context) const
Renders the annotation to a target render context.
virtual QSizeF minimumFrameSize() const
Returns the minimum frame size for the annotation.
bool isVisible() const
Returns true if the annotation is visible and should be rendered.
void setHasFixedMapPosition(bool fixed)
Sets whether the annotation is attached to a fixed map position, or uses a position relative to the c...
QgsAnnotation(QObject *parent=nullptr)
Constructor for QgsAnnotation.
void setMarkerSymbol(QgsMarkerSymbol *symbol)
Sets the symbol that is drawn at the annotation's map position.
QgsFillSymbol * fillSymbol() const
Returns the symbol that is used for rendering the annotation frame.
void setVisible(bool visible)
Sets whether the annotation is visible and should be rendered.
void mapLayerChanged()
Emitted when the map layer associated with the annotation changes.
void setMapLayer(QgsMapLayer *layer)
Sets the map layer associated with the annotation.
This class represents a coordinate reference system (CRS).
bool isValid() const
Returns whether this CRS is correctly initialized and usable.
bool readXml(const QDomNode &node)
Restores state from the given DOM node.
bool writeXml(QDomNode &node, QDomDocument &doc) const
Stores state to the given Dom node in the given document.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
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.
Base class for all map layer types.
The QgsMargins class defines the four margins of a rectangle.
double top() const
Returns the top margin.
static QgsMargins fromString(const QString &string)
Returns a QgsMargins object decoded from a string, or a null QgsMargins if the string could not be in...
double right() const
Returns the right margin.
double bottom() const
Returns the bottom margin.
QString toString() const
Returns the margins encoded to a string.
double left() const
Returns the left margin.
A marker symbol type, for rendering Point and MultiPoint geometries.
A class to represent a 2D point.
void setX(double x) SIP_HOLDGIL
Sets the x value of the point.
void setY(double y) SIP_HOLDGIL
Sets the y value of the point.
static QgsProject * instance()
Returns the QgsProject singleton instance.
Q_INVOKABLE QgsMapLayer * mapLayer(const QString &layerId) const
Retrieve a pointer to a registered layer by layer ID.
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.
void setPainterFlagsUsingContext(QPainter *painter=nullptr) const
Sets relevant flags on a destination painter, using the flags and settings currently defined for the ...
Scoped object for saving and restoring a QPainter object's state.
static QPolygonF createBalloon(const QgsPointXY &origin, const QRectF &rect, double wedgeWidth)
Generates a "balloon"/"talking bubble" style shape (as a QPolygonF).
An interface for classes which can visit style entity (e.g.
@ Annotation
An individual annotation.
virtual bool visitExit(const QgsStyleEntityVisitorInterface::Node &node)
Called when the visitor stops visiting a node.
virtual bool visitEnter(const QgsStyleEntityVisitorInterface::Node &node)
Called when the visitor starts visiting a node.
virtual bool visit(const QgsStyleEntityVisitorInterface::StyleLeaf &entity)
Called when the visitor will visit a style entity.
A symbol entity for QgsStyle databases.
static QDomElement saveSymbol(const QString &symbolName, const QgsSymbol *symbol, QDomDocument &doc, const QgsReadWriteContext &context)
Writes a symbol definition to XML.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Q_GUI_EXPORT int qt_defaultDpiX()
const QgsCoordinateReferenceSystem & crs
Contains information relating to a node (i.e.
Contains information relating to the style entity currently being visited.