KisFrameDisplayProxy Class Reference

The KisFrameDisplayProxy class sits between the KisCanvas (within its KisCanvasAnimationState) and its associated KisImage. Its mainly responsible for choosing whether to reproject the image (always accurate) OR reuse the canvas' KisAnimationFrameCache (usually fast). :) More...

#include <KisFrameDisplayProxy.h>

Inheritance diagram for KisFrameDisplayProxy:

Signals
void	sigFrameChange ()
void	sigFrameDisplayRefreshed ()
void	sigFrameRefreshSkipped ()
	sigFrameRefreshSkipped tracks whether asynchronous "slow" refreshes are skipped due to the frame being the same. In the case of waiting for next frame to render, it is necessary to let any binding classes know that the there was no need to refresh the display at all.

Public Member Functions
int	activeFrame () const
	Gets the active frame, the frame that is intended to be shown. This should always reflect the actual time position of the canvas at any given point. In certain circumstances this value can be different from what is currently being shown. (For example, when showing the activeKeyframe instead.)
bool	displayFrame (int frame, bool forceReproject)
	Tell the DisplayProxy to show a new frame.
	KisFrameDisplayProxy (class KisCanvas2 *canvas, QObject *parent=nullptr)
	~KisFrameDisplayProxy ()

Private Member Functions
int	activeKeyframe () const
	Get the active keyframe. This is the latest unique frame that is actually visible. It is not always the same as the position of playback, since it only changes when there's new content to be shown. (Consider "held" frames.)
bool	needsReprojection (KisAnimationFrameCacheSP cache, int from, int to)
bool	shouldUploadFrame (KisAnimationFrameCacheSP cache, int from, int to)

Private Attributes
QScopedPointer< struct Private >	m_d

Detailed Description

The KisFrameDisplayProxy class sits between the KisCanvas (within its KisCanvasAnimationState) and its associated KisImage. Its mainly responsible for choosing whether to reproject the image (always accurate) OR reuse the canvas' KisAnimationFrameCache (usually fast). :)

Definition at line 21 of file KisFrameDisplayProxy.h.

Constructor & Destructor Documentation

KisFrameDisplayProxy()

KisFrameDisplayProxy::KisFrameDisplayProxy	(	class KisCanvas2 *	canvas,
		QObject *	parent = nullptr )

Definition at line 25 of file KisFrameDisplayProxy.cpp.

    : QObject(parent)
    , m_d(new Private(canvas))
{
    KIS_ASSERT(canvas);
 
    connect(m_d->canvas->image()->animationInterface(), &KisImageAnimationInterface::sigFrameRegenerated, this, [this](int frame){
        if (m_d->intendedFrame != frame ) {
            // We only want to correct our intended frame when the image regenerates
            // and we're not currently in playback. (In other words, when the state of the image
            // is determined by external time controls.)
            KisCanvasAnimationState* state = m_d->canvas->animationState();
            if (state->playbackState() != PLAYING) {
                m_d->intendedFrame = frame;
                Q_EMIT sigFrameChange();
            }
        }
 
        if (m_d->displayedFrame != frame) {
            m_d->displayedFrame = frame;
            Q_EMIT sigFrameDisplayRefreshed();
        }
    });
 
 
    connect(m_d->canvas->image()->animationInterface(), &KisImageAnimationInterface::sigFrameRegenerationSkipped, this, [this](int frame){
       if (m_d->intendedFrame != frame) {
           //TODO make below a method?
           KisCanvasAnimationState* state = m_d->canvas->animationState();
           if (state->playbackState() != PLAYING) {
               m_d->intendedFrame = frame;
               Q_EMIT sigFrameChange();
           }
       }
 
       Q_EMIT sigFrameRefreshSkipped();
    });
 
    m_d->displayedFrame = m_d->canvas->image()->animationInterface()->currentUITime();
    m_d->intendedFrame = m_d->displayedFrame;
}

References connect(), KIS_ASSERT, m_d, and KisImageAnimationInterface::sigFrameRegenerated().

~KisFrameDisplayProxy()

KisFrameDisplayProxy::~KisFrameDisplayProxy

(

)

Definition at line 67 of file KisFrameDisplayProxy.cpp.

{
}

Member Function Documentation

activeFrame()

int KisFrameDisplayProxy::activeFrame

(

)

const

Gets the active frame, the frame that is intended to be shown. This should always reflect the actual time position of the canvas at any given point. In certain circumstances this value can be different from what is currently being shown. (For example, when showing the activeKeyframe instead.)

