kgamerendererclient.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2010 Stefan Majewsky <majewsky@gmx.net>                     *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Library General Public License          *
 *   version 2 as published by the Free Software Foundation                *
 *                                                                         *
 *   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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library 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.         *
 ***************************************************************************/

#ifndef KGAMERENDERERCLIENT_H
#define KGAMERENDERERCLIENT_H

#include <QtGui/QPixmap>

#include <libkdegames_export.h>

class KGameRendererClientPrivate;
class KGameRenderer;
class KGameRendererPrivate;

#ifndef KDEGAMES_QCOLOR_QHASH
#   define KDEGAMES_QCOLOR_QHASH
    inline uint qHash(const QColor& color)
    {
        return color.rgba();
    }
#endif // KDEGAMES_QCOLOR_QHASH

class KDEGAMES_EXPORT KGameRendererClient
{
    public:
        KGameRendererClient(KGameRenderer* renderer, const QString& spriteKey);
        virtual ~KGameRendererClient();

        KGameRenderer* renderer() const;
        int frameCount() const;

        QString spriteKey() const;
        void setSpriteKey(const QString& spriteKey);
        int frame() const;
        void setFrame(int frame);
        QSize renderSize() const;
        void setRenderSize(const QSize& renderSize);
        QHash<QColor, QColor> customColors() const;
        void setCustomColors(const QHash<QColor, QColor>& customColors);
    protected:
        virtual void receivePixmap(const QPixmap& pixmap) = 0;
    private:
        friend class KGameRendererClientPrivate;
        friend class KGameRenderer;
        friend class KGameRendererPrivate;
        KGameRendererClientPrivate* const d;
};

#endif // KGAMERENDERERCLIENT_H