sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-12-06 00:03:16 -05:00
Code Issues Packages Projects Releases Wiki Activity

add a simple class to hold parameters information

Browse Source 
this makes it more futureproof to introduce type (string/number) or domain (attribute vs node value)
This commit is contained in:
Denis Rouzaud 2020-12-15 11:47:44 +01:00
parent 9c0ee358ff
commit 9116a1a181
11 changed files with 177 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
python/core/auto_generated/symbology/qgsmarkersymbollayer.sip.in
View File

@ -656,6 +656,20 @@ if the value set is lower or equal to 0 the aspect ratio will be preserved in re
double strokeWidth() const;
void setStrokeWidth( double w );
QgsSvgParameters parameters() const;
%Docstring
Returns the dynamic SVG parameters
.. versionadded:: 3.18
%End
void setParameters( const QgsSvgParameters &parameters );
%Docstring
Sets the dynamic SVG parameters
.. versionadded:: 3.18
%End
void setStrokeWidthUnit( QgsUnitTypes::RenderUnit unit );
%Docstring
Sets the units for the stroke width.

8
python/core/auto_generated/symbology/qgssvgcache.sip.in
View File

@ -49,7 +49,7 @@ Constructor for QgsSvgCache.
QImage svgAsImage( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, bool &fitsInCache, double fixedAspectRatio = 0, bool blocking = false,
const QMap<QString, QString> &parameters = QMap<QString, QString>() );
const QgsSvgParameters &parameters = QgsSvgParameters() );
%Docstring
Returns an SVG drawing as a QImage.
@ -72,7 +72,7 @@ Returns an SVG drawing as a QImage.
QPicture svgAsPicture( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, bool forceVectorOutput = false, double fixedAspectRatio = 0, bool blocking = false,
const QMap<QString, QString> &parameters = QMap<QString, QString>() );
const QgsSvgParameters &parameters = QgsSvgParameters() );
%Docstring
Returns an SVG drawing as a QPicture.
@ -102,7 +102,7 @@ Returns an SVG drawing as a QPicture.
%End
QSizeF svgViewboxSize( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QMap<QString, QString> &parameters = QMap<QString, QString>() );
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QgsSvgParameters &parameters = QgsSvgParameters() );
%Docstring
Calculates the viewbox size of a (possibly cached) SVG file.
@ -195,7 +195,7 @@ in the same thread to ensure provided the remote content.
%End
QByteArray svgContent( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QMap<QString, QString> &parameters = QMap<QString, QString>() );
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QgsSvgParameters &parameters = QgsSvgParameters() );
%Docstring
Gets the SVG content corresponding to the given ``path``.

60
python/core/auto_generated/symbology/qgssvgparameter.sip.in Normal file
View File

@ -0,0 +1,60 @@
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgssvgparameter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsSvgParameter
{
%Docstring
A simple class to hold information for SVG dynamic parameters
.. versionadded:: 3.18
%End
%TypeHeaderCode
#include "qgssvgparameter.h"
%End
public:
QgsSvgParameter();
%Docstring
Constructor
%End
QgsSvgParameter( const QString &name, const QString &value );
%Docstring
Constructor
%End
QString name() const;
%Docstring
Returns the name of the parameter
%End
void setName( const QString &name );
%Docstring
Sets the name of the parameter
%End
QString value() const;
%Docstring
Returns the value of the parameter
%End
void setValue( const QString &value );
%Docstring
Sets the value of the parameter
%End
};
typedef QList<QgsSvgParameter> QgsSvgParameters;
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/symbology/qgssvgparameter.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/

1
python/core/core_auto.sip
View File

@ -570,6 +570,7 @@
%Include auto_generated/symbology/qgsstyleentityvisitor.sip
%Include auto_generated/symbology/qgsstylemodel.sip
%Include auto_generated/symbology/qgssvgcache.sip
%Include auto_generated/symbology/qgssvgparameter.sip
%Include auto_generated/symbology/qgssymbol.sip
%Include auto_generated/symbology/qgssymbollayer.sip
%Include auto_generated/symbology/qgssymbollayerreference.sip

