kgamerenderer.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright 2010-2012 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 KGAMERENDERER_H
#define KGAMERENDERER_H

class QGraphicsView;
#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtGui/QPixmap>

#include <libkdegames_export.h>

class KGameRendererPrivate;
class KGameRendererClient;
class KGameRendererClientPrivate;
class KgTheme;
class KgThemeProvider;

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

class KDEGAMES_EXPORT KGameRenderer : public QObject
{
    Q_OBJECT
    Q_PROPERTY(const KgTheme* theme READ theme NOTIFY themeChanged)
    Q_PROPERTY(KgThemeProvider* themeProvider READ themeProvider NOTIFY readOnlyProperty)
    public:
        enum Strategy
        {
            UseDiskCache = 1 << 0,
            UseRenderingThreads = 1 << 1
        };
        Q_DECLARE_FLAGS(Strategies, Strategy)

        
        explicit KGameRenderer(KgThemeProvider* prov, unsigned cacheSize = 0);
        explicit KGameRenderer(KgTheme* theme, unsigned cacheSize = 0);
        virtual ~KGameRenderer();

        QGraphicsView* defaultPrimaryView() const;
        void setDefaultPrimaryView(QGraphicsView* view);
        int frameBaseIndex() const;
        void setFrameBaseIndex(int frameBaseIndex);
        QString frameSuffix() const;
        void setFrameSuffix(const QString& suffix);
        Strategies strategies() const;
        void setStrategyEnabled(Strategy strategy, bool enabled = true);

        const KgTheme* theme() const;
        KgThemeProvider* themeProvider() const;

        QRectF boundsOnSprite(const QString& key, int frame = -1) const;
        int frameCount(const QString& key) const;
        bool spriteExists(const QString& key) const;

        // The parentheses around QHash<QColor, QColor>() avoid compile
        // errors on platforms with older gcc versions, e.g. OS X 10.6.
        QPixmap spritePixmap(const QString& key, const QSize& size, int frame = -1, const QHash<QColor, QColor>& customColors = (QHash<QColor, QColor>())) const;
    Q_SIGNALS:
        void themeChanged(const KgTheme* theme);
        void readOnlyProperty();
    private:
        friend class KGameRendererPrivate;
        friend class KGameRendererClient;
        friend class KGameRendererClientPrivate;
        KGameRendererPrivate* const d;
        Q_PRIVATE_SLOT(d, void _k_setTheme(const KgTheme*));
};

Q_DECLARE_OPERATORS_FOR_FLAGS(KGameRenderer::Strategies)

#endif // KGAMERENDERER_H