CanvasPlaybackEnvironment Class Reference

PlaybackEnvironment (Private) Constructs and deconstructs the necessary viewing conditions when animation playback begins and ends. This includes disabling and enabling onion skins based on playback condition and other such tasks. Also keeps track of original origin frame of initial play command, so play/pause can work while stop will always return to the origin of playback (where the user first pressed play from the stopped state.) More...

Inheritance diagram for CanvasPlaybackEnvironment:

Signals
void	sigPlaybackStatisticsUpdated ()

Public Member Functions
	CanvasPlaybackEnvironment ()=delete
	CanvasPlaybackEnvironment (const CanvasPlaybackEnvironment &)=delete
	CanvasPlaybackEnvironment (int originFrame, KisCanvas2 *canvas, KisCanvasAnimationState *parent=nullptr)
CanvasPlaybackEnvironment &	operator= (const CanvasPlaybackEnvironment &)=delete
int	originFrame ()
KisTimeSpan	playbackRange () const
void	prepare ()
void	restore ()
void	setPlaybackRange (KisTimeSpan p_playbackRange)
	~CanvasPlaybackEnvironment ()

Private Attributes
KisSignalAutoConnectionsStore	m_cancelStrokeConnections
SingleShotSignal	m_cancelTrigger
KisCanvas2 *	m_canvas
QVector< KisNodeWSP >	m_disabledDecoratedNodes
int	m_originFrame
	The frame user started playback from.
KisTimeSpan	m_playbackRange

Detailed Description

PlaybackEnvironment (Private) Constructs and deconstructs the necessary viewing conditions when animation playback begins and ends. This includes disabling and enabling onion skins based on playback condition and other such tasks. Also keeps track of original origin frame of initial play command, so play/pause can work while stop will always return to the origin of playback (where the user first pressed play from the stopped state.)

Definition at line 87 of file KisCanvasAnimationState.cpp.

Constructor & Destructor Documentation

CanvasPlaybackEnvironment() [1/3]

CanvasPlaybackEnvironment::CanvasPlaybackEnvironment ( int originFrame, KisCanvas2 * canvas, KisCanvasAnimationState * parent = nullptr )

inline

Definition at line 90 of file KisCanvasAnimationState.cpp.

        : QObject(parent)
        , m_originFrame(originFrame)
        , m_canvas(canvas)
    {
        connect(&m_cancelTrigger, SIGNAL(output()), parent, SIGNAL(sigCancelPlayback()));
 
        prepare();
    }

References connect(), m_cancelTrigger, and prepare().

~CanvasPlaybackEnvironment()

CanvasPlaybackEnvironment::~CanvasPlaybackEnvironment ( )

inline

Definition at line 100 of file KisCanvasAnimationState.cpp.

                                 {
        restore();
    }

References restore().

CanvasPlaybackEnvironment() [2/3]

CanvasPlaybackEnvironment::CanvasPlaybackEnvironment ( )

delete

CanvasPlaybackEnvironment() [3/3]

CanvasPlaybackEnvironment::CanvasPlaybackEnvironment ( const CanvasPlaybackEnvironment & )

delete

Member Function Documentation

operator=()

CanvasPlaybackEnvironment & CanvasPlaybackEnvironment::operator= ( const CanvasPlaybackEnvironment & )

delete

originFrame()

int CanvasPlaybackEnvironment::originFrame ( )

inline

Definition at line 108 of file KisCanvasAnimationState.cpp.

{ return m_originFrame; }

References m_originFrame.

playbackRange()

KisTimeSpan CanvasPlaybackEnvironment::playbackRange ( ) const

inline

Definition at line 110 of file KisCanvasAnimationState.cpp.

                                      {
        return m_playbackRange;
    }

References m_playbackRange.

prepare()

void CanvasPlaybackEnvironment::prepare ( )

inline

