ColoredTextAreaOverlayElement Class Reference

#include <ColoredTextAreaOverlayElement.h>

Inheritance diagram for ColoredTextAreaOverlayElement:

Public Member Functions
	ColoredTextAreaOverlayElement (const Ogre::String &name)
	~ColoredTextAreaOverlayElement (void)
void	setValueBottom (float Value)
void	setValueTop (float Value)
void	setCaption (const Ogre::DisplayString &text)
void	updateColours (void)

Static Public Member Functions
static Ogre::DisplayString	StripColors (const Ogre::String &text)
static Ogre::ColourValue	GetColor (unsigned char ID, float Value=1.0f)

Protected Attributes
std::vector< unsigned char >	m_Colors
float	m_ValueTop
float	m_ValueBottom

Detailed Description

Definition at line 28 of file ColoredTextAreaOverlayElement.h.

Constructor & Destructor Documentation

ColoredTextAreaOverlayElement()

ColoredTextAreaOverlayElement::ColoredTextAreaOverlayElement

(

const Ogre::String &

name

)

Definition at line 31 of file ColoredTextAreaOverlayElement.cpp.

~ColoredTextAreaOverlayElement()

ColoredTextAreaOverlayElement::~ColoredTextAreaOverlayElement

(

void

)

Definition at line 38 of file ColoredTextAreaOverlayElement.cpp.

Member Function Documentation

GetColor()

ColourValue ColoredTextAreaOverlayElement::GetColor ( unsigned char  ID, float  Value = 1.0f  )

static

Definition at line 54 of file ColoredTextAreaOverlayElement.cpp.

setCaption()

void ColoredTextAreaOverlayElement::setCaption

(

const Ogre::DisplayString &

text

)

Definition at line 112 of file ColoredTextAreaOverlayElement.cpp.

setValueBottom()

void ColoredTextAreaOverlayElement::setValueBottom

(

float

Value

)

Definition at line 42 of file ColoredTextAreaOverlayElement.cpp.

setValueTop()

void ColoredTextAreaOverlayElement::setValueTop

(

float

Value

)

Definition at line 48 of file ColoredTextAreaOverlayElement.cpp.

StripColors()

DisplayString ColoredTextAreaOverlayElement::StripColors ( const Ogre::String &  text )

static

Definition at line 82 of file ColoredTextAreaOverlayElement.cpp.

updateColours()

void ColoredTextAreaOverlayElement::updateColours

(

void

)

Definition at line 143 of file ColoredTextAreaOverlayElement.cpp.

Field Documentation

m_Colors

std::vector<unsigned char> ColoredTextAreaOverlayElement::m_Colors

protected

Definition at line 43 of file ColoredTextAreaOverlayElement.h.

m_ValueBottom

float ColoredTextAreaOverlayElement::m_ValueBottom

protected

Definition at line 45 of file ColoredTextAreaOverlayElement.h.

m_ValueTop

float ColoredTextAreaOverlayElement::m_ValueTop

protected

Definition at line 44 of file ColoredTextAreaOverlayElement.h.

---

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

• source/main/gfx/ColoredTextAreaOverlayElement.h
• source/main/gfx/ColoredTextAreaOverlayElement.cpp