OgreHUD Class Reference

#include <OgreHUD.hh>

List of all members.

Detailed Description

The Heads Up Display

Public Member Functions

void Update ()
void SetCamera (const CameraSensor *camera)
void AddTextBox (const std::string &id, const std::string &panelId, const std::string &text, Ogre::Real x, Ogre::Real y, Ogre::Real width, Ogre::Real height, const Ogre::ColourValue &color=Ogre::ColourValue(1.0, 1.0, 1.0, 1.0))
void ToggleVisible ()
void ToggleHelp ()
void HideTextBox (const std::string &id)
void ShowTextBox (const std::string &id)
void RemoveTextBox (const std::string &id)
void SetText (const std::string &id, const std::string &Text)

Static Public Member Functions

static OgreHUDInstance ()

Member Function Documentation

static OgreHUD* Instance (  )  [static]

Get a pointer to the text renderer

void Update (  ) 

Update the HUD.

void SetCamera ( const CameraSensor camera  ) 

Set the camera to display

void AddTextBox ( const std::string &  id,
const std::string &  panelId,
const std::string &  text,
Ogre::Real  x,
Ogre::Real  y,
Ogre::Real  width,
Ogre::Real  height,
const Ogre::ColourValue &  color = Ogre::ColourValue(1.0, 1.0, 1.0, 1.0) 

Add a text box

void ToggleVisible (  ) 

Toggle the visibility of the HUD

void ToggleHelp (  ) 

Toggle display of the help menu

void HideTextBox ( const std::string &  id  ) 

Hide a text box from being displayed

void ShowTextBox ( const std::string &  id  ) 

Show a text box

void RemoveTextBox ( const std::string &  id  ) 

Remove a text box

void SetText ( const std::string &  id,
const std::string &  Text 

Set text

The documentation for this class was generated from the following file:

Last updated Aug 04 2007