Definition at line 118 of file KisCanvasAnimationState.cpp.

    {
        KIS_ASSERT(m_canvas); // Sanity check...
 
        const KisTimeSpan range = m_canvas->image()->animationInterface()->activePlaybackRange();
        setPlaybackRange(range);
 
        // Initialize and optimize playback environment...
        if (m_canvas->frameCache()) {
            KisImageConfig cfg(true);
 
            const int dimensionLimit = cfg.useAnimationCacheFrameSizeLimit() ?
                        cfg.animationCacheFrameSizeLimit() : std::numeric_limits<int>::max();
 
            const int largestDimension = KisAlgebra2D::maxDimension(m_canvas->image()->bounds());
 
            const QRect regionOfInterest =
                        cfg.useAnimationCacheRegionOfInterest() && largestDimension > dimensionLimit ?
                            m_canvas->regionOfInterest() : m_canvas->coordinatesConverter()->imageRectInImagePixels();
 
            const QRect minimalRect =
                    m_canvas->coordinatesConverter()->widgetRectInImagePixels().toAlignedRect() &
                    m_canvas->coordinatesConverter()->imageRectInImagePixels();
 
            m_canvas->frameCache()->dropLowQualityFrames(range, regionOfInterest, minimalRect);
            m_canvas->setRenderingLimit(regionOfInterest);
 
            // Preemptively cache all frames...
            KisAsyncAnimationCacheRenderDialog dlg(m_canvas->frameCache(), range);
            dlg.setRegionOfInterest(regionOfInterest);
            dlg.regenerateRange(m_canvas->viewManager());
        } else {
            KisImageBarrierLock lock(m_canvas->image());
            KisLayerUtils::recursiveApplyNodes(m_canvas->image()->root(), [this](KisNodeSP node){
                KisDecoratedNodeInterface* decoratedNode = dynamic_cast<KisDecoratedNodeInterface*>(node.data());
                if (decoratedNode && decoratedNode->decorationsVisible()) {
                    decoratedNode->setDecorationsVisible(false, false);
                    m_disabledDecoratedNodes.append(node);
                }
            });
        }
 
        // Setup appropriate interrupt connections...
        m_cancelStrokeConnections.addConnection(
                m_canvas->image().data(), SIGNAL(sigUndoDuringStrokeRequested()),
                &m_cancelTrigger, SLOT(tryFire()));
 
        m_cancelStrokeConnections.addConnection(
                m_canvas->image().data(), SIGNAL(sigStrokeCancellationRequested()),
                &m_cancelTrigger, SLOT(tryFire()));
 
        // We only want to stop on stroke end when running on a system
        // without cache / opengl / graphics driver support!
        if (m_canvas->frameCache()) {
            m_cancelStrokeConnections.addConnection(
                    m_canvas->image().data(), SIGNAL(sigStrokeEndRequested()),
                    &m_cancelTrigger, SLOT(tryFire()));
        }
    }

References KisImageAnimationInterface::activePlaybackRange(), KisImageConfig::animationCacheFrameSizeLimit(), KisImage::animationInterface(), KisImage::bounds(), KisCanvas2::coordinatesConverter, KisAnimationFrameCache::dropLowQualityFrames(), KisCanvas2::frameCache, KisCanvas2::image(), KisCoordinatesConverter::imageRectInImagePixels(), KIS_ASSERT, m_canvas, KisAlgebra2D::maxDimension(), KisLayerUtils::recursiveApplyNodes(), KisAsyncAnimationRenderDialogBase::regenerateRange(), KisCanvas2::regionOfInterest, KisNodeFacade::root, setPlaybackRange(), KisAsyncAnimationRenderDialogBase::setRegionOfInterest(), KisCanvas2::setRenderingLimit(), KisImageConfig::useAnimationCacheFrameSizeLimit(), KisImageConfig::useAnimationCacheRegionOfInterest(), KisCanvas2::viewManager(), and KisCoordinatesConverter::widgetRectInImagePixels().

restore()

void CanvasPlaybackEnvironment::restore ( )

inline

Definition at line 178 of file KisCanvasAnimationState.cpp.

                   {
        m_cancelStrokeConnections.clear();
 
        if (m_canvas) {
            if (m_canvas->frameCache()) {
                m_canvas->setRenderingLimit(QRect());
            } else {
                KisImageBarrierLock lock(m_canvas->image());
                Q_FOREACH(KisNodeWSP disabledNode, m_disabledDecoratedNodes) {
                    KisDecoratedNodeInterface* decoratedNode = dynamic_cast<KisDecoratedNodeInterface*>(disabledNode.data());
                    if (decoratedNode) {
                        decoratedNode->setDecorationsVisible(true, true);
                    }
                }
                m_disabledDecoratedNodes.clear();
            }
        }
    }

References KisWeakSharedPtr< T >::data(), and KisDecoratedNodeInterface::setDecorationsVisible().

setPlaybackRange()

void CanvasPlaybackEnvironment::setPlaybackRange ( KisTimeSpan p_playbackRange )

inline

Definition at line 114 of file KisCanvasAnimationState.cpp.

                                                       {
        m_playbackRange = p_playbackRange;
    }

References m_playbackRange.

sigPlaybackStatisticsUpdated

void CanvasPlaybackEnvironment::sigPlaybackStatisticsUpdated ( )

signal

Member Data Documentation

m_cancelStrokeConnections

KisSignalAutoConnectionsStore CanvasPlaybackEnvironment::m_cancelStrokeConnections

private

Definition at line 202 of file KisCanvasAnimationState.cpp.

m_cancelTrigger

SingleShotSignal CanvasPlaybackEnvironment::m_cancelTrigger

private

Definition at line 203 of file KisCanvasAnimationState.cpp.

m_canvas

KisCanvas2* CanvasPlaybackEnvironment::m_canvas

private

Definition at line 206 of file KisCanvasAnimationState.cpp.

m_disabledDecoratedNodes

QVector<KisNodeWSP> CanvasPlaybackEnvironment::m_disabledDecoratedNodes

private

Definition at line 204 of file KisCanvasAnimationState.cpp.

m_originFrame

int CanvasPlaybackEnvironment::m_originFrame

private

The frame user started playback from.

Definition at line 201 of file KisCanvasAnimationState.cpp.

m_playbackRange

KisTimeSpan CanvasPlaybackEnvironment::m_playbackRange

private

Definition at line 208 of file KisCanvasAnimationState.cpp.

---

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

• libs/ui/canvas/KisCanvasAnimationState.cpp