KisSimpleStrokeStrategy Class Reference

#include <kis_simple_stroke_strategy.h>

Inheritance diagram for KisSimpleStrokeStrategy:

Public Types
enum	JobType {   JOB_INIT = 0 , JOB_CANCEL , JOB_FINISH , JOB_DOSTROKE ,   JOB_SUSPEND , JOB_RESUME , NJOBS }

Public Member Functions
virtual void	cancelStrokeCallback ()
KisStrokeJobData *	createCancelData () override
KisStrokeJobStrategy *	createCancelStrategy () override
KisStrokeJobStrategy *	createDabStrategy () override
KisStrokeJobData *	createFinishData () override
KisStrokeJobStrategy *	createFinishStrategy () override
KisStrokeJobData *	createInitData () override
KisStrokeJobStrategy *	createInitStrategy () override
KisStrokeJobData *	createResumeData () override
KisStrokeJobStrategy *	createResumeStrategy () override
KisStrokeJobData *	createSuspendData () override
KisStrokeJobStrategy *	createSuspendStrategy () override
virtual void	doStrokeCallback (KisStrokeJobData *data)
virtual void	finishStrokeCallback ()
virtual void	initStrokeCallback ()
	KisSimpleStrokeStrategy (const QLatin1String &id, const KUndo2MagicString &name=KUndo2MagicString())
virtual void	resumeStrokeCallback ()
virtual void	suspendStrokeCallback ()
Public Member Functions inherited from KisStrokeStrategy
qreal	balancingRatioOverride () const
bool	canForgetAboutMe () const
bool	clearsRedoOnStart () const
virtual KisStrokeStrategy *	createLodClone (int levelOfDetail)
KisLodPreferences	currentLodPreferences () const
bool	forceLodModeIfPossible () const
QString	id () const
bool	isAsynchronouslyCancellable () const
bool	isExclusive () const
	KisStrokeStrategy (const QLatin1String &id, const KUndo2MagicString &name=KUndo2MagicString())
KUndo2MagicString	name () const
bool	needsExplicitCancel () const
virtual void	notifyUserEndedStroke ()
virtual void	notifyUserStartedStroke ()
bool	requestsOtherStrokesToEnd () const
void	setForceLodModeIfPossible (bool forceLodModeIfPossible)
void	setMutatedJobsInterface (KisStrokesQueueMutatedJobInterface *mutatedJobsInterface, KisStrokeId strokeId)
bool	supportsWrapAroundMode () const
virtual void	tryCancelCurrentStrokeJobAsync ()
	tryCancelCurrentStrokeJobAsync is called by the strokes queue when the stroke is being cancelled. The stroke strategy may or may not handle this request and cancel the currently running long action.
virtual	~KisStrokeStrategy ()

Static Public Member Functions
static QLatin1String	jobTypeToString (JobType type)

Protected Member Functions
void	enableJob (JobType type, bool enable=true, KisStrokeJobData::Sequentiality sequentiality=KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::Exclusivity exclusivity=KisStrokeJobData::NORMAL)
	KisSimpleStrokeStrategy (const KisSimpleStrokeStrategy &rhs)
Protected Member Functions inherited from KisStrokeStrategy
void	addMutatedJob (KisStrokeJobData *data)
void	addMutatedJobs (const QVector< KisStrokeJobData * > list)
	KisStrokeStrategy (const KisStrokeStrategy &rhs)
void	setAsynchronouslyCancellable (bool value)
void	setBalancingRatioOverride (qreal value)
void	setCanForgetAboutMe (bool value)
void	setClearsRedoOnStart (bool value)
void	setExclusive (bool value)
void	setNeedsExplicitCancel (bool value)
void	setRequestsOtherStrokesToEnd (bool value)
void	setSupportsWrapAroundMode (bool value)

Private Member Functions
KisStrokeJobData *	createData (JobType type)
KisStrokeJobStrategy *	createStrategy (JobType type)

Private Attributes
QVector< bool >	m_jobEnabled
QVector< KisStrokeJobData::Exclusivity >	m_jobExclusivity
QVector< KisStrokeJobData::Sequentiality >	m_jobSequentiality

