A cache for images / pictures derived from svg files. More...

#include <qgssvgcache.h>

Collaboration diagram for QgsSvgCache:

Signals
void	statusChanged (const QString &theStatusQString)
	Emit a signal to be caught by qgisapp and display a msg on status bar.

Public Member Functions
	~QgsSvgCache ()
const QImage &	svgAsImage (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor, bool &fitsInCache)
	Get SVG as QImage.
const QPicture &	svgAsPicture (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor, bool forceVectorOutput=false)
	Get SVG as QPicture&.
void	containsParams (const QString &path, bool &hasFillParam, QColor &defaultFillColor, bool &hasOutlineParam, QColor &defaultOutlineColor, bool &hasOutlineWidthParam, double &defaultOutlineWidth) const
	Tests if an svg file contains parameters for fill, outline color, outline width.
QByteArray	getImageData (const QString &path) const
	Get image data.

Static Public Member Functions
static QgsSvgCache *	instance ()

Protected Member Functions
	QgsSvgCache (QObject *parent=0)
	protected constructor
QgsSvgCacheEntry *	insertSVG (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor)
	Creates new cache entry and returns pointer to it.
void	replaceParamsAndCacheSvg (QgsSvgCacheEntry *entry)
void	cacheImage (QgsSvgCacheEntry *entry)
void	cachePicture (QgsSvgCacheEntry *entry, bool forceVectorOutput=false)
QgsSvgCacheEntry *	cacheEntry (const QString &file, double size, const QColor &fill, const QColor &outline, double outlineWidth, double widthScaleFactor, double rasterScaleFactor)
	Returns entry from cache or creates a new entry if it does not exist already.
void	trimToMaximumSize ()
	Removes the least used items until the maximum size is under the limit.
void	takeEntryFromList (QgsSvgCacheEntry *entry)

Private Slots
void	downloadProgress (qint64, qint64)

Private Member Functions
void	replaceElemParams (QDomElement &elem, const QColor &fill, const QColor &outline, double outlineWidth)
	Replaces parameters in elements of a dom node and calls method for all child nodes.
void	containsElemParams (const QDomElement &elem, bool &hasFillParam, QColor &defaultFill, bool &hasOutlineParam, QColor &defaultOutline, bool &hasOutlineWidthParam, double &defaultOutlineWidth) const
void	removeCacheEntry (QString s, QgsSvgCacheEntry *entry)
	Release memory and remove cache entry from mEntryLookup.
void	printEntryList ()
	For debugging.

Private Attributes
QMultiHash< QString, QgsSvgCacheEntry * >	mEntryLookup
	Entry pointers accessible by file name.
long	mTotalSize
	Estimated total size of all images, pictures and svgContent.
QgsSvgCacheEntry *	mLeastRecentEntry
QgsSvgCacheEntry *	mMostRecentEntry
QByteArray	mMissingSvg
	SVG content to be rendered if SVG file was not found.

Static Private Attributes
static const long	mMaximumSize = 20000000

Detailed Description

A cache for images / pictures derived from svg files.

This class supports parameter replacement in svg files according to the svg params specification (http://www.w3.org/TR/2009/WD-SVGParamPrimer-20090616/). Supported are the parameters 'fill-color', 'pen-color', 'outline-width', 'stroke-width'. E.g. <circle fill="param(fill-color red)" stroke="param(pen-color black)" stroke-width="param(outline-width 1)"

Definition at line 72 of file qgssvgcache.h.

Constructor & Destructor Documentation

QgsSvgCache::~QgsSvgCache ( )

Definition at line 99 of file qgssvgcache.cpp.

References mEntryLookup.

QgsSvgCache::QgsSvgCache ( QObject * parent = 0 )

protected

protected constructor

Definition at line 90 of file qgssvgcache.cpp.

References mMissingSvg.

Member Function Documentation

QgsSvgCacheEntry * QgsSvgCache::cacheEntry	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor
	)

protected

Returns entry from cache or creates a new entry if it does not exist already.

