WoopsiUI::WoopsiTimer Class Reference
#include <woopsitimer.h>
List of all members.
Detailed Description
Class providing a timer.
Constructor & Destructor Documentation
WoopsiUI::WoopsiTimer::WoopsiTimer |
( |
u32 |
timeout, |
|
|
bool |
repeat | |
|
) |
| | |
Constructor.
- Parameters:
-
| timeout | Time, in frames, before the timer fires an EVENT_ACTION event. |
| repeat | If true, the timer will fire multiple events. If false, the timer will fire just once and stop. |
virtual WoopsiUI::WoopsiTimer::~WoopsiTimer |
( |
|
) |
[inline, protected, virtual] |
WoopsiUI::WoopsiTimer::WoopsiTimer |
( |
const WoopsiTimer & |
woopsiTimer |
) |
[inline, protected] |
Copy constructor is protected to prevent usage.
Member Function Documentation
const u32 WoopsiUI::WoopsiTimer::getFrameCount |
( |
|
) |
const [inline] |
Return the number of frames that this timer has been running for since the last event fired.
- Returns:
- Frame count since the last event fired.
const u32 WoopsiUI::WoopsiTimer::getTimeout |
( |
|
) |
const [inline] |
Return the timeout of this timer.
- Returns:
- The number of frames that this timer runs before firing an event.
void WoopsiUI::WoopsiTimer::pause |
( |
|
) |
[inline] |
Stops the timer but does not reset the frame count.
void WoopsiUI::WoopsiTimer::reset |
( |
|
) |
[inline] |
Resets the frame count back to 0.
virtual bool WoopsiUI::WoopsiTimer::run |
( |
|
) |
[virtual] |
Run any code that should execute every VBL.
- Returns:
- True if the function ran succesfully.
void WoopsiUI::WoopsiTimer::setTimeout |
( |
u32 |
timeout |
) |
[inline] |
Set the timeout of this timer.
- Parameters:
-
| timeout | The number of frames that this timer will run before firing an event. |
void WoopsiUI::WoopsiTimer::start |
( |
|
) |
[inline] |
void WoopsiUI::WoopsiTimer::stop |
( |
|
) |
[inline] |
Stops the timer and resets the frame count.
Member Data Documentation
Number of frames run so far
Indicates whether or not the timer repeats
Indicates whether or not the timer is running
Number of frames to run before firing an event
The documentation for this class was generated from the following file: