GuiFrameCounter Class Reference
[2D graphical user interface]

Prints the current framerate onto the screen. More...

#include <guitext.h>

Inheritance diagram for GuiFrameCounter:

[legend]Collaboration diagram for GuiFrameCounter:

[legend]List of all members.

Public Member Functions
DECLSPEC	GuiFrameCounter (const SDL_Rect &r, GuiElement *p, const char *name)
DECLSPEC	GuiFrameCounter (TiXmlElement *el, GuiElement *p)
virtual const char *	getClassName ()
Static Public Member Functions
static void	newguiobject (void *presult, BasicObject *o, void *xmldata)
Protected Member Functions
virtual DECLSPEC Uint32	onFrame (SdlSurface *dst)
virtual DECLSPEC void	onInit ()

---

Detailed Description

Prints the current framerate onto the screen.

The number is the average amount of frames per second during the last 30 frames.

---

Constructor & Destructor Documentation

GuiFrameCounter::GuiFrameCounter	(	TiXmlElement *	el,
		GuiElement *	p
	)

Constructor. Uses XML data.

Parameters:

	el	the XML data for initialisation
	p	parent element (or NULL, to take GuiManager::the as parent)

See also:

GuiElement(TiXmlElement*,GuiElement*)

---

Member Function Documentation

virtual const char* GuiFrameCounter::getClassName

(

)

[inline, virtual]

This function should be overriden in every sub-class of BasicObject!

Returns:

the name of the class.

Reimplemented from GuiText.

Uint32 GuiFrameCounter::onFrame

(

SdlSurface *

dst

)

[protected, virtual]

This event is called, when a frame is drawn. If the object should be visible, is has to draw it's look to a valid surface. This method calls the children's function, if visible.

Returns:

zero, if no error occured; if not zero, drawing is stopped

Note:

if you derive the function, then call GuiElement::onFrame(SdlSurface*) after your class's drawing was done in the onFrame-event, otherwise you paint over the children elements

Reimplemented from GuiText.

void GuiFrameCounter::onInit

(

)

[protected, virtual]

Initializes the object's variables by reading data from the XML element. If there were no XML data used for creation, nothing is done. This function calls onInit() of its children recursively (after it has inited itself). It is highly recommended to call BasicObject::onInit(), usually at the end of the onInit() method, when overwriting it in a derived class.

Reimplemented from GuiText.

---

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

• guitext.h
• guitext.cpp

---