Definition at line 446 of file qgssvgcache.cpp.

References QgsSvgCacheEntry::file, QgsSvgCacheEntry::fill, insertSVG(), mEntryLookup, mLeastRecentEntry, mMostRecentEntry, QgsSvgCacheEntry::nextEntry, QgsSvgCacheEntry::outline, QgsSvgCacheEntry::outlineWidth, QgsSvgCacheEntry::previousEntry, qgsDoubleNear(), QgsSvgCacheEntry::rasterScaleFactor, rasterScaleFactor, QgsSvgCacheEntry::size, takeEntryFromList(), and QgsSvgCacheEntry::widthScaleFactor.

Referenced by svgAsImage(), and svgAsPicture().

void QgsSvgCache::cacheImage ( QgsSvgCacheEntry * entry )

protected

Definition at line 353 of file qgssvgcache.cpp.

References QgsSvgCacheEntry::image, mTotalSize, QgsSvgCacheEntry::size, and QgsSvgCacheEntry::svgContent.

Referenced by svgAsImage().

void QgsSvgCache::cachePicture	(	QgsSvgCacheEntry *	entry,
		bool	forceVectorOutput = `false`
	)

protected

Definition at line 402 of file qgssvgcache.cpp.

References mTotalSize, QgsSvgCacheEntry::picture, qgsDoubleNear(), QgsSvgCacheEntry::rasterScaleFactor, QgsSvgCacheEntry::size, QgsSvgCacheEntry::svgContent, and QgsSvgCacheEntry::widthScaleFactor.

Referenced by svgAsImage(), and svgAsPicture().

void QgsSvgCache::containsElemParams	(	const QDomElement &	elem,
		bool &	hasFillParam,
		QColor &	defaultFill,
		bool &	hasOutlineParam,
		QColor &	defaultOutline,
		bool &	hasOutlineWidthParam,
		double &	defaultOutlineWidth
	)		const

private

Definition at line 572 of file qgssvgcache.cpp.

Referenced by containsParams().

void QgsSvgCache::containsParams	(	const QString &	path,
		bool &	hasFillParam,
		QColor &	defaultFillColor,
		bool &	hasOutlineParam,
		QColor &	defaultOutlineColor,
		bool &	hasOutlineWidthParam,
		double &	defaultOutlineWidth
	)		const

Tests if an svg file contains parameters for fill, outline color, outline width.

If yes, possible default values are returned. If there are several default values in the svg file, only the first one is considered

Definition at line 200 of file qgssvgcache.cpp.

References containsElemParams(), and getImageData().

Referenced by QgsSvgMarkerSymbolLayerV2::create(), QgsSVGFillSymbolLayer::setDefaultSvgParams(), and QgsSvgMarkerSymbolLayerV2::setPath().

void QgsSvgCache::downloadProgress	(	qint64	bytesReceived,
		qint64	bytesTotal
	)

privateslot

Definition at line 743 of file qgssvgcache.cpp.

References QgsDebugMsg, statusChanged(), and tr.

Referenced by getImageData().

QByteArray QgsSvgCache::getImageData ( const QString & path ) const

Get image data.

Definition at line 238 of file qgssvgcache.cpp.

References downloadProgress(), instance(), QgsMessageLog::logMessage(), mMissingSvg, QgsDebugMsg, and tr.

Referenced by containsParams(), replaceParamsAndCacheSvg(), and QgsSVGFillSymbolLayer::setSvgFilePath().

QgsSvgCacheEntry * QgsSvgCache::insertSVG	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor
	)

protected

Creates new cache entry and returns pointer to it.

Parameters

file	Absolute or relative path to SVG file. If the path is relative the file is searched by QgsSymbolLayerV2Utils::symbolNameToPath() in SVG paths. in settings svg/searchPathsForSVG
size	size of cached image
fill	color of fill
outline	color of outline
outlineWidth	width of outline
widthScaleFactor	width scale factor
rasterScaleFactor	raster scale factor

