ExampleLoadingBar Class Reference

#include <LoadingBar.h>

List of all members.

Public Member Functions
virtual void	start (RenderWindow *window, unsigned short numGroupsInit=1, unsigned short numGroupsLoad=1, Real initProportion=0.70f)
virtual void	finish (void)

---

Detailed Description

Defines an example loading progress bar which you can use during startup, level changes etc to display loading progress.

Remarks:

Basically you just need to create an instance of this class, call start() before loading and finish() afterwards. You may also need to stop areas of your scene rendering in between since this method will call RenderWindow::update() to update the display of the bar - we advise using SceneManager's 'special case render queues' for this, see SceneManager::addSpecialCaseRenderQueue for details.

Note:

This progress bar relies on you having the OgreCore.zip package already added to a resource group called 'Bootstrap' - this provides the basic resources required for the progress bar and will be loaded automatically.

---

Member Function Documentation

virtual void ExampleLoadingBar::start	(	RenderWindow *	window,
		unsigned short	numGroupsInit = 1,
		unsigned short	numGroupsLoad = 1,
		Real	initProportion = 0.70f
	)			[inline, virtual]

Show the loading bar and start listening.

Parameters:

	window	The window to update
	numGroupsInit	The number of groups you're going to be initialising
	numGroupsLoad	The number of groups you're going to be loading
	initProportion	The proportion of the progress which will be taken up by initialisation (ie script parsing etc). Defaults to 0.7 since script parsing can often take the majority of the time.

virtual void ExampleLoadingBar::finish

(

void

)

[inline, virtual]

Hide the loading bar and stop listening.

---

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

• mDisplay/LoadingBar.h