mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
47683fca4f
This change is being driven by: - need for consistent terminology in the api. Currently there's a confusing mix of border/outline used - need for consistent terminology in the gui - we have a mix of "border"/"outline"/"pen" - bringing QGIS into line with the standard terminology used in other graphic editing programs
182 lines
8.6 KiB
Plaintext
182 lines
8.6 KiB
Plaintext
class QgsSvgCacheEntry
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgssvgcache.h>
|
|
%End
|
|
|
|
public:
|
|
QgsSvgCacheEntry();
|
|
/** Constructor.
|
|
* @param file Absolute path to SVG file (relative paths are not resolved).
|
|
* @param size
|
|
* @param strokeWidth width of stroke
|
|
* @param widthScaleFactor width scale factor
|
|
* @param rasterScaleFactor raster scale factor
|
|
* @param fill color of fill
|
|
* @param stroke color of stroke
|
|
* @param lookupKey the key string used in QgsSvgCache for quick lookup of this entry (relative or absolute path)
|
|
*/
|
|
QgsSvgCacheEntry( const QString& file, double size, double strokeWidth, double widthScaleFactor, const QColor& fill, const QColor& stroke, const QString& lookupKey = QString() );
|
|
~QgsSvgCacheEntry();
|
|
|
|
//! Absolute path to SVG file
|
|
QString file;
|
|
//! Lookup key used by QgsSvgCache's hashtable (relative or absolute path). Needed for removal from the hashtable
|
|
QString lookupKey;
|
|
double size; //size in pixels (cast to int for QImage)
|
|
double strokeWidth;
|
|
double widthScaleFactor;
|
|
|
|
/** SVG viewbox size.
|
|
* @note added in QGIS 2.14
|
|
*/
|
|
QSizeF viewboxSize;
|
|
|
|
QColor fill;
|
|
QColor stroke;
|
|
QImage* image;
|
|
QPicture* picture;
|
|
//content (with params replaced)
|
|
QByteArray svgContent;
|
|
|
|
//keep entries on a least, sorted by last access
|
|
QgsSvgCacheEntry* nextEntry;
|
|
QgsSvgCacheEntry* previousEntry;
|
|
|
|
/** Don't consider image, picture, last used timestamp for comparison*/
|
|
bool operator==( const QgsSvgCacheEntry& other ) const;
|
|
/** Return memory usage in bytes*/
|
|
int dataSize() const;
|
|
|
|
private:
|
|
|
|
QgsSvgCacheEntry( const QgsSvgCacheEntry& rh );
|
|
};
|
|
|
|
/** 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)"*/
|
|
class QgsSvgCache : QObject
|
|
{
|
|
%TypeHeaderCode
|
|
#include <qgssvgcache.h>
|
|
%End
|
|
|
|
public:
|
|
|
|
QgsSvgCache( QObject * parent /TransferThis/ = 0 );
|
|
|
|
~QgsSvgCache();
|
|
|
|
/** Get SVG as QImage.
|
|
* @param file Absolute or relative path to SVG file.
|
|
* @param size size of cached image
|
|
* @param fill color of fill
|
|
* @param stroke color of stroke
|
|
* @param strokeWidth width of stroke
|
|
* @param widthScaleFactor width scale factor
|
|
* @param rasterScaleFactor raster scale factor
|
|
* @param fitsInCache
|
|
*/
|
|
QImage svgAsImage( const QString& file, double size, const QColor& fill, const QColor& stroke, double strokeWidth,
|
|
double widthScaleFactor, bool& fitsInCache );
|
|
/** Get SVG as QPicture&.
|
|
* @param file Absolute or relative path to SVG file.
|
|
* @param size size of cached image
|
|
* @param fill color of fill
|
|
* @param stroke color of stroke
|
|
* @param strokeWidth width of stroke
|
|
* @param widthScaleFactor width scale factor
|
|
* @param rasterScaleFactor raster scale factor
|
|
* @param forceVectorOutput
|
|
*/
|
|
QPicture svgAsPicture( const QString& file, double size, const QColor& fill, const QColor& stroke, double strokeWidth,
|
|
double widthScaleFactor, bool forceVectorOutput = false );
|
|
|
|
/** Calculates the viewbox size of a (possibly cached) SVG file.
|
|
* @param file Absolute or relative path to SVG file.
|
|
* @param size size of cached image
|
|
* @param fill color of fill
|
|
* @param stroke color of stroke
|
|
* @param strokeWidth width of stroke
|
|
* @param widthScaleFactor width scale factor
|
|
* @param rasterScaleFactor raster scale factor
|
|
* @returns viewbox size set in SVG file
|
|
* @note added in QGIS 2.14
|
|
*/
|
|
QSizeF svgViewboxSize( const QString& file, double size, const QColor& fill, const QColor& stroke, double strokeWidth,
|
|
double widthScaleFactor );
|
|
|
|
/** Tests if an svg file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several
|
|
default values in the svg file, only the first one is considered*/
|
|
void containsParams( const QString& path, bool& hasFillParam, QColor& defaultFillColor, bool& hasStrokeParam, QColor& defaultStrokeColor, bool& hasStrokeWidthParam,
|
|
double& defaultStrokeWidth ) const;
|
|
|
|
/** Tests if an svg file contains parameters for fill, stroke color, stroke width. If yes, possible default values are returned. If there are several
|
|
* default values in the svg file, only the first one is considered.
|
|
* @param path path to SVG file
|
|
* @param hasFillParam will be true if fill param present in SVG
|
|
* @param hasDefaultFillParam will be true if fill param has a default value specified
|
|
* @param defaultFillColor will be set to default fill color specified in SVG, if present
|
|
* @param hasFillOpacityParam will be true if fill opacity param present in SVG
|
|
* @param hasDefaultFillOpacity will be true if fill opacity param has a default value specified
|
|
* @param defaultFillOpacity will be set to default fill opacity specified in SVG, if present
|
|
* @param hasStrokeParam will be true if stroke param present in SVG
|
|
* @param hasDefaultStrokeColor will be true if stroke param has a default value specified
|
|
* @param defaultStrokeColor will be set to default stroke color specified in SVG, if present
|
|
* @param hasStrokeWidthParam will be true if stroke width param present in SVG
|
|
* @param hasDefaultStrokeWidth will be true if stroke width param has a default value specified
|
|
* @param defaultStrokeWidth will be set to default stroke width specified in SVG, if present
|
|
* @param hasStrokeOpacityParam will be true if stroke opacity param present in SVG
|
|
* @param hasDefaultStrokeOpacity will be true if stroke opacity param has a default value specified
|
|
* @param defaultStrokeOpacity will be set to default stroke opacity specified in SVG, if present
|
|
* @note available in python bindings as containsParamsV3
|
|
* @note added in QGIS 2.14
|
|
*/
|
|
void containsParams( const QString& path, bool& hasFillParam, bool& hasDefaultFillParam, QColor& defaultFillColor,
|
|
bool& hasFillOpacityParam, bool& hasDefaultFillOpacity, double& defaultFillOpacity,
|
|
bool& hasStrokeParam, bool& hasDefaultStrokeColor, QColor& defaultStrokeColor,
|
|
bool& hasStrokeWidthParam, bool& hasDefaultStrokeWidth, double& defaultStrokeWidth,
|
|
bool& hasStrokeOpacityParam, bool& hasDefaultStrokeOpacity, double& defaultStrokeOpacity ) const /PyName=containsParamsV3/;
|
|
|
|
/** Get image data*/
|
|
QByteArray getImageData( const QString &path ) const;
|
|
|
|
/** Get SVG content*/
|
|
QByteArray svgContent( const QString& file, double size, const QColor& fill, const QColor& stroke, double strokeWidth,
|
|
double widthScaleFactor );
|
|
|
|
signals:
|
|
/** Emit a signal to be caught by qgisapp and display a msg on status bar */
|
|
void statusChanged( const QString& statusQString );
|
|
|
|
protected:
|
|
|
|
/** Creates new cache entry and returns pointer to it
|
|
* @param file Absolute or relative path to SVG file. If the path is relative the file is searched by QgsSymbolLayerUtils::symbolNameToPath() in SVG paths.
|
|
* in settings svg/searchPathsForSVG
|
|
* @param size size of cached image
|
|
* @param fill color of fill
|
|
* @param stroke color of stroke
|
|
* @param strokeWidth width of stroke
|
|
* @param widthScaleFactor width scale factor
|
|
* @param rasterScaleFactor raster scale factor
|
|
*/
|
|
QgsSvgCacheEntry* insertSVG( const QString& file, double size, const QColor& fill, const QColor& stroke, double strokeWidth,
|
|
double widthScaleFactor );
|
|
|
|
void replaceParamsAndCacheSvg( QgsSvgCacheEntry* entry );
|
|
void cacheImage( QgsSvgCacheEntry* entry );
|
|
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& file, double size, const QColor& fill, const QColor& stroke, double strokeWidth,
|
|
double widthScaleFactor );
|
|
|
|
/** Removes the least used items until the maximum size is under the limit*/
|
|
void trimToMaximumSize();
|
|
|
|
//Removes entry from the ordered list (but does not delete the entry itself)
|
|
void takeEntryFromList( QgsSvgCacheEntry* entry );
|
|
|
|
};
|