qgsmaprenderercache.h

Go to the documentation of this file.

/***************************************************************************
  qgsmaprenderercache.h
  --------------------------------------
  Date                 : December 2013
  Copyright            : (C) 2013 by Martin Dobias
  Email                : wonder dot sk at gmail dot 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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSMAPRENDERERCACHE_H
#define QGSMAPRENDERERCACHE_H
 
#include "qgis_core.h"
#include "qgsmaplayer.h"
#include "qgsmaptopixel.h"
#include "qgsrectangle.h"
 
#include <QImage>
#include <QMap>
#include <QMutex>

class CORE_EXPORT QgsMapRendererCache : public QObject
{
    Q_OBJECT
  public:
    QgsMapRendererCache();

    void clear();

    Q_DECL_DEPRECATED bool init( const QgsRectangle &extent, double scale ) SIP_DEPRECATED;

    bool updateParameters( const QgsRectangle &extent, const QgsMapToPixel &mtp );

    void setCacheImage( const QString &cacheKey, const QImage &image, const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >() );

    void setCacheImageWithParameters(
      const QString &cacheKey, const QImage &image, const QgsRectangle &extent, const QgsMapToPixel &mapToPixel, const QList< QgsMapLayer * > &dependentLayers = QList< QgsMapLayer * >()
    );

    bool hasCacheImage( const QString &cacheKey ) const;

    bool hasAnyCacheImage( const QString &cacheKey, double minimumScaleThreshold = 0, double maximumScaleThreshold = 0 ) const;

    QImage cacheImage( const QString &cacheKey ) const;

    QImage transformedCacheImage( const QString &cacheKey, const QgsMapToPixel &mtp ) const;

    QList< QgsMapLayer * > dependentLayers( const QString &cacheKey ) const;

    void clearCacheImage( const QString &cacheKey );

    void invalidateCacheForLayer( QgsMapLayer *layer );
 
  private slots:
    void layerRequestedRepaint();
 
  private:
    struct CacheParameters
    {
        QImage cachedImage;
        QgsWeakMapLayerPointerList dependentLayers;
        QgsRectangle cachedExtent;
        QgsMapToPixel cachedMtp;
    };

    void clearInternal();

    void dropUnusedConnections();
 
    QSet< QgsWeakMapLayerPointer > dependentLayers() const;
 
    mutable QMutex mMutex;
    QgsRectangle mExtent;
    QgsMapToPixel mMtp;
 
    double mScale = -1.0; //DEPRECATED

    QMap<QString, CacheParameters> mCachedImages;
    QSet< QgsWeakMapLayerPointer > mConnectedLayers;
};
 
 
#endif // QGSMAPRENDERERCACHE_H