orxonox::OverlayText Class Reference

#include <src/orxonox/overlays/OverlayText.h>

Inheritance diagram for orxonox::OverlayText:

orxonox::OrxonoxOverlay orxonox::BaseObject orxonox::WindowEventListener orxonox::OrxonoxClass orxonox::OrxonoxClass orxonox::ChatOverlay orxonox::DebugFPSText orxonox::DebugRTRText orxonox::FadeoutText orxonox::GametypeStatus orxonox::HUDTimer orxonox::NotificationOverlay orxonox::PongScore orxonox::TeamBaseMatchScore

List of all members.

Public Types

enum  Alignment { Left, Right, Center }

Public Member Functions

OverlayText::Alignment getAlignment () const
std::string getAlignmentString () const
std::string getCaption () const
const ColourValue & getColour () const
const std::stringgetFont () const
float getSpaceWidth () const
float getTextSize () const
 OverlayText (BaseObject *creator)
void setAlignment (OverlayText::Alignment alignment)
void setAlignmentString (const std::string &alignment)
void setCaption (const std::string &caption)
void setColour (const ColourValue &colour)
void setFont (const std::string &font)
void setSpaceWidth (float width)
void setTextSize (float size)
virtual void XMLPort (Element &xmlElement, XMLPort::Mode mode)
 Loads the OrxonoxOverlay.
virtual ~OverlayText ()

Protected Member Functions

virtual void changedCaption ()
virtual void changedColour ()
virtual void sizeChanged ()
 Sets the overlay size using the actual corrected size.

Protected Attributes

Ogre::TextAreaOverlayElement * text_


Member Enumeration Documentation

Enumerator:
Left 
Right 
Center 


Constructor & Destructor Documentation

orxonox::OverlayText::OverlayText ( BaseObject creator  ) 

orxonox::OverlayText::~OverlayText (  )  [virtual]


Member Function Documentation

virtual void orxonox::OverlayText::changedCaption (  )  [inline, protected, virtual]

virtual void orxonox::OverlayText::changedColour (  )  [inline, protected, virtual]

OverlayText::Alignment orxonox::OverlayText::getAlignment (  )  const

References text_.

std::string orxonox::OverlayText::getAlignmentString (  )  const

std::string orxonox::OverlayText::getCaption (  )  const

References text_.

Referenced by XMLPort().

const ColourValue & orxonox::OverlayText::getColour (  )  const

const std::string & orxonox::OverlayText::getFont (  )  const

References text_.

Referenced by XMLPort().

float orxonox::OverlayText::getSpaceWidth (  )  const

References text_.

Referenced by XMLPort().

float orxonox::OverlayText::getTextSize (  )  const [inline]

Referenced by XMLPort().

void orxonox::OverlayText::setAlignment ( OverlayText::Alignment  alignment  ) 

References text_.

Referenced by setAlignmentString().

void orxonox::OverlayText::setAlignmentString ( const std::string alignment  ) 

void orxonox::OverlayText::setCaption ( const std::string caption  ) 

void orxonox::OverlayText::setColour ( const ColourValue &  colour  ) 

void orxonox::OverlayText::setFont ( const std::string font  ) 

void orxonox::OverlayText::setSpaceWidth ( float  width  ) 

References text_.

Referenced by XMLPort().

void orxonox::OverlayText::setTextSize ( float  size  )  [inline]

void orxonox::OverlayText::sizeChanged (  )  [protected, virtual]

void orxonox::OverlayText::XMLPort ( Element &  xmlElement,
XMLPort::Mode  mode 
) [virtual]

Loads the OrxonoxOverlay.

This has to be called before usage, otherwise strange behaviour is guaranteed! (there should be no segfaults however). XML loading and saving.

Parameters:
xmlelement The XML-element
loading Loading (true) or saving (false)
Returns:
The XML-element

Reimplemented from orxonox::OrxonoxOverlay.

Reimplemented in orxonox::FadeoutText, orxonox::PongScore, and orxonox::TeamBaseMatchScore.

References getAlignmentString(), getCaption(), getColour(), getFont(), getSpaceWidth(), getTextSize(), setAlignmentString(), setCaption(), setColour(), setFont(), setSpaceWidth(), setTextSize(), SUPER, and XMLPortParam.


Member Data Documentation

Ogre::TextAreaOverlayElement* orxonox::OverlayText::text_ [protected]


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

Generated on Tue Jul 28 16:22:51 2009 for Orxonox by  doxygen 1.5.6