Detailed Description

Definition at line 15 of file kis_simple_stroke_strategy.h.

Member Enumeration Documentation

JobType

enum KisSimpleStrokeStrategy::JobType

Enumerator
JOB_INIT
JOB_CANCEL
JOB_FINISH
JOB_DOSTROKE
JOB_SUSPEND
JOB_RESUME
NJOBS

Definition at line 18 of file kis_simple_stroke_strategy.h.

                 {
        JOB_INIT = 0,
        JOB_CANCEL,
        JOB_FINISH,
        JOB_DOSTROKE,
        JOB_SUSPEND,
        JOB_RESUME,
 
        NJOBS
    };

Constructor & Destructor Documentation

KisSimpleStrokeStrategy() [1/2]

KisSimpleStrokeStrategy::KisSimpleStrokeStrategy	(	const QLatin1String &	id,
		const KUndo2MagicString &	name = KUndo2MagicString() )

Definition at line 68 of file kis_simple_stroke_strategy.cpp.

    : KisStrokeStrategy(id, name),
      m_jobEnabled(NJOBS, false),
      m_jobSequentiality(NJOBS, KisStrokeJobData::SEQUENTIAL),
      m_jobExclusivity(NJOBS, KisStrokeJobData::NORMAL)
{
}

KisSimpleStrokeStrategy() [2/2]

KisSimpleStrokeStrategy::KisSimpleStrokeStrategy ( const KisSimpleStrokeStrategy & rhs )

protected

Definition at line 76 of file kis_simple_stroke_strategy.cpp.

    : KisStrokeStrategy(rhs),
      m_jobEnabled(rhs.m_jobEnabled),
      m_jobSequentiality(rhs.m_jobSequentiality),
      m_jobExclusivity(rhs.m_jobExclusivity)
{
}

Member Function Documentation

cancelStrokeCallback()

void KisSimpleStrokeStrategy::cancelStrokeCallback ( )

virtual

Reimplemented in StrategyWithStatusPromise, KisRegenerateFrameStrokeStrategy, KisStrokeStrategyUndoCommandBased, KisSuspendProjectionUpdatesStrokeStrategy, KisColorizeStrokeStrategy, KisCloneDocumentStroke, KisFilterStrokeStrategy, KisPainterBasedStrokeStrategy, MoveStrokeStrategy, NotificationStroke, MoveSelectionStrokeStrategy, InplaceTransformStrokeStrategy, and TransformStrokeStrategy.

Definition at line 176 of file kis_simple_stroke_strategy.cpp.

{
}

createCancelData()

KisStrokeJobData * KisSimpleStrokeStrategy::createCancelData ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 153 of file kis_simple_stroke_strategy.cpp.

{
    return createData(JOB_CANCEL);
}

References createData(), and JOB_CANCEL.

createCancelStrategy()

KisStrokeJobStrategy * KisSimpleStrokeStrategy::createCancelStrategy ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 115 of file kis_simple_stroke_strategy.cpp.

{
    return createStrategy(JOB_CANCEL);
}

References createStrategy(), and JOB_CANCEL.

createDabStrategy()

KisStrokeJobStrategy * KisSimpleStrokeStrategy::createDabStrategy ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 120 of file kis_simple_stroke_strategy.cpp.

{
    return createStrategy(JOB_DOSTROKE);
}

References createStrategy(), and JOB_DOSTROKE.

createData()

KisStrokeJobData * KisSimpleStrokeStrategy::createData ( JobType type )

private

Definition at line 135 of file kis_simple_stroke_strategy.cpp.

{
    KisStrokeJobData::Sequentiality sequentiality = m_jobSequentiality[(int)type];
    KisStrokeJobData::Exclusivity exclusivity = m_jobExclusivity[(int)type];
 
    return new KisStrokeJobData(sequentiality, exclusivity);
}

References m_jobExclusivity, and m_jobSequentiality.

createFinishData()

