KisTimeBasedItemModel::Private Struct Reference

Public Member Functions
int	baseNumFrames () const
int	effectiveNumFrames () const
int	framesPerSecond ()
	Private ()
bool	withinClipRange (const int time)

Public Attributes
int	activeFrameIndex
QPointer< KisCanvasAnimationState >	animationPlayer
QVector< bool >	cachedFrames
KisDocument *	document
KisAnimationFrameCacheWSP	framesCache
KisImageWSP	image
int	numFramesOverride
int	scrubHeaderMax
int	scrubHeaderMin
QScopedPointer< KisSignalCompressorWithParam< int > >	scrubHeaderUpdateCompressor
bool	scrubInProgress
int	scrubStartFrame
bool	shouldReturnToPlay

Detailed Description

Definition at line 30 of file KisTimeBasedItemModel.cpp.

Constructor & Destructor Documentation

Private()

KisTimeBasedItemModel::Private::Private ( )

inline

Definition at line 32 of file KisTimeBasedItemModel.cpp.

        : animationPlayer(0)
        , document(nullptr)
        , numFramesOverride(0)
        , activeFrameIndex(0)
        , scrubInProgress(false)
        , scrubStartFrame(-1)
        , shouldReturnToPlay(false)
        , scrubHeaderMin(0)
        , scrubHeaderMax(0)
    {}

Member Function Documentation

baseNumFrames()

int KisTimeBasedItemModel::Private::baseNumFrames ( ) const

inline

Definition at line 62 of file KisTimeBasedItemModel.cpp.

                              {
 
        auto imageSP = image.toStrongRef();
        if (!imageSP) return 0;
 
        KisImageAnimationInterface *i = imageSP->animationInterface();
        if (!i) return 1;
 
        return i->totalLength();
    }

References image, KisWeakSharedPtr< T >::toStrongRef(), and KisImageAnimationInterface::totalLength().

effectiveNumFrames()

int KisTimeBasedItemModel::Private::effectiveNumFrames ( ) const

inline

Definition at line 73 of file KisTimeBasedItemModel.cpp.

                                   {
        if (image.isNull()) return 0;
 
        return qMax(baseNumFrames(), numFramesOverride);
    }

References baseNumFrames(), image, KisWeakSharedPtr< T >::isNull(), and numFramesOverride.

framesPerSecond()

int KisTimeBasedItemModel::Private::framesPerSecond ( )

inline

Definition at line 79 of file KisTimeBasedItemModel.cpp.

                          {
        return image->animationInterface()->framerate();
    }

References KisImage::animationInterface(), KisImageAnimationInterface::framerate(), and image.

withinClipRange()

bool KisTimeBasedItemModel::Private::withinClipRange ( const int time )

inline

Definition at line 83 of file KisTimeBasedItemModel.cpp.

                                         {
        if (!image) {
            return true;
        }
 
        KisTimeSpan clipRange = image->animationInterface()->documentPlaybackRange();
        return clipRange.contains(time);
    }

References KisImage::animationInterface(), KisTimeSpan::contains(), KisImageAnimationInterface::documentPlaybackRange(), and image.

Member Data Documentation

activeFrameIndex

int KisTimeBasedItemModel::Private::activeFrameIndex

Definition at line 52 of file KisTimeBasedItemModel.cpp.

animationPlayer

QPointer<KisCanvasAnimationState> KisTimeBasedItemModel::Private::animationPlayer

Definition at line 46 of file KisTimeBasedItemModel.cpp.

cachedFrames

QVector<bool> KisTimeBasedItemModel::Private::cachedFrames

Definition at line 49 of file KisTimeBasedItemModel.cpp.

document

KisDocument* KisTimeBasedItemModel::Private::document

Definition at line 47 of file KisTimeBasedItemModel.cpp.

framesCache

KisAnimationFrameCacheWSP KisTimeBasedItemModel::Private::framesCache

Definition at line 45 of file KisTimeBasedItemModel.cpp.

image

KisImageWSP KisTimeBasedItemModel::Private::image

Definition at line 44 of file KisTimeBasedItemModel.cpp.

numFramesOverride

int KisTimeBasedItemModel::Private::numFramesOverride

Definition at line 51 of file KisTimeBasedItemModel.cpp.

scrubHeaderMax

int KisTimeBasedItemModel::Private::scrubHeaderMax

Definition at line 60 of file KisTimeBasedItemModel.cpp.

scrubHeaderMin

int KisTimeBasedItemModel::Private::scrubHeaderMin

Definition at line 59 of file KisTimeBasedItemModel.cpp.

scrubHeaderUpdateCompressor

QScopedPointer<KisSignalCompressorWithParam<int> > KisTimeBasedItemModel::Private::scrubHeaderUpdateCompressor

Definition at line 58 of file KisTimeBasedItemModel.cpp.

scrubInProgress

bool KisTimeBasedItemModel::Private::scrubInProgress

Definition at line 54 of file KisTimeBasedItemModel.cpp.

scrubStartFrame

int KisTimeBasedItemModel::Private::scrubStartFrame

Definition at line 55 of file KisTimeBasedItemModel.cpp.

shouldReturnToPlay

bool KisTimeBasedItemModel::Private::shouldReturnToPlay

Definition at line 56 of file KisTimeBasedItemModel.cpp.

---

The documentation for this struct was generated from the following file:

• plugins/dockers/animation/KisTimeBasedItemModel.cpp