SplashMessage Class Reference
Big Label. More...
#include <SplashMessage.h>
Inheritance diagram for SplashMessage:
Public Member Functions | |
| void | setText (const string &text) |
| Displays a new text message. | |
| void | setText (const string &text, const bool &permanent) |
| Displays a new text message. | |
| void | renderGl () |
| The rendering function to be used with OpenGL. | |
| void | selectGl () |
| The selection mode rendering function for OpenGL. | |
| virtual string | toString () const |
| Returns a textual representation. | |
| virtual string | className () const |
| Returns the class name of the object. | |
| virtual enum classId | classId () const |
| Returns the class id of the object. | |
Static Public Member Functions | |
| static SplashMessage * | getInstance () |
| Getter for the singleton. | |
Private Member Functions | |
| SplashMessage (Uint32 fadein, Uint32 display, Uint32 fadeout) | |
| Constructor. | |
| SplashMessage (const SplashMessage &source) | |
| Copy constructor. | |
| ~SplashMessage () | |
| Destructor. | |
Private Attributes | |
| Uint32 | fadein |
| Time a message gets for fade in animation. | |
| Uint32 | display |
| Time the message stays on screen excl. fades. | |
| Uint32 | fadeout |
| Time a message gets for fading out. | |
| Uint32 | current |
| Progress of the current message. | |
| Uint32 | lastTime |
| Last time the current progress was calculated. | |
| bool | permanent |
| Tells us if the text should fade out. | |
Static Private Attributes | |
| static SplashMessage * | instance = 0 |
| Singleton instance. | |
Detailed Description
Big Label.Text message that informs the user about different Events
Constructor & Destructor Documentation
| SplashMessage::SplashMessage | ( | Uint32 | fadein, | |
| Uint32 | display, | |||
| Uint32 | fadeout | |||
| ) | [private] |
Constructor.
- Parameters:
-
fadein ms to be use for fade in animation display ms the message should stay on screen between fades fadeout ms to be use for fade out animation
| SplashMessage::SplashMessage | ( | const SplashMessage & | source | ) | [private] |
Copy constructor.
- Parameters:
-
source the object to be copied
| SplashMessage::~SplashMessage | ( | ) | [private] |
Destructor.
Destructor
Member Function Documentation
| SplashMessage * SplashMessage::getInstance | ( | ) | [static] |
Getter for the singleton.
The only way to access the instance
| void SplashMessage::setText | ( | const string & | text | ) |
| void SplashMessage::setText | ( | const string & | text, | |
| const bool & | permanent | |||
| ) |
Displays a new text message.
| void SplashMessage::renderGl | ( | ) | [virtual] |
| void SplashMessage::selectGl | ( | ) | [virtual] |
| string SplashMessage::toString | ( | ) | const [virtual] |
Returns a textual representation.
- Returns:
- a string descriping the run-time object
Reimplemented from Label.
| string SplashMessage::className | ( | ) | const [virtual] |
Returns the class name of the object.
- Returns:
- a string with the name of the object's class
Reimplemented from Label.
| enum classId SplashMessage::classId | ( | ) | const [virtual] |
Member Data Documentation
SplashMessage * SplashMessage::instance = 0 [static, private] |
Singleton instance.
Uint32 SplashMessage::fadein [private] |
Time a message gets for fade in animation.
Uint32 SplashMessage::display [private] |
Time the message stays on screen excl. fades.
Uint32 SplashMessage::fadeout [private] |
Time a message gets for fading out.
Uint32 SplashMessage::current [private] |
Progress of the current message.
Uint32 SplashMessage::lastTime [private] |
Last time the current progress was calculated.
bool SplashMessage::permanent [private] |
Tells us if the text should fade out.
The documentation for this class was generated from the following files:
