#include <KisStabilizerDelayedPaintHelper.h>

Inheritance diagram for KisStabilizerDelayedPaintHelper:

Classes
struct	TimedPaintInfo

Public Member Functions
void	cancel ()

void	end ()

bool	hasLastPaintInformation () const

	KisStabilizerDelayedPaintHelper ()

KisPaintInformation	lastPaintInformation () const

void	paintSome ()

bool	running () const

void	setPaintLineCallback (std::function< void(const KisPaintInformation &, const KisPaintInformation &)> paintLine)

void	setUpdateOutlineCallback (std::function< void()> requestUpdateOutline)

void	start (const KisPaintInformation &firstPaintInfo)

void	update (const QVector< KisPaintInformation > &newPaintInfos)

	~KisStabilizerDelayedPaintHelper () override

Private Slots
void	stabilizerDelayedPaintTimer ()

Private Attributes
QElapsedTimer	m_elapsedTimer

int	m_lastPaintTime {0}

int	m_lastPendingTime {0}

std::function< void(const KisPaintInformation &, const KisPaintInformation &)	m_paintLine )

QQueue< TimedPaintInfo >	m_paintQueue

QTimer	m_paintTimer

std::function< void()>	m_requestUpdateOutline

Detailed Description

Definition at line 20 of file KisStabilizerDelayedPaintHelper.h.

Constructor & Destructor Documentation

◆ KisStabilizerDelayedPaintHelper()

KisStabilizerDelayedPaintHelper::KisStabilizerDelayedPaintHelper ( )

Definition at line 17 of file KisStabilizerDelayedPaintHelper.cpp.

{
    connect(&m_paintTimer, SIGNAL(timeout()), SLOT(stabilizerDelayedPaintTimer()));
}

References connect(), m_paintTimer, and stabilizerDelayedPaintTimer().

◆ ~KisStabilizerDelayedPaintHelper()

KisStabilizerDelayedPaintHelper::~KisStabilizerDelayedPaintHelper ( )

inlineoverride

Definition at line 43 of file KisStabilizerDelayedPaintHelper.h.

43{}

Member Function Documentation

◆ cancel()

void KisStabilizerDelayedPaintHelper::cancel ( )

Definition at line 73 of file KisStabilizerDelayedPaintHelper.cpp.

                                             {
    m_paintTimer.stop();
    m_paintQueue.clear();
}

References m_paintQueue, and m_paintTimer.

◆ end()

void KisStabilizerDelayedPaintHelper::end ( )

Definition at line 59 of file KisStabilizerDelayedPaintHelper.cpp.

                                          {
    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;
    }
}

References m_elapsedTimer, m_paintLine, m_paintQueue, m_paintTimer, and KisStabilizerDelayedPaintHelper::TimedPaintInfo::paintInfo.

◆ hasLastPaintInformation()

bool KisStabilizerDelayedPaintHelper::hasLastPaintInformation ( ) const

inline

Definition at line 49 of file KisStabilizerDelayedPaintHelper.h.

                                         {
        return !m_paintQueue.isEmpty();
    }

◆ lastPaintInformation()

KisPaintInformation KisStabilizerDelayedPaintHelper::lastPaintInformation ( ) const

inline

Definition at line 53 of file KisStabilizerDelayedPaintHelper.h.

                                                     {
        // Please call hasLastPaintInformation before this
        return m_paintQueue.head().paintInfo;
    }

◆ paintSome()

void KisStabilizerDelayedPaintHelper::paintSome ( )

Definition at line 45 of file KisStabilizerDelayedPaintHelper.cpp.

                                                {
    // 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);
    }
}

References m_elapsedTimer, m_lastPaintTime, m_paintLine, m_paintQueue, and KisStabilizerDelayedPaintHelper::TimedPaintInfo::paintInfo.

◆ running()

bool KisStabilizerDelayedPaintHelper::running ( ) const

inline

Definition at line 45 of file KisStabilizerDelayedPaintHelper.h.

                         {
        return m_paintTimer.isActive();
    }

◆ setPaintLineCallback()

void KisStabilizerDelayedPaintHelper::setPaintLineCallback ( std::function< void(const KisPaintInformation &, const KisPaintInformation &)> paintLine )

inline

