athena/include/Athena/WiiBanner.hpp

177 lines
3.3 KiB
C++
Raw Permalink Normal View History

2013-02-16 04:22:16 +00:00
#ifndef WIIBANNER_H
#define WIIBANNER_H
#include <vector>
#include <string>
2014-04-20 09:14:15 +00:00
#include "Athena/Global.hpp"
2013-02-16 04:22:16 +00:00
2014-04-20 09:14:15 +00:00
namespace Athena
2013-07-21 03:57:20 +00:00
{
class WiiImage;
2013-07-21 03:57:20 +00:00
/*! \class WiiBanner
* \brief Wii banner container class
*
* Contains all relevant data for a Wii banner.
*/
2013-02-16 04:22:16 +00:00
class WiiBanner
{
public:
2013-07-21 03:57:20 +00:00
enum
{
NoCopy = 0x00000001,
Bounce = 0x00000010,
NoCopyBounce = NoCopy | Bounce
};
/*!
* \brief WiiBanner
*/
2013-02-16 04:22:16 +00:00
WiiBanner();
2013-07-21 03:57:20 +00:00
/*!
* \brief WiiBanner
* \param gameId
* \param title
* \param subtitle
* \param m_banner
* \param icons
*/
WiiBanner(atUint32 gameId, const std::string& title, const std::string& subtitle, WiiImage* m_banner, std::vector<WiiImage*> icons);
2013-02-16 04:22:16 +00:00
virtual ~WiiBanner();
2013-07-21 03:57:20 +00:00
/*!
* \brief setGameID
* \param id
*/
void setGameID(atUint64 id);
2013-07-21 03:57:20 +00:00
/*!
* \brief gameID
* \return
*/
atUint64 gameID() const;
2013-02-16 04:22:16 +00:00
2013-07-21 03:57:20 +00:00
/*!
* \brief setBannerImage
* \param banner
*/
2013-02-16 04:22:16 +00:00
void setBannerImage(WiiImage* banner);
2013-07-21 03:57:20 +00:00
/*!
* \brief bannerImage
* \return
*/
2013-02-16 04:22:16 +00:00
WiiImage* bannerImage() const;
2013-07-21 03:57:20 +00:00
/*!
* \brief setBannerSize
* \param size
*/
void setBannerSize(atUint32 size);
2013-07-21 03:57:20 +00:00
/*!
* \brief bannerSize
* \return
*/
atUint32 bannerSize() const;
2013-02-16 04:22:16 +00:00
2013-07-21 03:57:20 +00:00
/*!
* \brief setTitle
* \param title
*/
2013-02-16 04:22:16 +00:00
void setTitle(const std::string& title);
2013-07-21 03:57:20 +00:00
/*!
* \brief title
* \return
*/
2013-02-16 04:22:16 +00:00
std::string title() const;
2013-07-21 03:57:20 +00:00
/*!
* \brief setSubtitle
* \param subtitle
*/
void setSubtitle(const std::string& subtitle);
/*!
* \brief subtitle
* \return
*/
2013-02-16 04:22:16 +00:00
std::string subtitle() const;
2013-07-21 03:57:20 +00:00
/*!
* \brief addIcon
* \param icon
*/
2013-02-16 04:22:16 +00:00
void addIcon(WiiImage* icon);
2013-07-21 03:57:20 +00:00
/*!
* \brief setIcon
* \param id
* \param icon
*/
void setIcon(atUint32 id, WiiImage* icon);
2013-07-21 03:57:20 +00:00
/*!
* \brief getIcon
* \param id
* \return
*/
WiiImage* getIcon(atUint32 id) const;
2013-07-21 03:57:20 +00:00
/*!
* \brief icons
* \return
*/
2013-02-16 04:22:16 +00:00
std::vector<WiiImage*> icons() const;
2013-07-21 03:57:20 +00:00
/*!
* \brief setAnimationSpeed
* \param animSpeed
*/
void setAnimationSpeed(atUint16 animSpeed);
2013-07-21 03:57:20 +00:00
/*!
* \brief animationSpeed
* \return
*/
atUint16 animationSpeed() const;
2013-02-16 04:22:16 +00:00
2013-07-21 03:57:20 +00:00
/*!
* \brief setPermissions
* \param permissions
*/
void setPermissions(atUint8 permissions);
2013-07-21 03:57:20 +00:00
/*!
* \brief permissions
* \return
*/
atUint8 permissions() const;
2013-02-16 04:22:16 +00:00
2013-07-21 03:57:20 +00:00
/*!
* \brief setFlags
* \param flags
*/
void setFlags(atUint32 flags);
2013-07-21 03:57:20 +00:00
/*!
* \brief flags
* \return
*/
atUint32 flags() const;
2013-02-16 04:22:16 +00:00
protected:
private:
atUint64 m_gameId;
2013-02-16 04:22:16 +00:00
WiiImage* m_banner;
atUint32 m_animSpeed;
atUint8 m_permissions;
atUint32 m_flags;
atUint32 m_bannerSize;
2013-02-16 04:22:16 +00:00
std::vector<WiiImage*> m_icons;
std::string m_title;
std::string m_subtitle;
};
2013-07-21 03:57:20 +00:00
} // zelda
2013-02-16 04:22:16 +00:00
#endif // WIIBANNER_H