OnScreenText Class Reference
[Engine Module]

#include <onscreentext.h>

Inheritance diagram for OnScreenText:

Root Object TreeNode< Root > Referenced Counted Serialized List< Root > ListNode< Root >

List of all members.


Detailed Description

Todo:
Script interface.

Public Member Functions

 OnScreenText (const char *id)
virtual ~OnScreenText ()
void AddMessage (const string &text)
void AddMessage (const string &text, const vector3 &color)
void AddMessage (const char *text)
void AddMessage (const char *text, const vector3 &color)
void SetDefaultColor (const vector3 &color)
void SetDisplayTime (double display_time)
void SetPosition (const vector2 &position)
void SetSize (const vector2 &size)
void Render ()

Private Types

typedef list< MessageMessageList

Private Attributes

MessageList messages
 List of active (visible) messages.
vector3 default_color
 Default color of messages.
double display_time
 Time of displaying of one message. [seconds].
vector2 position
 Position of rendering rectangle.
vector2 size
 Size of rendering rectangle.
byte_t max_count
 Maximal number of messages. Computed from height of rectangle and height of font.

Classes

struct  Message

Member Typedef Documentation

typedef list<Message> OnScreenText::MessageList [private]


Constructor & Destructor Documentation

OnScreenText::OnScreenText ( const char *  id  ) 

Constructor.

OnScreenText::~OnScreenText (  )  [virtual]

Destructor.


Member Function Documentation

void OnScreenText::AddMessage ( const string &  text  )  [inline]

void OnScreenText::AddMessage ( const string &  text,
const vector3 color 
) [inline]

void OnScreenText::AddMessage ( const char *  text  )  [inline]

void OnScreenText::AddMessage ( const char *  text,
const vector3 color 
)

void OnScreenText::SetDefaultColor ( const vector3 color  )  [inline]

void OnScreenText::SetDisplayTime ( double  display_time  )  [inline]

void OnScreenText::SetPosition ( const vector2 position  )  [inline]

void OnScreenText::SetSize ( const vector2 size  ) 

void OnScreenText::Render (  ) 


Member Data Documentation

MessageList OnScreenText::messages [private]

List of active (visible) messages.

vector3 OnScreenText::default_color [private]

Default color of messages.

double OnScreenText::display_time [private]

Time of displaying of one message. [seconds].

vector2 OnScreenText::position [private]

Position of rendering rectangle.

vector2 OnScreenText::size [private]

Size of rendering rectangle.

byte_t OnScreenText::max_count [private]

Maximal number of messages. Computed from height of rectangle and height of font.


The documentation for this class was generated from the following files:
Generated on Sat Oct 20 14:47:33 2007 for Dark Oberon by  doxygen 1.5.3