Definition at line 108 of file KisFrameDisplayProxy.cpp.

{
    return m_d->intendedFrame;
}

References m_d.

activeKeyframe()

int KisFrameDisplayProxy::activeKeyframe ( ) const

private

Get the active keyframe. This is the latest unique frame that is actually visible. It is not always the same as the position of playback, since it only changes when there's new content to be shown. (Consider "held" frames.)

Definition at line 113 of file KisFrameDisplayProxy.cpp.

{
    return m_d->displayedFrame;
}

References m_d.

displayFrame()

bool KisFrameDisplayProxy::displayFrame	(	int	frame,
		bool	forceReproject )

Tell the DisplayProxy to show a new frame.

Parameters

forceReproject

demands that the image used instead of the canvas' animation cache.

Definition at line 71 of file KisFrameDisplayProxy.cpp.

{
    KisAnimationFrameCacheSP cache = m_d->canvas->frameCache();
    KisImageAnimationInterface* ai = m_d->canvas->image()->animationInterface();
 
    if (frame != m_d->intendedFrame) {
        m_d->intendedFrame = frame;
        Q_EMIT sigFrameChange();
    }
 
    if (forceReproject || needsReprojection(cache, m_d->displayedFrame, frame)) {
        // BUG:445265
        // Edgecase occurs where if we move from a cached frame to a non-cached frame,
        // we never technically "switch" to the cached one during scrubbing, which
        // will prevent the uncached frame from ever determining it needs to be
        // regenerated. We will force a frame switch when going from uncached to cached
        // to work around this issue.
        ai->switchCurrentTimeAsync(frame, KisImageAnimationInterface::STAO_FORCE_REGENERATION);
        return true;
 
    } else if ( shouldUploadFrame(cache, m_d->displayedFrame, frame) && cache->uploadFrame(frame) ) {
        m_d->canvas->updateCanvas();
        m_d->displayedFrame = frame;
        Q_EMIT sigFrameDisplayRefreshed();
        return true;
 
    } else if (!cache && ai->hasAnimation() && ai->currentUITime() != frame){
        if (m_d->canvas->image()->tryBarrierLock(true)) {
            m_d->canvas->image()->unlock();
            ai->switchCurrentTimeAsync(frame);
            return true;
        }
    }
 
    return false;
}

References KisImage::animationInterface(), KisImageAnimationInterface::currentUITime(), KisImageAnimationInterface::hasAnimation(), KisImageAnimationInterface::image(), m_d, needsReprojection(), shouldUploadFrame(), sigFrameChange(), sigFrameDisplayRefreshed(), KisImageAnimationInterface::STAO_FORCE_REGENERATION, KisImageAnimationInterface::switchCurrentTimeAsync(), and KisAnimationFrameCache::uploadFrame().

needsReprojection()

bool KisFrameDisplayProxy::needsReprojection ( KisAnimationFrameCacheSP cache, int from, int to )

private

Definition at line 123 of file KisFrameDisplayProxy.cpp.

{
    return cache && cache->frameStatus(from) != cache->frameStatus(to);
}

References KisAnimationFrameCache::frameStatus().

shouldUploadFrame()

bool KisFrameDisplayProxy::shouldUploadFrame ( KisAnimationFrameCacheSP cache, int from, int to )

private

Definition at line 118 of file KisFrameDisplayProxy.cpp.

{
    return cache && cache->shouldUploadNewFrame(to, from);
}

References KisAnimationFrameCache::shouldUploadNewFrame().

sigFrameChange

void KisFrameDisplayProxy::sigFrameChange ( )

signal

sigFrameDisplayRefreshed

void KisFrameDisplayProxy::sigFrameDisplayRefreshed ( )

signal

sigFrameRefreshSkipped

void KisFrameDisplayProxy::sigFrameRefreshSkipped ( )

signal

sigFrameRefreshSkipped tracks whether asynchronous "slow" refreshes are skipped due to the frame being the same. In the case of waiting for next frame to render, it is necessary to let any binding classes know that the there was no need to refresh the display at all.

Member Data Documentation

m_d

QScopedPointer<struct Private> KisFrameDisplayProxy::m_d

private

Definition at line 63 of file KisFrameDisplayProxy.h.

---

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

• libs/ui/animation/KisFrameDisplayProxy.h
• libs/ui/animation/KisFrameDisplayProxy.cpp