KisStrokeJobData * KisSimpleStrokeStrategy::createFinishData ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 148 of file kis_simple_stroke_strategy.cpp.

{
    return createData(JOB_FINISH);
}

References createData(), and JOB_FINISH.

createFinishStrategy()

KisStrokeJobStrategy * KisSimpleStrokeStrategy::createFinishStrategy ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 110 of file kis_simple_stroke_strategy.cpp.

{
    return createStrategy(JOB_FINISH);
}

References createStrategy(), and JOB_FINISH.

createInitData()

KisStrokeJobData * KisSimpleStrokeStrategy::createInitData ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 143 of file kis_simple_stroke_strategy.cpp.

{
    return createData(JOB_INIT);
}

References createData(), and JOB_INIT.

createInitStrategy()

KisStrokeJobStrategy * KisSimpleStrokeStrategy::createInitStrategy ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 105 of file kis_simple_stroke_strategy.cpp.

{
    return createStrategy(JOB_INIT);
}

References createStrategy(), and JOB_INIT.

createResumeData()

KisStrokeJobData * KisSimpleStrokeStrategy::createResumeData ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 163 of file kis_simple_stroke_strategy.cpp.

{
    return createData(JOB_RESUME);
}

References createData(), and JOB_RESUME.

createResumeStrategy()

KisStrokeJobStrategy * KisSimpleStrokeStrategy::createResumeStrategy ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 130 of file kis_simple_stroke_strategy.cpp.

{
    return createStrategy(JOB_RESUME);
}

References createStrategy(), and JOB_RESUME.

createStrategy()

KisStrokeJobStrategy * KisSimpleStrokeStrategy::createStrategy ( JobType type )

private

Definition at line 94 of file kis_simple_stroke_strategy.cpp.

{
    KisStrokeJobStrategy *strategy = 0;
 
    if(m_jobEnabled[(int)type]) {
        strategy = new SimpleStrokeJobStrategy(type, this);
    }
 
    return strategy;
}

References m_jobEnabled.

createSuspendData()

KisStrokeJobData * KisSimpleStrokeStrategy::createSuspendData ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 158 of file kis_simple_stroke_strategy.cpp.

{
    return createData(JOB_SUSPEND);
}

References createData(), and JOB_SUSPEND.

createSuspendStrategy()

KisStrokeJobStrategy * KisSimpleStrokeStrategy::createSuspendStrategy ( )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 125 of file kis_simple_stroke_strategy.cpp.

{
    return createStrategy(JOB_SUSPEND);
}

References createStrategy(), and JOB_SUSPEND.

doStrokeCallback()

void KisSimpleStrokeStrategy::doStrokeCallback ( KisStrokeJobData * data )

virtual

Reimplemented in KisRegenerateFrameStrokeStrategy, KisStrokeStrategyUndoCommandBased, KisSuspendProjectionUpdatesStrokeStrategy, KisRunnableBasedStrokeStrategy, FreehandStrokeStrategy, KisColorSamplerStrokeStrategy, KisFilterStrokeStrategy, MoveStrokeStrategy, HistogramComputationStrokeStrategy, MoveSelectionStrokeStrategy, InplaceTransformStrokeStrategy, and TransformStrokeStrategy.

Definition at line 180 of file kis_simple_stroke_strategy.cpp.

{
    Q_UNUSED(data);
}

enableJob()

void KisSimpleStrokeStrategy::enableJob ( JobType type, bool enable = true, KisStrokeJobData::Sequentiality sequentiality = KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::Exclusivity exclusivity = KisStrokeJobData::NORMAL )

protected

Definition at line 84 of file kis_simple_stroke_strategy.cpp.

{
    m_jobEnabled[(int)type] = enable;
    m_jobSequentiality[(int)type] = sequentiality;
    m_jobExclusivity[(int)type] = exclusivity;
}

References m_jobEnabled, m_jobExclusivity, and m_jobSequentiality.

finishStrokeCallback()

void KisSimpleStrokeStrategy::finishStrokeCallback ( )

virtual