Definition at line 168 of file qgssvgcache.cpp.

References mEntryLookup, mLeastRecentEntry, mMostRecentEntry, QgsSvgCacheEntry::nextEntry, QgsSvgCacheEntry::previousEntry, replaceParamsAndCacheSvg(), QgsSymbolLayerV2Utils::symbolNameToPath(), and trimToMaximumSize().

Referenced by cacheEntry().

QgsSvgCache * QgsSvgCache::instance ( )

static

Definition at line 84 of file qgssvgcache.cpp.

Referenced by QgsSVGFillSymbolLayer::applyPattern(), QgsSvgMarkerSymbolLayerV2::create(), getImageData(), QgsSvgMarkerSymbolLayerV2::renderPoint(), QgsSVGFillSymbolLayer::setDefaultSvgParams(), QgsSvgMarkerSymbolLayerV2::setPath(), and QgsSVGFillSymbolLayer::setSvgFilePath().

void QgsSvgCache::printEntryList ( )

private

For debugging.

Definition at line 682 of file qgssvgcache.cpp.

References QgsSvgCacheEntry::file, mLeastRecentEntry, mTotalSize, QgsSvgCacheEntry::nextEntry, QgsDebugMsg, QgsSvgCacheEntry::rasterScaleFactor, QgsSvgCacheEntry::size, and QgsSvgCacheEntry::widthScaleFactor.

void QgsSvgCache::removeCacheEntry	(	QString	s,
		QgsSvgCacheEntry *	entry
	)

private

Release memory and remove cache entry from mEntryLookup.

Definition at line 676 of file qgssvgcache.cpp.

References mEntryLookup.

void QgsSvgCache::replaceElemParams	(	QDomElement &	elem,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth
	)

private

Replaces parameters in elements of a dom node and calls method for all child nodes.

Definition at line 494 of file qgssvgcache.cpp.

Referenced by replaceParamsAndCacheSvg().

void QgsSvgCache::replaceParamsAndCacheSvg ( QgsSvgCacheEntry * entry )

protected

Definition at line 217 of file qgssvgcache.cpp.

References QgsSvgCacheEntry::file, QgsSvgCacheEntry::fill, getImageData(), mTotalSize, QgsSvgCacheEntry::outline, QgsSvgCacheEntry::outlineWidth, replaceElemParams(), and QgsSvgCacheEntry::svgContent.

Referenced by insertSVG().

void QgsSvgCache::statusChanged ( const QString & theStatusQString )

signal

Emit a signal to be caught by qgisapp and display a msg on status bar.

Referenced by downloadProgress().

const QImage & QgsSvgCache::svgAsImage	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor,
		bool &	fitsInCache
	)

Get SVG as QImage.

Parameters

file	Absolute or relative path to SVG file.
size	size of cached image
fill	color of fill
outline	color of outline
outlineWidth	width of outline
widthScaleFactor	width scale factor
rasterScaleFactor	raster scale factor
fitsInCache

Definition at line 109 of file qgssvgcache.cpp.

References cacheEntry(), cacheImage(), cachePicture(), QgsSvgCacheEntry::image, mMaximumSize, QgsSvgCacheEntry::picture, QgsSvgCacheEntry::size, QgsSvgCacheEntry::svgContent, and trimToMaximumSize().

Referenced by QgsSVGFillSymbolLayer::applyPattern(), and QgsSvgMarkerSymbolLayerV2::renderPoint().

const QPicture & QgsSvgCache::svgAsPicture	(	const QString &	file,
		double	size,
		const QColor &	fill,
		const QColor &	outline,
		double	outlineWidth,
		double	widthScaleFactor,
		double	rasterScaleFactor,
		bool	forceVectorOutput = `false`
	)

Get SVG as QPicture&.

Parameters

file	Absolute or relative path to SVG file.
size	size of cached image
fill	color of fill
outline	color of outline
outlineWidth	width of outline
widthScaleFactor	width scale factor
rasterScaleFactor	raster scale factor
forceVectorOutput