Definition at line 58 of file KisStabilizerDelayedPaintHelper.h.

                                                                                                                     {
        m_paintLine = paintLine;
    }

◆ setUpdateOutlineCallback()

void KisStabilizerDelayedPaintHelper::setUpdateOutlineCallback ( std::function< void()> requestUpdateOutline )

inline

Definition at line 62 of file KisStabilizerDelayedPaintHelper.h.

                                                                            {
        m_requestUpdateOutline = requestUpdateOutline;
    }

◆ stabilizerDelayedPaintTimer

void KisStabilizerDelayedPaintHelper::stabilizerDelayedPaintTimer ( )

privateslot

Definition at line 78 of file KisStabilizerDelayedPaintHelper.cpp.

                                                                  {
    if (m_elapsedTimer.elapsed() - m_lastPaintTime < fixedPaintTimerInterval) {
        return;
    }
    paintSome();
    // Explicitly update the outline because this is outside the pointer event
    m_requestUpdateOutline();
}

References fixedPaintTimerInterval, m_elapsedTimer, m_lastPaintTime, m_requestUpdateOutline, and paintSome().

◆ start()

void KisStabilizerDelayedPaintHelper::start ( const KisPaintInformation & firstPaintInfo )

Definition at line 22 of file KisStabilizerDelayedPaintHelper.cpp.

                                                                                     {
    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));
}

References cancel(), fixedPaintTimerInterval, m_elapsedTimer, m_lastPaintTime, m_lastPendingTime, m_paintQueue, m_paintTimer, and running().

◆ update()

void KisStabilizerDelayedPaintHelper::update ( const QVector< KisPaintInformation > & newPaintInfos )

Definition at line 34 of file KisStabilizerDelayedPaintHelper.cpp.

                                                                                              {
    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;
}

References m_elapsedTimer, m_lastPendingTime, and m_paintQueue.

Member Data Documentation

◆ m_elapsedTimer

QElapsedTimer KisStabilizerDelayedPaintHelper::m_elapsedTimer

private

Definition at line 35 of file KisStabilizerDelayedPaintHelper.h.

◆ m_lastPaintTime

int KisStabilizerDelayedPaintHelper::m_lastPaintTime {0}

private

Definition at line 34 of file KisStabilizerDelayedPaintHelper.h.

34{0};

◆ m_lastPendingTime

int KisStabilizerDelayedPaintHelper::m_lastPendingTime {0}

private

Definition at line 33 of file KisStabilizerDelayedPaintHelper.h.

33{0};

◆ m_paintLine

std::function<void(const KisPaintInformation &, const KisPaintInformation &) KisStabilizerDelayedPaintHelper::m_paintLine)

private

Definition at line 38 of file KisStabilizerDelayedPaintHelper.h.

◆ m_paintQueue

QQueue<TimedPaintInfo> KisStabilizerDelayedPaintHelper::m_paintQueue

private

Definition at line 32 of file KisStabilizerDelayedPaintHelper.h.

◆ m_paintTimer

QTimer KisStabilizerDelayedPaintHelper::m_paintTimer

private

Definition at line 31 of file KisStabilizerDelayedPaintHelper.h.

◆ m_requestUpdateOutline

std::function<void()> KisStabilizerDelayedPaintHelper::m_requestUpdateOutline

private

Definition at line 39 of file KisStabilizerDelayedPaintHelper.h.

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

libs/ui/tool/KisStabilizerDelayedPaintHelper.h
libs/ui/tool/KisStabilizerDelayedPaintHelper.cpp

Classes

Public Member Functions

Private Slots

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisStabilizerDelayedPaintHelper()

◆ ~KisStabilizerDelayedPaintHelper()

Member Function Documentation

◆ cancel()

◆ end()

◆ hasLastPaintInformation()

◆ lastPaintInformation()

◆ paintSome()

◆ running()

◆ setPaintLineCallback()

◆ setUpdateOutlineCallback()

◆ stabilizerDelayedPaintTimer

◆ start()

◆ update()

Member Data Documentation

◆ m_elapsedTimer

◆ m_lastPaintTime

◆ m_lastPendingTime

◆ m_paintLine

◆ m_paintQueue

◆ m_paintTimer

◆ m_requestUpdateOutline