components/scene/ImageComponent.h

Go to the documentation of this file.

// /////////////////////////////////////////////////////////////////////////////
//
// Name:            ImageComponent.h
// Author:          Michael Bartsch (ZCCdark203)
//
// Desc :           Declaration of the ImageComponent class.
//
// License:         Copyright (C) 2009 Michael Bartsch and Contributors
//
//                  This program is free software: you can redistribute it
//                  and/or modify it under the terms of the zlib/libpng License.
//                  See main.cpp for conditions of distribution and use.
//
// /////////////////////////////////////////////////////////////////////////////

#ifndef __IMAGECOMPONENT_H__
#define __IMAGECOMPONENT_H__

// Include files
#include "../../dependencies.h"
#include "../../core/EntityComponent.h"


// ImageComponent class
class ImageComponent : public EntityComponent
{
public:

    // Initialisation and deinitialisation
    ImageComponent(Entity *parent);
    ImageComponent(Entity *parent, const std::string &fileName, const vector2di &position,
                   const rect<s32> &sourceRect, rect<s32> *clipRect = NULL,
                   const SColor &color = SColor(255, 255, 255, 255),
                   const SColor &alphaColor = SColor(255, 255, 255, 255),
                   bool useAlphaColor = false);
    ImageComponent(Entity *parent, ITexture *texture, const vector2di &position,
                   const rect<s32> &sourceRect, rect<s32> *clipRect = NULL,
                   const SColor &color = SColor(255, 255, 255, 255),
                   const SColor &alphaColor = SColor(255, 255, 255, 255),
                   bool useAlphaColor = false);
    ~ImageComponent();

    // AngelScript binding
    static ImageComponent* refFactory(Entity *parent);

    // Public methods
    const SColor& getAlphaColor() const;
    const rect<s32>* getClipRect() const;
    const SColor& getColor() const;
    const vector2di& getPosition() const;
    const rect<s32>& getSourceRect() const;
    const ITexture* getTexture() const;
    bool getUseAlphaColor() const;

    void setAlphaColor(const SColor &color);
    void setClipRect(rect<s32> *rectangle);
    void setColor(const SColor &color);
    void setPosition(const vector2di &position);
    void setSourceRect(const rect<s32> &rectangle);
    void setTexture(const std::string &fileName);
    void setTexture(ITexture *texture);
    void setUseAlphaColor(bool value);

    // Event functions
    void onRender(void *p);
    void onPause(void *p);
    void onUnPause(void *p);

private:

    // Private members
    ITexture *mTexture;

    SColor mAlphaColor;
    rect<s32> *mClipRect;
    SColor mColor;
    vector2di mPosition;
    rect<s32> mSourceRect;

    bool mVisible;
    bool mUseAlphaColor;
    bool mWasVisible;

};


// ImageComponent Angelscript binding.
extern void bindImageComponent(asIScriptEngine *engine);

#endif

---