KisAsynchronousStrokeUpdateHelper Class Reference

#include <KisAsynchronousStrokeUpdateHelper.h>

Inheritance diagram for KisAsynchronousStrokeUpdateHelper:

Classes
class	UpdateData

Public Types
using	UpdateDataFactory = std::function<KisStrokeJobData*(bool)>

Public Member Functions
void	cancelUpdateStream ()
void	endUpdateStream ()
void	initUpdateStreamLowLevel (KisStrokesFacade *strokesFacade, KisStrokeId strokeId)
bool	isActive () const
	KisAsynchronousStrokeUpdateHelper ()
void	setCustomUpdateDataFactory (UpdateDataFactory factory)
void	startUpdateStream (KisStrokesFacade *strokesFacade, KisStrokeId strokeId)
void	startUpdateStreamLowLevel ()
	~KisAsynchronousStrokeUpdateHelper ()

Private Slots
void	slotAsyncUpdateCame (bool forceUpdate=false)

Private Attributes
UpdateDataFactory	m_customUpdateFactory
KisStrokeId	m_strokeId
KisStrokesFacade *	m_strokesFacade
QTimer	m_updateThresholdTimer

Detailed Description

Definition at line 20 of file KisAsynchronousStrokeUpdateHelper.h.

Member Typedef Documentation

UpdateDataFactory

using KisAsynchronousStrokeUpdateHelper::UpdateDataFactory = std::function<KisStrokeJobData*(bool)>

Definition at line 49 of file KisAsynchronousStrokeUpdateHelper.h.

Constructor & Destructor Documentation

KisAsynchronousStrokeUpdateHelper()

KisAsynchronousStrokeUpdateHelper::KisAsynchronousStrokeUpdateHelper

(

)

Definition at line 10 of file KisAsynchronousStrokeUpdateHelper.cpp.

    : m_strokesFacade(0)
{
    m_updateThresholdTimer.setSingleShot(false);
    m_updateThresholdTimer.setInterval(80 /* ms */);
    connect(&m_updateThresholdTimer, SIGNAL(timeout()), SLOT(slotAsyncUpdateCame()));
}

References connect(), m_updateThresholdTimer, and slotAsyncUpdateCame().

~KisAsynchronousStrokeUpdateHelper()

KisAsynchronousStrokeUpdateHelper::~KisAsynchronousStrokeUpdateHelper

(

)

Definition at line 18 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
 
}

Member Function Documentation

cancelUpdateStream()

void KisAsynchronousStrokeUpdateHelper::cancelUpdateStream

(

)

Definition at line 51 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(isActive());
 
    m_updateThresholdTimer.stop();
    m_strokeId.clear();
    m_strokesFacade = 0;
}

References isActive(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_strokeId, m_strokesFacade, and m_updateThresholdTimer.

endUpdateStream()

void KisAsynchronousStrokeUpdateHelper::endUpdateStream

(

)

Definition at line 43 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(isActive());
 
    slotAsyncUpdateCame(true);
    cancelUpdateStream();
}

References cancelUpdateStream(), isActive(), KIS_SAFE_ASSERT_RECOVER_RETURN, and slotAsyncUpdateCame().

initUpdateStreamLowLevel()

void KisAsynchronousStrokeUpdateHelper::initUpdateStreamLowLevel	(	KisStrokesFacade *	strokesFacade,
		KisStrokeId	strokeId )

A low-level version of startUpdateStream(...), initializes the helper but doesn't start the stream of update events. That is needed for the tool to issue endUpdateStream() signals, when the action has been ended before the stroke actually managed to initialize itself.

Definition at line 23 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    m_strokesFacade = strokesFacade;
    m_strokeId = strokeId;
}

References m_strokeId, and m_strokesFacade.

isActive()

bool KisAsynchronousStrokeUpdateHelper::isActive

(

)

const

Definition at line 60 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    return bool(m_strokeId);
}

References m_strokeId.

setCustomUpdateDataFactory()

void KisAsynchronousStrokeUpdateHelper::setCustomUpdateDataFactory

(

KisAsynchronousStrokeUpdateHelper::UpdateDataFactory

factory

)

Definition at line 65 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    m_customUpdateFactory = factory;
}

References m_customUpdateFactory.

slotAsyncUpdateCame

void KisAsynchronousStrokeUpdateHelper::slotAsyncUpdateCame ( bool forceUpdate = false )

privateslot

Definition at line 70 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    if (!m_strokeId || !m_strokesFacade) return;
    m_strokesFacade->addJob(m_strokeId,
                            m_customUpdateFactory ?
                                m_customUpdateFactory(forceUpdate) :
                                new UpdateData(forceUpdate));
}

References KisStrokesFacade::addJob(), m_customUpdateFactory, m_strokeId, and m_strokesFacade.

startUpdateStream()

void KisAsynchronousStrokeUpdateHelper::startUpdateStream	(	KisStrokesFacade *	strokesFacade,
		KisStrokeId	strokeId )

Initialize the update helper and start the steam of the update events. This is just a simple combination of initUpdateStreamLowLevel() and startUpdateStreamLowLevel().

Definition at line 37 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    initUpdateStreamLowLevel(strokesFacade, strokeId);
    startUpdateStreamLowLevel();
}

References initUpdateStreamLowLevel(), and startUpdateStreamLowLevel().

startUpdateStreamLowLevel()

void KisAsynchronousStrokeUpdateHelper::startUpdateStreamLowLevel

(

)

Start the stream of the update events on already initialized helper. One should call initUpdateStreamWithoutStart() before calling startUpdateStream().

Definition at line 29 of file KisAsynchronousStrokeUpdateHelper.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_strokesFacade);
    KIS_SAFE_ASSERT_RECOVER_RETURN(m_strokeId);
 
    m_updateThresholdTimer.start();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_strokeId, m_strokesFacade, and m_updateThresholdTimer.

Member Data Documentation

m_customUpdateFactory

UpdateDataFactory KisAsynchronousStrokeUpdateHelper::m_customUpdateFactory

private

Definition at line 93 of file KisAsynchronousStrokeUpdateHelper.h.

m_strokeId

KisStrokeId KisAsynchronousStrokeUpdateHelper::m_strokeId

private

Definition at line 92 of file KisAsynchronousStrokeUpdateHelper.h.

m_strokesFacade

KisStrokesFacade* KisAsynchronousStrokeUpdateHelper::m_strokesFacade

private

Definition at line 90 of file KisAsynchronousStrokeUpdateHelper.h.

m_updateThresholdTimer

QTimer KisAsynchronousStrokeUpdateHelper::m_updateThresholdTimer

private

Definition at line 91 of file KisAsynchronousStrokeUpdateHelper.h.

---

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

• libs/ui/tool/KisAsynchronousStrokeUpdateHelper.h
• libs/ui/tool/KisAsynchronousStrokeUpdateHelper.cpp