KisAsyncAnimationCacheRenderDialog Class Reference

#include <KisAsyncAnimationCacheRenderDialog.h>

Inheritance diagram for KisAsyncAnimationCacheRenderDialog:

Classes
struct	Private

Public Member Functions
	KisAsyncAnimationCacheRenderDialog (KisAnimationFrameCacheSP cache, const KisTimeSpan &range, int busyWait=200)
virtual	~KisAsyncAnimationCacheRenderDialog ()
Public Member Functions inherited from KisAsyncAnimationRenderDialogBase
bool	batchMode () const
	KisAsyncAnimationRenderDialogBase (const QString &actionTitle, KisImageSP image, int busyWait=200)
	construct and initialize the dialog
virtual Result	regenerateRange (KisViewManager *viewManager)
	start generation of frames and (if not in batch mode) show the dialog
KisRegion	regionOfInterest () const
void	setBatchMode (bool value)
	setting batch mode to true will prevent any dialogs or message boxes from showing on screen. Please take it into account that using batch mode prevents some potentially dangerous recovery execution paths (e.g. delete the existing frames in the destination folder). In such case the rendering will be stopped with RenderFailed result.
void	setRegionOfInterest (const KisRegion &roi)
virtual	~KisAsyncAnimationRenderDialogBase ()

Static Public Member Functions
static int	calcFirstDirtyFrame (KisAnimationFrameCacheSP cache, const KisTimeSpan &playbackRange, const KisTimeSpan &skipRange)

Protected Member Functions
QList< int >	calcDirtyFrames () const override
	returns a list of frames that should be regenerated by the dialog
KisAsyncAnimationRendererBase *	createRenderer (KisImageSP image) override
	create a renderer object linked to image
void	initializeRendererForFrame (KisAsyncAnimationRendererBase *renderer, KisImageSP image, int frame) override

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Public Types inherited from KisAsyncAnimationRenderDialogBase
enum	Result { RenderComplete , RenderCancelled , RenderFailed , RenderTimedOut }

Detailed Description

Definition at line 14 of file KisAsyncAnimationCacheRenderDialog.h.

Constructor & Destructor Documentation

KisAsyncAnimationCacheRenderDialog()

KisAsyncAnimationCacheRenderDialog::KisAsyncAnimationCacheRenderDialog	(	KisAnimationFrameCacheSP	cache,
		const KisTimeSpan &	range,
		int	busyWait = 200 )

Definition at line 103 of file KisAsyncAnimationCacheRenderDialog.cpp.

    : KisAsyncAnimationRenderDialogBase(i18n("Regenerating cache..."), cache->image(), busyWait),
      m_d(new Private(cache, range))
{
}

~KisAsyncAnimationCacheRenderDialog()

KisAsyncAnimationCacheRenderDialog::~KisAsyncAnimationCacheRenderDialog ( )

virtual

Definition at line 109 of file KisAsyncAnimationCacheRenderDialog.cpp.

{
 
}

Member Function Documentation

calcDirtyFrames()

QList< int > KisAsyncAnimationCacheRenderDialog::calcDirtyFrames ( ) const

overrideprotectedvirtual

returns a list of frames that should be regenerated by the dialog

Called by the dialog in the very beginning of regenerateRange()

Implements KisAsyncAnimationRenderDialogBase.

Definition at line 114 of file KisAsyncAnimationCacheRenderDialog.cpp.

{
    return calcDirtyFramesList(m_d->cache, m_d->range);
}

References m_d.

calcFirstDirtyFrame()

int KisAsyncAnimationCacheRenderDialog::calcFirstDirtyFrame ( KisAnimationFrameCacheSP cache, const KisTimeSpan & playbackRange, const KisTimeSpan & skipRange )

static

Definition at line 56 of file KisAsyncAnimationCacheRenderDialog.cpp.

{
    int result = -1;
 
    KisImageSP image = cache->image();
    if (!image) return result;
 
    KisImageAnimationInterface *animation = image->animationInterface();
    if (!animation->hasAnimation()) return result;
 
    if (playbackRange.isValid()) {
        KIS_ASSERT_RECOVER_RETURN_VALUE(!playbackRange.isInfinite(), result);
 
        // TODO: optimize check for fully-cached case
        for (int frame = playbackRange.start(); frame <= playbackRange.end(); frame++) {
            if (skipRange.contains(frame)) {
                if (skipRange.isInfinite()) {
                    break;
                } else {
                    frame = skipRange.end();
                    continue;
                }
            }
 
            if (cache->frameStatus(frame) != KisAnimationFrameCache::Cached) {
                result = frame;
                break;
            }
        }
    }
 
    return result;
}

References KisImage::animationInterface(), KisAnimationFrameCache::Cached, KisTimeSpan::contains(), KisTimeSpan::end(), KisAnimationFrameCache::frameStatus(), KisImageAnimationInterface::hasAnimation(), KisAnimationFrameCache::image(), KisTimeSpan::isInfinite(), KisTimeSpan::isValid(), KIS_ASSERT_RECOVER_RETURN_VALUE, and KisTimeSpan::start().

createRenderer()

KisAsyncAnimationRendererBase * KisAsyncAnimationCacheRenderDialog::createRenderer ( KisImageSP image )

overrideprotectedvirtual

create a renderer object linked to image

Renderer are special objects that connect to the individual image signals, react on them and fetch the final frames data

See also

KisAsyncAnimationRendererBase

Implements KisAsyncAnimationRenderDialogBase.

Definition at line 119 of file KisAsyncAnimationCacheRenderDialog.cpp.

{
    Q_UNUSED(image);
    return new KisAsyncAnimationCacheRenderer();
}

initializeRendererForFrame()

void KisAsyncAnimationCacheRenderDialog::initializeRendererForFrame ( KisAsyncAnimationRendererBase * renderer, KisImageSP image, int frame )

overrideprotectedvirtual

Implements KisAsyncAnimationRenderDialogBase.

Definition at line 125 of file KisAsyncAnimationCacheRenderDialog.cpp.

{
    Q_UNUSED(image);
    Q_UNUSED(frame);
 
    KisAsyncAnimationCacheRenderer *cacheRenderer =
        dynamic_cast<KisAsyncAnimationCacheRenderer*>(renderer);
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(cacheRenderer);
 
    cacheRenderer->setFrameCache(m_d->cache);
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_d, and KisAsyncAnimationCacheRenderer::setFrameCache().

Member Data Documentation

m_d

const QScopedPointer<Private> KisAsyncAnimationCacheRenderDialog::m_d

private

Definition at line 30 of file KisAsyncAnimationCacheRenderDialog.h.

---

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

• libs/ui/dialogs/KisAsyncAnimationCacheRenderDialog.h
• libs/ui/dialogs/KisAsyncAnimationCacheRenderDialog.cpp