mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-09 00:35:20 -05:00
84838d1ec6
This new class QgsImageCache is the equivalent of QgsSvgCache but for raster images. QgsImageCache stores pre-rendered resampled versions of raster image files, allowing efficient reuse without incurring the cost of resampling on every render. Additionally, it offers the other benefits QgsSvgCache has, such as thread safety, ability to transparently download remote images, and support for base64 encoded strings.
72 lines
2.6 KiB
Plaintext
72 lines
2.6 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsimagecache.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class QgsImageCache : QgsAbstractContentCacheBase
|
|
{
|
|
%Docstring
|
|
A cache for images derived from raster files.
|
|
|
|
QgsImageCache stores pre-rendered resampled versions of raster image files, allowing efficient
|
|
reuse without incurring the cost of resampling on every render.
|
|
|
|
QgsImageCache is not usually directly created, but rather accessed through
|
|
:py:func:`QgsApplication.imageCache()`
|
|
|
|
.. versionadded:: 3.6
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsimagecache.h"
|
|
%End
|
|
public:
|
|
|
|
QgsImageCache( QObject *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsImageCache, with the specified ``parent`` object.
|
|
%End
|
|
|
|
QImage pathAsImage( const QString &path, QSize size, bool keepAspectRatio, bool &fitsInCache /Out/ );
|
|
%Docstring
|
|
Returns the specified ``path`` rendered as an image. If possible, a pre-existing cached
|
|
version of the image will be used. If not, the image is fetched and resampled to the desired
|
|
size, and then the result cached for subsequent lookups.
|
|
|
|
``path`` may be a local file, remote (HTTP) url, or a base 64 encoded string (with a "base64:" prefix).
|
|
|
|
The ``size`` parameter dictates the target size of the image. An invalid size indicates the
|
|
original raster image size (with no resampling).
|
|
|
|
If ``keepAspectRatio`` is true, then the original raster aspect ratio will be maintained during
|
|
any resampling operations.
|
|
|
|
If the resultant raster was of a sufficiently small size to store in the cache, then ``fitsInCache``
|
|
will be set to true.
|
|
%End
|
|
|
|
signals:
|
|
|
|
void remoteImageFetched( const QString &url );
|
|
%Docstring
|
|
Emitted when the cache has finished retrieving an image file from a remote ``url``.
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsimagecache.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
|
|
************************************************************************/
|