Classes | Public Member Functions | Protected Attributes

OverlayHelper Class Reference

#include <OverlayHelper.h>

List of all members.

Classes

struct  TimedOverlay

Public Member Functions

 OverlayHelper ()
 ~OverlayHelper ()
void Startup (void)
void Shutdown (void)
void Update (unsigned int elapsedTimeMS)
Ogre::Overlay * GetGlobalOverlay (void) const
void FadeOverlayElement (Ogre::OverlayElement *element, unsigned int totalTime, unsigned int fadeTimeMS, float finalAlpha, bool deleteAfterFade)
Ogre::OverlayContainer * CreatePanel (const char *instanceName, bool addToGlobalOverlay=true)
Ogre::TextAreaOverlayElement * CreateTextArea (const char *instanceName, const char *fontName, Ogre::OverlayContainer *parent)
Ogre::BorderPanelOverlayElement * CreateBorderPanel (const char *instanceName, Ogre::OverlayContainer *parent)
void SafeDestroyOverlayElement (Ogre::OverlayElement *item)

Protected Attributes

DataStructures::List
< TimedOverlay
timedOverlays
Ogre::Overlay * globalOverlay
unsigned int fadeTimeMSMS

Detailed Description

Definition at line 19 of file OverlayHelper.h.


Constructor & Destructor Documentation

OverlayHelper::OverlayHelper (  ) 

Definition at line 25 of file OverlayHelper.cpp.

OverlayHelper::~OverlayHelper (  ) 

Definition at line 29 of file OverlayHelper.cpp.


Member Function Documentation

Ogre::BorderPanelOverlayElement* OverlayHelper::CreateBorderPanel ( const char *  instanceName,
Ogre::OverlayContainer *  parent 
)
OverlayContainer * OverlayHelper::CreatePanel ( const char *  instanceName,
bool  addToGlobalOverlay = true 
)

Definition at line 89 of file OverlayHelper.cpp.

Ogre::TextAreaOverlayElement* OverlayHelper::CreateTextArea ( const char *  instanceName,
const char *  fontName,
Ogre::OverlayContainer *  parent 
)
void OverlayHelper::FadeOverlayElement ( Ogre::OverlayElement *  element,
unsigned int  totalTime,
unsigned int  fadeTimeMS,
float  finalAlpha,
bool  deleteAfterFade 
)
Overlay * OverlayHelper::GetGlobalOverlay ( void   )  const

Definition at line 81 of file OverlayHelper.cpp.

void OverlayHelper::SafeDestroyOverlayElement ( Ogre::OverlayElement *  item  ) 
void OverlayHelper::Shutdown ( void   ) 

Definition at line 38 of file OverlayHelper.cpp.

void OverlayHelper::Startup ( void   ) 

Definition at line 33 of file OverlayHelper.cpp.

void OverlayHelper::Update ( unsigned int  elapsedTimeMS  ) 

Definition at line 44 of file OverlayHelper.cpp.


Member Data Documentation

unsigned int OverlayHelper::fadeTimeMSMS [protected]

Definition at line 66 of file OverlayHelper.h.

Ogre::Overlay* OverlayHelper::globalOverlay [protected]

Definition at line 65 of file OverlayHelper.h.

DataStructures::List<TimedOverlay> OverlayHelper::timedOverlays [protected]

Definition at line 64 of file OverlayHelper.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines