KisStabilizerDelayedPaintHelper.cpp

Go to the documentation of this file.

/*
 *  SPDX-FileCopyrightText: 2016 Alvin Wong <alvinhochun-at-gmail-com>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#include "KisStabilizerDelayedPaintHelper.h"
 
constexpr int fixedPaintTimerInterval = 20;
 
KisStabilizerDelayedPaintHelper::TimedPaintInfo::TimedPaintInfo(int elapsedTime, KisPaintInformation paintInfo)
    : elapsedTime(elapsedTime)
    , paintInfo(paintInfo)
{
}
 
KisStabilizerDelayedPaintHelper::KisStabilizerDelayedPaintHelper()
{
    connect(&m_paintTimer, SIGNAL(timeout()), SLOT(stabilizerDelayedPaintTimer()));
}
 
void KisStabilizerDelayedPaintHelper::start(const KisPaintInformation &firstPaintInfo) {
    if (running()) {
        cancel();
    }
    m_paintTimer.setInterval(fixedPaintTimerInterval);
    m_paintTimer.start();
    m_elapsedTimer.start();
    m_lastPendingTime = m_elapsedTimer.elapsed();
    m_lastPaintTime = m_lastPendingTime;
    m_paintQueue.enqueue(TimedPaintInfo(m_lastPendingTime, firstPaintInfo));
}
 
void KisStabilizerDelayedPaintHelper::update(const QVector<KisPaintInformation> &newPaintInfos) {
    int now = m_elapsedTimer.elapsed();
    int delayedPaintInterval = m_elapsedTimer.elapsed() - m_lastPendingTime;
    for (int i = 0; i < newPaintInfos.size(); i++) {
        // TODO: Risk of overflowing?
        int offsetTime = (delayedPaintInterval * i) / newPaintInfos.size();
        m_paintQueue.enqueue(TimedPaintInfo(now + offsetTime, newPaintInfos[i]));
    }
    m_lastPendingTime = now;
}
 
void KisStabilizerDelayedPaintHelper::paintSome() {
    // This function is also called from KisToolFreehandHelper::paint
    m_lastPaintTime = m_elapsedTimer.elapsed();
    if (m_paintQueue.isEmpty()) {
        return;
    }
    int now = m_lastPaintTime;
    // Always keep one in the queue since painting requires two points
    while (m_paintQueue.size() > 1 && m_paintQueue.head().elapsedTime <= now) {
        const TimedPaintInfo dequeued = m_paintQueue.dequeue();
        m_paintLine(dequeued.paintInfo, m_paintQueue.head().paintInfo);
    }
}
 
void KisStabilizerDelayedPaintHelper::end() {
    m_paintTimer.stop();
    m_elapsedTimer.invalidate();
    if (m_paintQueue.isEmpty()) {
        return;
    }
    TimedPaintInfo dequeued = m_paintQueue.dequeue();
    while (!m_paintQueue.isEmpty()) {
        const TimedPaintInfo dequeued2 = m_paintQueue.dequeue();
        m_paintLine(dequeued.paintInfo, dequeued2.paintInfo);
        dequeued = dequeued2;
    }
}
 
void KisStabilizerDelayedPaintHelper::cancel() {
    m_paintTimer.stop();
    m_paintQueue.clear();
}
 
void KisStabilizerDelayedPaintHelper::stabilizerDelayedPaintTimer() {
    if (m_elapsedTimer.elapsed() - m_lastPaintTime < fixedPaintTimerInterval) {
        return;
    }
    paintSome();
    // Explicitly update the outline because this is outside the pointer event
    m_requestUpdateOutline();
}