CEGuiIrrlichtBaseApplication Class Reference

Inheritance diagram for CEGuiIrrlichtBaseApplication:

Collaboration diagram for CEGuiIrrlichtBaseApplication:

Public Member Functions
void	destroyRenderer ()
bool	OnEvent (irr::SEvent event)
Public Member Functions inherited from CEGuiBaseApplication
	CEGuiBaseApplication ()
	Constructor.
virtual	~CEGuiBaseApplication ()
	Destructor.
virtual bool	init (SamplesFrameworkBase *sampleApp, const CEGUI::String &logFile, const CEGUI::String &dataPathPrefixOverride)
	Initialise the base application. More...
virtual void	cleanup ()
	Performs any required cleanup of the base application system. More...
void	renderSingleFrame (const float elapsed)
	Render a single display frame. This should be called by subclasses to perform rendering. More...
bool	isInitialised ()
CEGUI::String	getDataPathPrefix () const
	Return the path prefix to use for datafiles. The value returned is obtained via a environment variable named 'CEGUI_SAMPLE_DATAPATH' if the variable is not set, a default will be used depending on the build system in use.
void	initDataPathPrefix (const CEGUI::String &override)
void	registerSampleOverlayHandler (CEGUI::GUIContext *gui_context)
	Registers the overlay handler for rendering the FPS for a specified GUIContext.

Protected Member Functions
void	checkWindowResize ()
	member to check and handle resizing of the display window.
void	run ()
	The abstract function for running the application.
void	destroyWindow ()
	The abstract function for destroying the renderer and the window.
void	beginRendering (const float elapsed)
	Implementation function to perform required pre-render operations.
void	endRendering ()
	Implementation function to perform required post-render operations.
bool	processEvent (const irr::SEvent &event)
bool	OnKeyDown (irr::EKEY_CODE key, wchar_t wch, bool, bool)
bool	OnKeyUp (irr::EKEY_CODE key, wchar_t, bool, bool)
bool	OnMouse (irr::s32 x, irr::s32 y, irr::f32 w, irr::EMOUSE_INPUT_EVENT e)
Protected Member Functions inherited from CEGuiBaseApplication
virtual void	initialiseResourceGroupDirectories (const CEGUI::String &dataPathPrefixOverride)
	Setup standard sample resource group directory locations. Default uses the CEGUI::DefaultResourceProvider - override if the sample base app being implemented uses something else!
virtual void	initialiseDefaultResourceGroups ()
	initialise the standard default resource groups used by the samples.
void	updateFPS (const float elapsed)
	function that updates the FPS rendering as needed.
void	updateLogo (const float elapsed)
	function that updates the logo rotation as needed.
void	positionLogo ()
	function that positions the logo in the correct place.
void	positionFPS ()
	positions the FPS counter at the correct place.
bool	sampleBrowserOverlayHandler (const CEGUI::EventArgs &args)
	event handler function that draws the logo and FPS overlay elements.
bool	sampleOverlayHandler (const CEGUI::EventArgs &args)
	event handler function that draws the FPS overlay elements.
bool	resizeHandler (const CEGUI::EventArgs &args)
	event handler function called when main view is resized

Protected Attributes
irr::IrrlichtDevice *	d_device
irr::video::IVideoDriver *	d_driver
irr::scene::ISceneManager *	d_smgr
irr::u32	d_lastTime
const CEGUI::IrrlichtEventPusher *	d_eventPusher
CEGUI::Sizef	d_lastDisplaySize
	size of display last time a change was detected.
Protected Attributes inherited from CEGuiBaseApplication
bool	d_quitting
	true when the base app should cleanup and exit.
CEGUI::Renderer *	d_renderer
	Renderer to use. This MUST be set in the subclass constructor.
CEGUI::ImageCodec *	d_imageCodec
	ImageCodec to use. Set in subclass constructor, may be 0.
CEGUI::ResourceProvider *	d_resourceProvider
	ResourceProvider to use. Set in subclass constructor, may be 0.
CEGUI::GeometryBuffer *	d_logoGeometry
	GeometryBuffer used for drawing the spinning CEGUI logo.
CEGUI::GeometryBuffer *	d_FPSGeometry
	GeometryBuffer used for drawing the FPS value.
float	d_FPSElapsed
	Fraction of second elapsed (used for counting frames per second).
int	d_FPSFrames
	Number of frames drawn so far.
int	d_FPSValue
	Last changed FPS value.
bool	d_spinLogo
	whether to spin the logo

Additional Inherited Members
Static Protected Attributes inherited from CEGuiBaseApplication
static const char	DATAPATH_VAR_NAME [] = "CEGUI_SAMPLE_DATAPATH"
	name of env var that holds the path prefix to the data files.
static SamplesFrameworkBase *	d_sampleApp
	SampleFramework base used in the application.
static const int	s_defaultWindowWidth = 1280
	The window width the application should get created with at start.
static const int	s_defaultWindowHeight = 720
	The window height the application should get created with at start.