KGameRendererClient Class

An object that receives pixmaps from a KGameRenderer. More...

Header: #include <KGameRendererClient>
Inherited By:

KGameRenderedGraphicsObject and KGameRenderedItem

Public Functions

KGameRendererClient(KGameRenderer *renderer, const QString &spriteKey)
QHash<QColor, QColor> customColors() const
int frame() const
int frameCount() const
QSize renderSize() const
KGameRenderer *renderer() const
void setCustomColors(const QHash<QColor, QColor> &customColors)
void setFrame(int frame)
void setRenderSize(QSize renderSize)
void setSpriteKey(const QString &spriteKey)
QString spriteKey() const

Protected Functions

virtual void receivePixmap(const QPixmap &pixmap) = 0

Detailed Description

This class abstracts a sprite rendered by KGameRenderer. Given a sprite key, render size and possibly a frame index, it returns the QPixmap for this sprite (frame) once it becomes available. See the KGameRenderer class documentation for details.

Subclasses have to reimplement the receivePixmap() method.

Member Function Documentation

KGameRendererClient::KGameRendererClient(KGameRenderer *renderer, const QString &spriteKey)

Creates a new client which receives pixmaps for the sprite with the given spriteKey as provided by the given renderer.

QHash<QColor, QColor> KGameRendererClient::customColors() const

Returns the custom color replacements for this client.

See also setCustomColors().

int KGameRendererClient::frame() const

Returns the current frame number, or -1 for non-animated sprites.

See also setFrame().

int KGameRendererClient::frameCount() const

Returns the frame count, or 0 for non-animated sprites, or -1 if the sprite does not exist at all.

See also KGameRenderer::frameCount.

[pure virtual protected] void KGameRendererClient::receivePixmap(const QPixmap &pixmap)

This method is called when the KGameRenderer has provided a new pixmap for this client (esp. after theme changes and after calls to setFrame(), setRenderSize() and setSpriteKey()).

QSize KGameRendererClient::renderSize() const

Returns the size of the pixmap requested from KGameRenderer.

See also setRenderSize().

KGameRenderer *KGameRendererClient::renderer() const

Returns the renderer used by this client.

void KGameRendererClient::setCustomColors(const QHash<QColor, QColor> &customColors)

Defines the custom color replacements for this client as customColors. That is, for each entry in this, the key color will be replaced by its value if it is encountered in the sprite.

Note: Custom colors increase the rendering time considerably, so use this feature only if you really need its flexibility.

See also customColors().

void KGameRendererClient::setFrame(int frame)

For animated sprites, render another frame. The given frame number is normalized by taking the modulo of the frame count, so the following code works fine:

class MyClient : public KGameRendererClient { ... }
MyClient client;
client.setFrame(client.frame() + 1); //cycle to next frame
client.setFrame(KRandom::random());  //choose a random frame

See also frame().

void KGameRendererClient::setRenderSize(QSize renderSize)

Defines the size of the pixmap that will be requested from KGameRenderer as renderSize. For pixmaps rendered on the screen, you usually want to set this size such that the pixmap does not have to be scaled when it is rendered onto your primary view (for speed reasons).

The default render size is very small (width = height = 3 pixels), so that you notice when you forget to set this. ;-)

See also renderSize().

void KGameRendererClient::setSpriteKey(const QString &spriteKey)

Defines the key of the sprite which is rendered by this client as spriteKey.

See also spriteKey().

QString KGameRendererClient::spriteKey() const

Returns the key of the sprite currently rendered by this client.

See also setSpriteKey().