KisResourceThumbnailCache Class Reference

#include <KisResourceThumbnailCache.h>

Classes
struct	Private

Public Member Functions
QImage	getImage (const QModelIndex &index, const QSize size=QSize(-1, -1), Qt::AspectRatioMode aspectMode=Qt::IgnoreAspectRatio, Qt::TransformationMode transformMode=Qt::FastTransformation)
	KisResourceThumbnailCache ()
	~KisResourceThumbnailCache ()

Static Public Member Functions
static KisResourceThumbnailCache *	instance ()

Private Member Functions
void	insert (const QPair< QString, QString > &key, const QImage &image)
void	insert (const QString &storageLocation, const QString &resourceType, const QString &filename, const QImage &image)
QImage	originalImage (const QString &storageLocation, const QString &resourceType, const QString &filename) const
void	remove (const QPair< QString, QString > &key)
void	remove (const QString &storageLocation, const QString &resourceType, const QString &filename)

Private Attributes
QScopedPointer< Private >	m_d

Friends
class	KisResourceLocator
class	KisResourceQueryMapper
class	KisStorageModel

Detailed Description

Definition at line 17 of file KisResourceThumbnailCache.h.

Constructor & Destructor Documentation

KisResourceThumbnailCache()

KisResourceThumbnailCache::KisResourceThumbnailCache

(

)

Definition at line 112 of file KisResourceThumbnailCache.cpp.

    : m_d(new Private)
{
}

~KisResourceThumbnailCache()

KisResourceThumbnailCache::~KisResourceThumbnailCache

(

)

Definition at line 117 of file KisResourceThumbnailCache.cpp.

{
}

Member Function Documentation

getImage()

QImage KisResourceThumbnailCache::getImage	(	const QModelIndex &	index,
		const QSize	size = QSize(-1, -1),
		Qt::AspectRatioMode	aspectMode = Qt::IgnoreAspectRatio,
		Qt::TransformationMode	transformMode = Qt::FastTransformation )

Definition at line 167 of file KisResourceThumbnailCache.cpp.

{
    const QString storageLocation = KisResourceLocator::instance()->makeStorageLocationAbsolute(
        index.data(Qt::UserRole + KisAbstractResourceModel::Location).value<QString>());
    const QString resourceType =
        index.data(Qt::UserRole + KisAbstractResourceModel::ResourceType).value<QString>();
    const QString filename = index.data(Qt::UserRole + KisAbstractResourceModel::Filename).value<QString>();
 
    const ImageScalingParameters param = {size, aspectMode, transformMode};
 
    ResourceKey key = m_d->key(storageLocation, resourceType, filename);
 
    QImage result = m_d->getExactMatch(key, param);
    if (!result.isNull()) {
        return result;
    } else if (m_d->containsOriginal(key)) {
        result = m_d->getOriginal(key);
    } else {
        result = index.data(Qt::UserRole + KisAbstractResourceModel::Thumbnail).value<QImage>();
        // KisResourceQueryMapper should have inserted the image, so we don't have to.
        // Why there? Because most of the API usage for Thumbnail is going to be from index.data(), so we just
        // remove the dependency that our user has to know this class for just accessing the cached original
        // thumbnail.
        KIS_SAFE_ASSERT_RECOVER_NOOP(result.isNull() || m_d->containsOriginal(key));
    }
    // if the size that the has been demanded, we will then cache the size and then pass it.
    if (!result.isNull() && param.size.isValid()) {
        const QImage scaledImage = result.scaled(param.size, param.aspectRatioMode, param.transformationMode);
        if (m_d->scaledThumbnailCache.contains(key)) {
            m_d->scaledThumbnailCache[key].insert(param, scaledImage);
        } else {
            ThumbnailCacheT scaledCacheMap;
            scaledCacheMap.insert(param, scaledImage);
            m_d->scaledThumbnailCache.insert(key, scaledCacheMap);
        }
        return scaledImage;
    } else {
        return result;
    }
}

References KisAbstractResourceModel::Filename, KisResourceLocator::instance(), KIS_SAFE_ASSERT_RECOVER_NOOP, KisAbstractResourceModel::Location, m_d, KisResourceLocator::makeStorageLocationAbsolute(), KisAbstractResourceModel::ResourceType, and KisAbstractResourceModel::Thumbnail.

insert() [1/2]

void KisResourceThumbnailCache::insert ( const QPair< QString, QString > & key, const QImage & image )

private

Definition at line 140 of file KisResourceThumbnailCache.cpp.

{
    m_d->insertOriginal(key, image);
}

References m_d.

insert() [2/2]

void KisResourceThumbnailCache::insert ( const QString & storageLocation, const QString & resourceType, const QString & filename, const QImage & image )

private

Definition at line 129 of file KisResourceThumbnailCache.cpp.

{
    if (image.isNull()) {
        return;
    }
    insert(m_d->key(storageLocation, resourceType, filename), image);
}

References insert(), and m_d.

instance()

KisResourceThumbnailCache * KisResourceThumbnailCache::instance ( )

static

Definition at line 107 of file KisResourceThumbnailCache.cpp.

{
    return s_instance;
}

originalImage()

QImage KisResourceThumbnailCache::originalImage ( const QString & storageLocation, const QString & resourceType, const QString & filename ) const

private

Definition at line 121 of file KisResourceThumbnailCache.cpp.

{
    const ResourceKey key = m_d->key(storageLocation, resourceType, filename);
    return m_d->containsOriginal(key) ? m_d->getOriginal(key) : QImage();
}

References m_d.

remove() [1/2]

void KisResourceThumbnailCache::remove ( const QPair< QString, QString > & key )

private

Definition at line 152 of file KisResourceThumbnailCache.cpp.

{
    if (m_d->originalImageCache.contains(key)) {
        m_d->originalImageCache.remove(key);
 
        if (m_d->scaledThumbnailCache.contains(key)) {
            m_d->scaledThumbnailCache.remove(key);
        }
    } else {
        // Something must have gone wrong for thumbnail to exist in scaledThumbnailCache but not be in
        // original.
        KIS_ASSERT(!m_d->scaledThumbnailCache.contains(key));
    }
}

References KIS_ASSERT, and m_d.

remove() [2/2]

void KisResourceThumbnailCache::remove ( const QString & storageLocation, const QString & resourceType, const QString & filename )

private

Definition at line 145 of file KisResourceThumbnailCache.cpp.

{
    remove(m_d->key(storageLocation, resourceType, filename));
}

References m_d, and remove().

Friends And Related Symbol Documentation

KisResourceLocator

friend class KisResourceLocator

friend

Definition at line 32 of file KisResourceThumbnailCache.h.

KisResourceQueryMapper

friend class KisResourceQueryMapper

friend

Definition at line 31 of file KisResourceThumbnailCache.h.

KisStorageModel

friend class KisStorageModel

friend

Definition at line 33 of file KisResourceThumbnailCache.h.

Member Data Documentation

m_d

QScopedPointer<Private> KisResourceThumbnailCache::m_d

private

Definition at line 50 of file KisResourceThumbnailCache.h.

---

The documentation for this class was generated from the following files:

• libs/resources/KisResourceThumbnailCache.h
• libs/resources/KisResourceThumbnailCache.cpp