Reimplemented in StrategyWithStatusPromise, KisRegenerateFrameStrokeStrategy, KisStrokeStrategyUndoCommandBased, KisCloneDocumentStroke, KisIdleTaskStrokeStrategy, FreehandStrokeStrategy, KisFilterStrokeStrategy, KisPainterBasedStrokeStrategy, MoveStrokeStrategy, HistogramComputationStrokeStrategy, MoveSelectionStrokeStrategy, InplaceTransformStrokeStrategy, and TransformStrokeStrategy.

Definition at line 172 of file kis_simple_stroke_strategy.cpp.

{
}

initStrokeCallback()

void KisSimpleStrokeStrategy::initStrokeCallback ( )

virtual

Reimplemented in KisRegenerateFrameStrokeStrategy, KisStrokeStrategyUndoCommandBased, KisSuspendProjectionUpdatesStrokeStrategy, KisSwitchTimeStrokeStrategy, KisSyncLodCacheStrokeStrategy, KisColorizeStrokeStrategy, KisCloneDocumentStroke, KisIdleTaskStrokeStrategy, KisImageThumbnailStrokeStrategyBase, ThumbnailsStroke, FreehandStrokeStrategy, KisFilterStrokeStrategy, KisPainterBasedStrokeStrategy, MoveStrokeStrategy, NotificationStroke, HistogramComputationStrokeStrategy, MoveSelectionStrokeStrategy, InplaceTransformStrokeStrategy, and TransformStrokeStrategy.

Definition at line 168 of file kis_simple_stroke_strategy.cpp.

{
}

jobTypeToString()

QLatin1String KisSimpleStrokeStrategy::jobTypeToString ( KisSimpleStrokeStrategy::JobType type )

static

Definition at line 193 of file kis_simple_stroke_strategy.cpp.

{
    QLatin1String result;
 
    switch (type) {
    case JOB_INIT:
        result = QLatin1String("init");
        break;
    case JOB_DOSTROKE:
        result = QLatin1String("dostroke");
        break;
    case JOB_FINISH:
        result = QLatin1String("finish");
        break;
    case JOB_CANCEL:
        result = QLatin1String("cancel");
        break;
    case JOB_SUSPEND:
        result = QLatin1String("suspend");
        break;
    case JOB_RESUME:
        result = QLatin1String("resume");
        break;
    case NJOBS:
        qFatal("Undefined stroke job type: %d", type);
    }
 
    return result;
}

References JOB_CANCEL, JOB_DOSTROKE, JOB_FINISH, JOB_INIT, JOB_RESUME, JOB_SUSPEND, and NJOBS.

resumeStrokeCallback()

void KisSimpleStrokeStrategy::resumeStrokeCallback ( )

virtual

Reimplemented in KisRegenerateFrameStrokeStrategy, KisSuspendProjectionUpdatesStrokeStrategy, and KisPainterBasedStrokeStrategy.

Definition at line 189 of file kis_simple_stroke_strategy.cpp.

{
}

suspendStrokeCallback()

void KisSimpleStrokeStrategy::suspendStrokeCallback ( )

virtual

Reimplemented in KisRegenerateFrameStrokeStrategy, KisSuspendProjectionUpdatesStrokeStrategy, and KisPainterBasedStrokeStrategy.

Definition at line 185 of file kis_simple_stroke_strategy.cpp.

{
}

Member Data Documentation

m_jobEnabled

QVector<bool> KisSimpleStrokeStrategy::m_jobEnabled

private

Definition at line 67 of file kis_simple_stroke_strategy.h.

m_jobExclusivity

QVector<KisStrokeJobData::Exclusivity> KisSimpleStrokeStrategy::m_jobExclusivity

private

Definition at line 69 of file kis_simple_stroke_strategy.h.

m_jobSequentiality

QVector<KisStrokeJobData::Sequentiality> KisSimpleStrokeStrategy::m_jobSequentiality

private

Definition at line 68 of file kis_simple_stroke_strategy.h.

---

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

• libs/image/kis_simple_stroke_strategy.h
• libs/image/kis_simple_stroke_strategy.cpp