GUIMultiplierTimer Class Reference

GUIMultiplierTimer displays a decreasing timer bar. More...

#include <Game/GUIMultiplierTimer.h>

Inherits GUIPanel.

List of all members.

Public Member Functions

 GUIMultiplierTimer ()
 Constructor.
virtual ~GUIMultiplierTimer ()
 Deconstructor.
void SetTimerLength (float len)
 Sets the length of the timer.
void ResetTimer ()
 Reset the timer.
void SetFont (FontRef f)
 Sets the font to use when drawing text.
void SetMultiplier (float val)
 Sets the value of the multiplier.
bool TimerComplete () const
 Determines if the timer is done or not.
void Display ()
 Displays the timer.
void Hide ()
 Hides the timer.
void ForceHide ()
 Forcefully hides the timer skipping any animation.
void UpdateTimer (float dt)
 Updates the timer.

Protected Member Functions

void UpdatePositions ()
 Updates the positions of the GUI elements.

Detailed Description

GUIMultiplierTimer displays a decreasing timer bar.


Member Function Documentation

void GUIMultiplierTimer::SetFont ( FontRef  f  ) 

Sets the font to use when drawing text.

Parameters:
[in] f the referance to the font.
void GUIMultiplierTimer::SetMultiplier ( float  val  ) 

Sets the value of the multiplier.

Parameters:
[in] val the multiplier value.
void GUIMultiplierTimer::SetTimerLength ( float  len  ) 

Sets the length of the timer.

Parameters:
[in] len the length in seconds of the timer.
bool GUIMultiplierTimer::TimerComplete (  )  const [inline]

Determines if the timer is done or not.

Returns:
true if the timer is complete, false otherwise.
void GUIMultiplierTimer::UpdateTimer ( float  dt  ) 

Updates the timer.

Parameters:
[in] dt the frame time in seconds.

The documentation for this class was generated from the following files:
Generated on Mon Apr 5 19:08:05 2010 for BrickOut |ReDuX| by  doxygen 1.6.3