QGIS API Documentation 3.27.0-Master (1d7a28cfd2)
qgssvgannotation.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgssvgannotation.cpp
3 --------------------
4 begin : November, 2012
5 copyright : (C) 2012 by Marco Hugentobler
6 email : marco dot hugentobler at sourcepole dot ch
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#include "qgssvgannotation.h"
19
20#include "qgsreadwritecontext.h"
21#include "qgsproject.h"
22#include "qgssymbollayerutils.h"
23
24#include <QDomDocument>
25#include <QDomElement>
26
27
29 : QgsAnnotation( parent )
30{
31
32}
33
35{
36 std::unique_ptr< QgsSvgAnnotation > c( new QgsSvgAnnotation() );
37 copyCommonProperties( c.get() );
38 c->setFilePath( mFilePath );
39 return c.release();
40}
41
42void QgsSvgAnnotation::writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const
43{
44 const QString filePath = QgsSymbolLayerUtils::svgSymbolPathToName( mFilePath, context.pathResolver() );
45 QDomElement svgAnnotationElem = doc.createElement( QStringLiteral( "SVGAnnotationItem" ) );
46 svgAnnotationElem.setAttribute( QStringLiteral( "file" ), filePath );
47 _writeXml( svgAnnotationElem, doc, context );
48 elem.appendChild( svgAnnotationElem );
49}
50
51void QgsSvgAnnotation::readXml( const QDomElement &itemElem, const QgsReadWriteContext &context )
52{
53 const QString filePath = QgsSymbolLayerUtils::svgSymbolNameToPath( itemElem.attribute( QStringLiteral( "file" ) ), context.pathResolver() );
55 const QDomElement annotationElem = itemElem.firstChildElement( QStringLiteral( "AnnotationItem" ) );
56 if ( !annotationElem.isNull() )
57 {
58 _readXml( annotationElem, context );
59 }
60}
61
62void QgsSvgAnnotation::renderAnnotation( QgsRenderContext &context, QSizeF size ) const
63{
64 QPainter *painter = context.painter();
65 if ( !painter )
66 {
67 return;
68 }
69
70 //keep width/height ratio of svg
71 const QRect viewBox = mSvgRenderer.viewBox();
72 if ( viewBox.isValid() )
73 {
74 const double widthRatio = size.width() / viewBox.width();
75 const double heightRatio = size.height() / viewBox.height();
76 double renderWidth = 0;
77 double renderHeight = 0;
78 if ( widthRatio <= heightRatio )
79 {
80 renderWidth = size.width();
81 renderHeight = viewBox.height() * widthRatio;
82 }
83 else
84 {
85 renderHeight = size.height();
86 renderWidth = viewBox.width() * heightRatio;
87 }
88
89 mSvgRenderer.render( painter, QRectF( 0, 0, renderWidth,
90 renderHeight ) );
91 }
92}
93
94void QgsSvgAnnotation::setFilePath( const QString &file )
95{
96 mFilePath = file;
97 mSvgRenderer.load( mFilePath );
98 emit appearanceChanged();
99}
Abstract base class for annotation items which are drawn over a map.
Definition: qgsannotation.h:54
void appearanceChanged()
Emitted whenever the annotation's appearance changes.
void _writeXml(QDomElement &itemElem, QDomDocument &doc, const QgsReadWriteContext &context) const
Writes common annotation properties to a DOM element.
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.
The class is used as a container of context for various read/write operations on other objects.
const QgsPathResolver & pathResolver() const
Returns path resolver for conversion between relative and absolute paths.
Contains information about the context of a rendering operation.
QPainter * painter()
Returns the destination QPainter for the render operation.
An annotation which renders the contents of an SVG file.
QgsSvgAnnotation(QObject *parent=nullptr)
Constructor for QgsSvgAnnotation.
void renderAnnotation(QgsRenderContext &context, QSizeF size) const override
Renders the annotation's contents to a target /a context at the specified /a size.
void setFilePath(const QString &file)
Sets the file path for the source SVG file.
QString filePath() const
Returns the file path for the source SVG file.
void writeXml(QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context) const override
Writes the annotation state to a DOM element.
void readXml(const QDomElement &itemElem, const QgsReadWriteContext &context) override
Restores the annotation's state from a DOM element.
QgsSvgAnnotation * clone() const override
Clones the annotation, returning a new copy of the annotation reflecting the annotation's current sta...
static QString svgSymbolPathToName(const QString &path, const QgsPathResolver &pathResolver)
Determines an SVG symbol's name from its path.
static QString svgSymbolNameToPath(const QString &name, const QgsPathResolver &pathResolver)
Determines an SVG symbol's path from its name.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c