KisAnimationCachePopulator Class Reference

#include <kis_animation_cache_populator.h>

Inheritance diagram for KisAnimationCachePopulator:

Classes
struct	Private

Public Slots
void	slotRequestRegeneration ()

Public Member Functions
	KisAnimationCachePopulator (KisPart *part)
bool	regenerate (KisAnimationFrameCacheSP cache, int frame)
void	requestRegenerationWithPriorityFrame (KisImageSP image, int frameIndex)
	~KisAnimationCachePopulator () override

Private Slots
void	slotConfigChanged ()
void	slotRegeneratorFrameCancelled ()
void	slotRegeneratorFrameReady ()
void	slotTimer ()

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Definition at line 15 of file kis_animation_cache_populator.h.

Constructor & Destructor Documentation

KisAnimationCachePopulator()

KisAnimationCachePopulator::KisAnimationCachePopulator

(

KisPart *

part

)

Definition at line 336 of file kis_animation_cache_populator.cpp.

    : m_d(new Private(this, part))
{
    connect(&m_d->timer, SIGNAL(timeout()), this, SLOT(slotTimer()));
 
    connect(&m_d->regenerator, SIGNAL(sigFrameCancelled(int, KisAsyncAnimationRendererBase::CancelReason)), SLOT(slotRegeneratorFrameCancelled()));
    connect(&m_d->regenerator, SIGNAL(sigFrameCompleted(int)), SLOT(slotRegeneratorFrameReady()));
 
    connect(KisConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(slotConfigChanged()));
    slotConfigChanged();
}

References connect(), KisConfigNotifier::instance(), m_d, slotConfigChanged(), slotRegeneratorFrameCancelled(), slotRegeneratorFrameReady(), and slotTimer().

~KisAnimationCachePopulator()

KisAnimationCachePopulator::~KisAnimationCachePopulator ( )

override

Definition at line 348 of file kis_animation_cache_populator.cpp.

{
    m_d->priorityFrames.clear();
}

References m_d.

Member Function Documentation

regenerate()

bool KisAnimationCachePopulator::regenerate	(	KisAnimationFrameCacheSP	cache,
		int	frame )

Request generation of given frame. The request will be ignored if the populator is already requesting a frame.

Returns

true if generation requested, false if busy

Definition at line 353 of file kis_animation_cache_populator.cpp.

{
    return m_d->regenerate(cache, frame);
}

References m_d.

requestRegenerationWithPriorityFrame()

void KisAnimationCachePopulator::requestRegenerationWithPriorityFrame	(	KisImageSP	image,
		int	frameIndex )

Definition at line 358 of file kis_animation_cache_populator.cpp.

{
    if (!m_d->calculateAnimationCacheInBackground) return;
    if (!KisAnimationFrameCache::cacheForImage(image)) return;
    if (!image->animationInterface()->hasAnimation()) return;
 
    m_d->priorityFrames.append(qMakePair(image, frameIndex));
 
    if (m_d->state == Private::NotWaitingForAnything) {
        m_d->generateIfIdle();
    }
}

References KisImage::animationInterface(), KisAnimationFrameCache::cacheForImage(), KisImageAnimationInterface::hasAnimation(), m_d, and KisAnimationCachePopulator::Private::NotWaitingForAnything.

slotConfigChanged

void KisAnimationCachePopulator::slotConfigChanged ( )

privateslot

Definition at line 395 of file kis_animation_cache_populator.cpp.

{
    KisConfig cfg(true);
    m_d->calculateAnimationCacheInBackground = cfg.calculateAnimationCacheInBackground();
    QTimer::singleShot(1000, Qt::CoarseTimer, this, SLOT(slotRequestRegeneration()));
}

References KisConfig::calculateAnimationCacheInBackground(), m_d, and slotRequestRegeneration().

slotRegeneratorFrameCancelled

void KisAnimationCachePopulator::slotRegeneratorFrameCancelled ( )

privateslot

Definition at line 384 of file kis_animation_cache_populator.cpp.

{
    KIS_ASSERT_RECOVER_RETURN(m_d->state == Private::WaitingForFrame);
    m_d->enterState(Private::NotWaitingForAnything);
}

References KIS_ASSERT_RECOVER_RETURN, m_d, KisAnimationCachePopulator::Private::NotWaitingForAnything, and KisAnimationCachePopulator::Private::WaitingForFrame.

slotRegeneratorFrameReady

void KisAnimationCachePopulator::slotRegeneratorFrameReady ( )

privateslot

Definition at line 390 of file kis_animation_cache_populator.cpp.

{
    m_d->enterState(Private::BetweenFrames);
}

References KisAnimationCachePopulator::Private::BetweenFrames, and m_d.

slotRequestRegeneration

void KisAnimationCachePopulator::slotRequestRegeneration ( )

slot

Definition at line 376 of file kis_animation_cache_populator.cpp.

{
    // skip if the user forbade background regeneration
    if (!m_d->calculateAnimationCacheInBackground) return;
 
    m_d->enterState(Private::WaitingForIdle);
}

References m_d, and KisAnimationCachePopulator::Private::WaitingForIdle.

slotTimer

void KisAnimationCachePopulator::slotTimer ( )

privateslot

Definition at line 371 of file kis_animation_cache_populator.cpp.

{
    m_d->timerTimeout();
}

References m_d.

Member Data Documentation

m_d

QScopedPointer<Private> KisAnimationCachePopulator::m_d

private

Definition at line 44 of file kis_animation_cache_populator.h.

---

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

• libs/ui/kis_animation_cache_populator.h
• libs/ui/kis_animation_cache_populator.cpp