KisAutoKey Namespace Reference

Classes
class	AutoKeyFrameStateHolder

Enumerations
enum	AutoCreateKeyframeFlag { None = 0x0 , AllowBlankMode = 0x1 , SupportsLod = 0x2 }
enum	Mode { NONE , BLANK , DUPLICATE }

Functions
Mode	activeMode ()
void	initHolder ()
void	testingSetActiveMode (Mode mode)
KUndo2Command *	tryAutoCreateDuplicatedFrame (KisPaintDeviceSP device, AutoCreateKeyframeFlags flags=None)
	create a new duplicated keyframe if auto-keyframe mode is on

Variables
QScopedPointer< AutoKeyFrameStateHolder >	s_holder

Enumeration Type Documentation

AutoCreateKeyframeFlag

enum KisAutoKey::AutoCreateKeyframeFlag

Enumerator
None
AllowBlankMode
SupportsLod

Definition at line 34 of file KisAnimAutoKey.h.

                            {
    None = 0x0,
    AllowBlankMode = 0x1,
    SupportsLod = 0x2
};

Mode

enum KisAutoKey::Mode

Enumerator
NONE
BLANK
DUPLICATE

Definition at line 24 of file KisAnimAutoKey.h.

          {
    NONE, // AutoKey is disabled. Keyframes must be created manually.
    BLANK, // AutoKey creates an empty/blank frame. Acts like DUPLICATE when not
           // applicable (i.e.: filters, transforms, etc.).
    DUPLICATE // AutoKey will duplicate the active frame.
};

Function Documentation

activeMode()

KRITAIMAGE_EXPORT Mode KisAutoKey::activeMode

(

)

Definition at line 75 of file KisAnimAutoKey.cpp.

{
    return s_holder->mode();
}

References s_holder.

initHolder()

void KisAutoKey::initHolder

(

)

Definition at line 68 of file KisAnimAutoKey.cpp.

                   {
    if (!s_holder) {
        s_holder.reset(new AutoKeyFrameStateHolder());
    }
}

References s_holder.

testingSetActiveMode()

KRITAIMAGE_EXPORT void KisAutoKey::testingSetActiveMode

(

Mode

mode

)

Definition at line 133 of file KisAnimAutoKey.cpp.

{
    s_holder->testingSetActiveMode(mode);
}

References s_holder.

tryAutoCreateDuplicatedFrame()

KRITAIMAGE_EXPORT KUndo2Command * KisAutoKey::tryAutoCreateDuplicatedFrame	(	KisPaintDeviceSP	device,
		AutoCreateKeyframeFlags	flags = None )

create a new duplicated keyframe if auto-keyframe mode is on

Parameters

device

a paint device of the layer to be processed

Returns

an undo command if the keyframe has been duplicated

Use the same color label as previous keyframe, the duplicate action duplicates the label automatically, but addKeyframe not

Definition at line 80 of file KisAnimAutoKey.cpp.

                                                                                                    {
    KUndo2Command* undo = nullptr;
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(device, undo);
 
    const bool isLodNMode = device->defaultBounds()->currentLevelOfDetail() > 0;
 
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(!isLodNMode || flags & SupportsLod, undo);
 
    const KisAutoKey::Mode autoKeyMode = KisAutoKey::activeMode();
    if (autoKeyMode == KisAutoKey::NONE) return undo;
 
    KisRasterKeyframeChannel *channel = device->keyframeChannel();
    if (!channel) return undo;
 
    const int activeKeyframe = channel->activeKeyframeTime();
    const int targetKeyframe = device->defaultBounds()->currentTime();
 
    if (activeKeyframe == targetKeyframe) return undo;
 
    if (isLodNMode) {
        if (flags & AllowBlankMode && autoKeyMode == KisAutoKey::BLANK) {
            const QRect originalDirtyRect = device->exactBounds();
            KisTransaction transaction(device);
            device->clear();
            device->setDirty(originalDirtyRect);
            undo = transaction.endAndTake();
        }
        // for KisAutoKey::DUPLICATE mode we do nothing and just reuse
        // the LoDN device
    } else {
        undo = new KUndo2Command;
 
        if (flags & AllowBlankMode && autoKeyMode == KisAutoKey::BLANK) {
            channel->addKeyframe(targetKeyframe, undo);
 
 
            KisKeyframeSP newKeyframe = channel->keyframeAt(targetKeyframe);
            KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(newKeyframe, undo);
 
            KisKeyframeSP oldKeyframe = channel->keyframeAt(activeKeyframe);
            KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(oldKeyframe, undo);
 
            newKeyframe->setColorLabel(oldKeyframe->colorLabel());
        } else {
            channel->copyKeyframe(activeKeyframe, targetKeyframe, undo);
        }
    }
 
    return undo;
}

References KisKeyframeChannel::activeKeyframeTime(), activeMode(), KisKeyframeChannel::addKeyframe(), AllowBlankMode, BLANK, KisPaintDevice::clear(), KisKeyframeChannel::copyKeyframe(), KisDefaultBoundsBase::currentLevelOfDetail(), KisDefaultBoundsBase::currentTime(), KisPaintDevice::defaultBounds(), KisTransaction::endAndTake(), KisPaintDevice::exactBounds(), KisKeyframeChannel::keyframeAt(), KisPaintDevice::keyframeChannel(), KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, NONE, KisPaintDevice::setDirty(), and SupportsLod.

Variable Documentation

s_holder

QScopedPointer<AutoKeyFrameStateHolder> KisAutoKey::s_holder

Definition at line 67 of file KisAnimAutoKey.cpp.