1
src/core/CMakeLists.txt
View File

@ -1502,6 +1502,7 @@ set(QGIS_CORE_HDRS
symbology/qgsstyleentityvisitor.h
symbology/qgsstylemodel.h
symbology/qgssvgcache.h
symbology/qgssvgparameter.h
symbology/qgssymbol.h
symbology/qgssymbollayer.h
symbology/qgssymbollayerreference.h

4
src/core/layout/qgslayoutitempicture.cpp
View File

@ -472,8 +472,8 @@ void QgsLayoutItemPicture::loadPictureUsingCache( const QString &path )
QColor fillColor = mDataDefinedProperties.valueAsColor( QgsLayoutObject::PictureSvgBackgroundColor, context, mSvgFillColor );
QColor strokeColor = mDataDefinedProperties.valueAsColor( QgsLayoutObject::PictureSvgStrokeColor, context, mSvgStrokeColor );
double strokeWidth = mDataDefinedProperties.valueAsDouble( QgsLayoutObject::PictureSvgStrokeWidth, context, mSvgStrokeWidth );
// TODO parameters
QMap<QString, QString> parameters;
// TODO parameters (handle this in the gui part)
QgsSvgParameters parameters;
bool isMissingImage = false;
const QByteArray &svgContent = QgsApplication::svgCache()->svgContent( path, rect().width(), fillColor, strokeColor, strokeWidth,
1.0, 0, false, parameters, &isMissingImage );

14
src/core/symbology/qgsmarkersymbollayer.h
View File

@ -19,6 +19,7 @@
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgssymbollayer.h"
#include "qgssvgparameter.h"
#define DEFAULT_SIMPLEMARKER_NAME "circle"
#define DEFAULT_SIMPLEMARKER_COLOR QColor(255,0,0)
@ -589,6 +590,18 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
double strokeWidth() const { return mStrokeWidth; }
void setStrokeWidth( double w ) { mStrokeWidth = w; }
/**
* Returns the dynamic SVG parameters
* \since QGIS 3.18
*/
QgsSvgParameters parameters() const { return mParameters; }
/**
* Sets the dynamic SVG parameters
* \since QGIS 3.18
*/
void setParameters( const QgsSvgParameters &parameters ) { mParameters = parameters; }
/**
* Sets the units for the stroke width.
* \param unit width units
@ -636,6 +649,7 @@ class CORE_EXPORT QgsSvgMarkerSymbolLayer : public QgsMarkerSymbolLayer
bool mHasFillParam = false;
QColor mStrokeColor;
double mStrokeWidth;
QList<QgsSvgParameter> mParameters;
QgsUnitTypes::RenderUnit mStrokeWidthUnit;
QgsMapUnitScale mStrokeWidthMapUnitScale;

26
src/core/symbology/qgssvgcache.cpp
View File

@ -43,7 +43,7 @@
// QgsSvgCacheEntry
//
QgsSvgCacheEntry::QgsSvgCacheEntry( const QString &path, double size, double strokeWidth, double widthScaleFactor, const QColor &fill, const QColor &stroke, double fixedAspectRatio, const QMap<QString, QString> &parameters )
QgsSvgCacheEntry::QgsSvgCacheEntry( const QString &path, double size, double strokeWidth, double widthScaleFactor, const QColor &fill, const QColor &stroke, double fixedAspectRatio, const QgsSvgParameters &parameters )
: QgsAbstractContentCacheEntry( path )
, size( size )
, strokeWidth( strokeWidth )
@ -121,7 +121,7 @@ QgsSvgCache::QgsSvgCache( QObject *parent )
}
QImage QgsSvgCache::svgAsImage( const QString &file, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, bool &fitsInCache, double fixedAspectRatio, bool blocking, const QMap<QString, QString> &parameters )
double widthScaleFactor, bool &fitsInCache, double fixedAspectRatio, bool blocking, const QgsSvgParameters &parameters )
{
QMutexLocker locker( &mMutex );
@ -181,7 +181,7 @@ QImage QgsSvgCache::svgAsImage( const QString &file, double size, const QColor &
}
QPicture QgsSvgCache::svgAsPicture( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, bool forceVectorOutput, double fixedAspectRatio, bool blocking, const QMap<QString, QString> &parameters )
double widthScaleFactor, bool forceVectorOutput, double fixedAspectRatio, bool blocking, const QgsSvgParameters &parameters )
{
QMutexLocker locker( &mMutex );
@ -205,7 +205,7 @@ QPicture QgsSvgCache::svgAsPicture( const QString &path, double size, const QCol
}
QByteArray QgsSvgCache::svgContent( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio, bool blocking, const QMap<QString, QString> &parameters, bool *isMissingImage )
double widthScaleFactor, double fixedAspectRatio, bool blocking, const QgsSvgParameters &parameters, bool *isMissingImage )
{
QMutexLocker locker( &mMutex );
@ -215,7 +215,7 @@ QByteArray QgsSvgCache::svgContent( const QString &path, double size, const QCol
}
QSizeF QgsSvgCache::svgViewboxSize( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio, bool blocking, const QMap<QString, QString> &parameters )
double widthScaleFactor, double fixedAspectRatio, bool blocking, const QgsSvgParameters &parameters )
{
QMutexLocker locker( &mMutex );
@ -495,7 +495,7 @@ void QgsSvgCache::cachePicture( QgsSvgCacheEntry *entry, bool forceVectorOutput
}
QgsSvgCacheEntry *QgsSvgCache::cacheEntry( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio, const QMap<QString, QString> &parameters, bool blocking, bool *isMissingImage )
double widthScaleFactor, double fixedAspectRatio, const QgsSvgParameters &parameters, bool blocking, bool *isMissingImage )
{
QgsSvgCacheEntry *currentEntry = findExistingEntry( new QgsSvgCacheEntry( path, size, strokeWidth, widthScaleFactor, fill, stroke, fixedAspectRatio, parameters ) );
@ -511,7 +511,7 @@ QgsSvgCacheEntry *QgsSvgCache::cacheEntry( const QString &path, double size, con
}
void QgsSvgCache::replaceElemParams( QDomElement &elem, const QColor &fill, const QColor &stroke, double strokeWidth, const QMap<QString, QString> &parameters )
void QgsSvgCache::replaceElemParams( QDomElement &elem, const QColor &fill, const QColor &stroke, double strokeWidth, const QgsSvgParameters &parameters )
{
if ( elem.isNull() )
{
@ -598,12 +598,12 @@ void QgsSvgCache::replaceElemParams( QDomElement &elem, const QColor &fill, cons
}
else
{
QMap<QString, QString>::const_iterator paramIt = parameters.constBegin();
QgsSvgParameters::const_iterator paramIt = parameters.constBegin();
for ( ; paramIt != parameters.constEnd(); ++paramIt )
{
if ( value.startsWith( QString( QLatin1String( "param(%1)" ) ).arg( paramIt.key() ) ) )
if ( value.startsWith( QString( QLatin1String( "param(%1)" ) ).arg( paramIt->name() ) ) )
{
elem.setAttribute( attribute.name(), paramIt.value() );
elem.setAttribute( attribute.name(), paramIt->value() );
break;
}
}
@ -613,12 +613,12 @@ void QgsSvgCache::replaceElemParams( QDomElement &elem, const QColor &fill, cons
if ( elem.nodeValue().startsWith( "param(" ) )
{
QMap<QString, QString>::const_iterator paramIt = parameters.constBegin();
QgsSvgParameters::const_iterator paramIt = parameters.constBegin();
for ( ; paramIt != parameters.constEnd(); ++paramIt )
{
if ( elem.nodeValue().startsWith( QString( QLatin1String( "param(%1)" ) ).arg( paramIt.key() ) ) )
if ( elem.nodeValue().startsWith( QString( QLatin1String( "param(%1)" ) ).arg( paramIt->name() ) ) )
{
elem.setNodeValue( paramIt.value() );
elem.setNodeValue( paramIt->value() );
break;
}
}

19
src/core/symbology/qgssvgcache.h
View File

@ -20,6 +20,7 @@
#include "qgsabstractcontentcache.h"
#include "qgis.h"
#include "qgssvgparameter.h"
#include <QPicture>
@ -49,7 +50,7 @@ class CORE_EXPORT QgsSvgCacheEntry : public QgsAbstractContentCacheEntry
* \param parameters an optional map of parameters to dynamically replace content in the SVG
*/
QgsSvgCacheEntry( const QString &path, double size, double strokeWidth, double widthScaleFactor, const QColor &fill, const QColor &stroke,
double fixedAspectRatio = 0, const QMap<QString, QString> &parameters = QMap<QString, QString>() ) ;
double fixedAspectRatio = 0, const QgsSvgParameters &parameters = QgsSvgParameters() ) ;
//! QgsSvgCacheEntry cannot be copied.
QgsSvgCacheEntry( const QgsSvgCacheEntry &rh ) = delete;
@ -71,7 +72,7 @@ class CORE_EXPORT QgsSvgCacheEntry : public QgsAbstractContentCacheEntry
QColor fill = Qt::black;
QColor stroke = Qt::black;
QMap<QString, QString> parameters;
QgsSvgParameters parameters;
std::unique_ptr< QImage > image;
std::unique_ptr< QPicture > picture;
@ -150,7 +151,7 @@ class CORE_EXPORT QgsSvgCache : public QgsAbstractContentCache< QgsSvgCacheEntry
*/
QImage svgAsImage( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, bool &fitsInCache, double fixedAspectRatio = 0, bool blocking = false,
const QMap<QString, QString> &parameters = QMap<QString, QString>() );
const QgsSvgParameters &parameters = QgsSvgParameters() );
/**
* Returns an SVG drawing as a QPicture.
@ -176,7 +177,7 @@ class CORE_EXPORT QgsSvgCache : public QgsAbstractContentCache< QgsSvgCacheEntry
*/
QPicture svgAsPicture( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, bool forceVectorOutput = false, double fixedAspectRatio = 0, bool blocking = false,
const QMap<QString, QString> &parameters = QMap<QString, QString>() );
const QgsSvgParameters &parameters = QgsSvgParameters() );
/**
* Calculates the viewbox size of a (possibly cached) SVG file.
@ -197,7 +198,7 @@ class CORE_EXPORT QgsSvgCache : public QgsAbstractContentCache< QgsSvgCacheEntry
* \since QGIS 2.14
*/
QSizeF svgViewboxSize( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QMap<QString, QString> &parameters = QMap<QString, QString>() );
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QgsSvgParameters &parameters = QgsSvgParameters() );
/**
* Tests if an SVG file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several
@ -276,10 +277,10 @@ class CORE_EXPORT QgsSvgCache : public QgsAbstractContentCache< QgsSvgCacheEntry
*/
#ifndef SIP_RUN
QByteArray svgContent( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QMap<QString, QString> &parameters = QMap<QString, QString>(), bool *isMissingImage = nullptr );
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QgsSvgParameters &parameters = QgsSvgParameters(), bool *isMissingImage = nullptr );
#else
QByteArray svgContent( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QMap<QString, QString> &parameters = QMap<QString, QString>() );
double widthScaleFactor, double fixedAspectRatio = 0, bool blocking = false, const QgsSvgParameters &parameters = QgsSvgParameters() );
#endif
signals:
@ -307,10 +308,10 @@ class CORE_EXPORT QgsSvgCache : public QgsAbstractContentCache< QgsSvgCacheEntry
void cachePicture( QgsSvgCacheEntry *entry, bool forceVectorOutput = false );
//! Returns entry from cache or creates a new entry if it does not exist already
QgsSvgCacheEntry *cacheEntry( const QString &path, double size, const QColor &fill, const QColor &stroke, double strokeWidth,
double widthScaleFactor, double fixedAspectRatio = 0, const QMap<QString, QString> &parameters = QMap<QString, QString>(), bool blocking = false, bool *isMissingImage = nullptr );
double widthScaleFactor, double fixedAspectRatio = 0, const QgsSvgParameters &parameters = QgsSvgParameters(), bool blocking = false, bool *isMissingImage = nullptr );
//! Replaces parameters in elements of a dom node and calls method for all child nodes
void replaceElemParams( QDomElement &elem, const QColor &fill, const QColor &stroke, double strokeWidth, const QMap<QString, QString> &parameters );
void replaceElemParams( QDomElement &elem, const QColor &fill, const QColor &stroke, double strokeWidth, const QgsSvgParameters &parameters );
void containsElemParams( const QDomElement &elem,
bool &hasFillParam, bool &hasDefaultFill, QColor &defaultFill,

56
src/core/symbology/qgssvgparameter.h Normal file
View File

@ -0,0 +1,56 @@
#ifndef QGSSVGPARAMETER_H
#define QGSSVGPARAMETER_H
/***************************************************************************
qgssvgparameter.h
---------------------
begin : December 2020
copyright : (C) 2020 by Denis Rouzaud
email : denis@gmail.com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgis_core.h"
#include <QList>
#include <QString>
/**
\ingroup core
A simple class to hold information for SVG dynamic parameters
\since QGIS 3.18
*/
class CORE_EXPORT QgsSvgParameter
{
public:
//! Constructor
QgsSvgParameter() = default;
//! Constructor
QgsSvgParameter( const QString &name, const QString &value )
: mValid( !name.isEmpty() ), mName( name ), mValue( value ) {}
//! Returns the name of the parameter
QString name() const {return mName;}
//! Sets the name of the parameter
void setName( const QString &name ) {mName = name;}
//! Returns the value of the parameter
QString value() const {return mValue;}
//! Sets the value of the parameter
void setValue( const QString &value ) {mValue = value;}
private:
bool mValid = false;
QString mName;
QString mValue;
};
typedef QList<QgsSvgParameter> QgsSvgParameters;
#endif // QGSSVGPARAMETER_H

3
tests/src/core/testqgssvgcache.cpp
View File

@ -24,6 +24,7 @@
#include <QPainter>
#include <QtConcurrent>
#include <QElapsedTimer>
#include "qgssvgparameter.h"
#include "qgssvgcache.h"
#include "qgsmultirenderchecker.h"
#include "qgsapplication.h"
@ -339,7 +340,7 @@ void TestQgsSvgCache::dynamicSvg()
QgsSvgCache cache;
const QString dynamicImage = TEST_DATA_DIR + QStringLiteral( "/svg/test_dynamic_svg.svg" );
QByteArray svg = cache.svgContent( dynamicImage, 200, QColor( 0, 0, 0 ), QColor( 0, 0, 0 ), 1.0,
1.0, 0, false, {{"text1", "green?"}, {"text2", "supergreen"}, {"align", "middle"}} );
1.0, 0, false, QgsSvgParameters( {QgsSvgParameter( "text1", "green?" ), QgsSvgParameter( "text2", "supergreen" ), QgsSvgParameter( "align", "middle" )} ) );
const QString contolImage = TEST_DATA_DIR + QStringLiteral( "/svg/test_dynamic_svg.svg" );
QByteArray control_svg = cache.svgContent( contolImage, 200, QColor( 0, 0, 0 ), QColor( 0, 0, 0 ), 1.0,
1.0, 0, false, {} );