#include <kis_switch_time_stroke_strategy.h>

Inheritance diagram for KisSwitchTimeStrokeStrategy:

Classes
struct	Private

struct	SharedToken

Public Types
typedef QSharedPointer< SharedToken >	SharedTokenSP

typedef QWeakPointer< SharedToken >	SharedTokenWSP

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

Public Member Functions
KisStrokeStrategy *	createLodClone (int levelOfDetail) override

void	initStrokeCallback () override

	KisSwitchTimeStrokeStrategy (int frameId, bool needsRegeneration, KisImageAnimationInterface interface, KisPostExecutionUndoAdapter undoAdapter)

SharedTokenSP	token () const

	~KisSwitchTimeStrokeStrategy () override

Public Member Functions inherited from KisSimpleStrokeStrategy
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 ()

	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

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 ()

Private Attributes
const QScopedPointer< Private >	m_d

Additional Inherited Members
Static Public Member Functions inherited from KisSimpleStrokeStrategy
static QLatin1String	jobTypeToString (JobType type)

Protected Member Functions inherited from KisSimpleStrokeStrategy
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)

Detailed Description

Definition at line 18 of file kis_switch_time_stroke_strategy.h.

Member Typedef Documentation

◆ SharedTokenSP

typedef QSharedPointer<SharedToken> KisSwitchTimeStrokeStrategy::SharedTokenSP

Definition at line 33 of file kis_switch_time_stroke_strategy.h.

◆ SharedTokenWSP

typedef QWeakPointer<SharedToken> KisSwitchTimeStrokeStrategy::SharedTokenWSP

Definition at line 34 of file kis_switch_time_stroke_strategy.h.

Constructor & Destructor Documentation

◆ KisSwitchTimeStrokeStrategy()

KisSwitchTimeStrokeStrategy::KisSwitchTimeStrokeStrategy	(	int	frameId,
		bool	needsRegeneration,
		KisImageAnimationInterface *	interface,
		KisPostExecutionUndoAdapter *	undoAdapter )

Switches current time to frameId

NOTE: switching time does end all the running stroke, because it is not a background action, but a distinct user action.

Definition at line 29 of file kis_switch_time_stroke_strategy.cpp.

    : KisSimpleStrokeStrategy(QLatin1String("switch_current_frame_stroke"), kundo2_i18n("Switch Frames")),
      m_d(new Private(frameId, needsRegeneration))
{
    m_d->interface = interface;
    m_d->undoAdapter = undoAdapter;
 
 
    enableJob(JOB_INIT, true, KisStrokeJobData::SEQUENTIAL, KisStrokeJobData::EXCLUSIVE);
 
    // switching frames is a distinct user action, so it should
    // cancel the playback or any action easily
    setRequestsOtherStrokesToEnd(true);
    setClearsRedoOnStart(false);
}

References KisSimpleStrokeStrategy::enableJob(), KisStrokeJobData::EXCLUSIVE, KisSimpleStrokeStrategy::JOB_INIT, m_d, KisStrokeJobData::SEQUENTIAL, KisStrokeStrategy::setClearsRedoOnStart(), and KisStrokeStrategy::setRequestsOtherStrokesToEnd().

◆ ~KisSwitchTimeStrokeStrategy()

KisSwitchTimeStrokeStrategy::~KisSwitchTimeStrokeStrategy ( )

override

Definition at line 48 of file kis_switch_time_stroke_strategy.cpp.

49{

50}

Member Function Documentation

◆ createLodClone()

KisStrokeStrategy * KisSwitchTimeStrokeStrategy::createLodClone ( int levelOfDetail )

overridevirtual

Reimplemented from KisStrokeStrategy.

Definition at line 68 of file kis_switch_time_stroke_strategy.cpp.

{
    Q_UNUSED(levelOfDetail);
 
    // This stroke is explicitly made LEGACY, so that it could create a barrier for
    // time switch. Theoretically, we can have separate time ids for Lod0 and LodN,
    // but currently this idea doesn't work for some reason. The consequences of
    // making this stroke a barrier:
    //
    // * LodSync stroke is started after every time switch (not slow, but still...)
    // * The frame switches only *after* all the pending strokes are finished
    // * LodSync stroke is started even when the image is not changed (not regeneration needed)!
 
    return 0;
}

◆ initStrokeCallback()

void KisSwitchTimeStrokeStrategy::initStrokeCallback ( )

overridevirtual

Reimplemented from KisSimpleStrokeStrategy.

Definition at line 51 of file kis_switch_time_stroke_strategy.cpp.

{
    const int frameId = m_d->token->fetchTime();
 
    if (frameId == m_d->interface->currentTime()) return;
 
    const int oldTime = m_d->interface->currentTime();
    m_d->interface->explicitlySetCurrentTime(frameId);
 
    if (m_d->undoAdapter) {
        KUndo2CommandSP cmd(
            new KisSwitchCurrentTimeCommand(m_d->interface,
                                            oldTime,
                                            frameId));
        m_d->undoAdapter->addCommand(cmd);
    }
}

References m_d.

◆ token()

KisSwitchTimeStrokeStrategy::SharedTokenSP KisSwitchTimeStrokeStrategy::token ( ) const

Definition at line 84 of file kis_switch_time_stroke_strategy.cpp.

{
    return m_d->token;
}

References m_d.

Member Data Documentation

◆ m_d

const QScopedPointer<Private> KisSwitchTimeStrokeStrategy::m_d

private

Definition at line 57 of file kis_switch_time_stroke_strategy.h.

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

libs/image/kis_switch_time_stroke_strategy.h
libs/image/kis_switch_time_stroke_strategy.cpp

Classes

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members