KviAnimatedPixmap.h

Go to the documentation of this file.

#ifndef KVI_ANIMATEDPIXMAP_H_
#define KVI_ANIMATEDPIXMAP_H_
//=============================================================================
//
//   File : KviAnimatedPixmap.h
//   Creation date : Wed Jul 30 2008 01:45:21 CEST by Alexey Uzhva
//
//   This file is part of the KVIrc IRC client distribution
//   Copyright (C) 2008 Alexey Uzhva (wizard at opendoor dot ru)
//
//   This program is FREE software. You can redistribute it and/or
//   modify it under the terms of the GNU General Public License
//   as published by the Free Software Foundation; either version 2
//   of the License, or (at your option) any later version.
//
//   This program is distributed in the HOPE that it will be USEFUL,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program. If not, write to the Free Software Foundation,
//   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
//=============================================================================

#include <QObject>
#include <QPixmap>
#include <QList>
#include <QTimer>
#include "kvi_settings.h"
#include "KviAnimatedPixmapCache.h"

class KVILIB_API KviAnimatedPixmap : public QObject, public KviAnimatedPixmapInterface
{
        Q_OBJECT

protected:
        QString m_szFileName;
        KviAnimatedPixmapCache::Data * m_pFrameData;

        uint m_uCurrentFrameNumber;
        int m_iStarted;

public:
        /*
        * Creates KviAnimatedPixmap, and loads data from "fileName".
        */
        KviAnimatedPixmap(QString fileName, int iWidth = 0, int iHeight = 0);

        virtual ~KviAnimatedPixmap();

        /*
         * Creates new pixmap using "source" as source of images.
         */
        KviAnimatedPixmap(const KviAnimatedPixmap & source);

        /*
         * Returns true if animation is started.
         * Returns false otherways.
         */
        inline bool isStarted()
        {
                return m_iStarted > 0;
        }

        /*
         * Starts the animation
         */
        void start();

        /*
         * Stops the animation
         */
        void stop();

        /*
         * Returns true if animation has at least one loaded frame.
         * Returns false otherways.
         */
        inline bool isValid()
        {
                return (m_pFrameData->count() > 0);
        }

        /*
         * Returns active frame's pixmap.
         * Never fails.
         */

        inline QPixmap * pixmap()
        {
                if(m_pFrameData->count() > 0)
                        return m_pFrameData->at(m_uCurrentFrameNumber).pixmap;
                else
                        return KviAnimatedPixmapCache::dummyPixmap();
        }

        /*
         * Returns active frame number
         */
        inline uint activeFrameNumber()
        {
                return m_uCurrentFrameNumber;
        }

        /*
         * Returns animation frame count
         */
        inline uint framesCount()
        {
                return m_pFrameData->count();
        }

        /*
         * Returns current image size
         */
        inline const QSize & size()
        {
                return m_pFrameData->size;
        }

        /*
         * Resizes all frames to the newSize size, using "ratioMode"
         * ratio.
         */
        void resize(QSize newSize, Qt::AspectRatioMode ratioMode);

        /*
         * Called when the frame changes
         */
        void nextFrame(bool bEmitSignalAndScheduleNext);

signals:

        /*
         * Slot, to be connected to m_animationTimer, to receive animation
         * frame changes.
         */
        void frameChanged();
};

#endif /* KVI_ANIMATEDPIXMAP_H_ */