Contains the generic GUI engine (contains the widgets and the backing logic for event handling, the skin, screens and dialogs). More...

Namespaces
namespace	GUIEngine
	Contains all GUI engine related classes and functions.

Classes
class	GUIEngine::AbstractStateManager
	Abstract base class you must override from to use the GUI engine. More...

class	GUIEngine::AbstractTopLevelContainer
	Represents a GUI widgets container. More...

class	GUIEngine::EventHandler
	Class to handle irrLicht events (GUI and input as well) More...

class	GUIEngine::ModalDialog
	Abstract base class representing a modal dialog. More...

class	GUIEngine::ScreenSingleton< SCREEN >
	Declares a class to be a singleton. More...

class	GUIEngine::Screen
	Represents a single GUI screen. More...

class	GUIEngine::ScreenKeyboard
	Class representing a screen keyboard. More...

class	GUIEngine::SkinWidgetContainer
	In order to avoid calculating render information every frame, it's stored in a SkinWidgetContainer for each widget (or each widget part if it requires many) More...

class	GUIEngine::BoxRenderParams
	class containing render params for the 'drawBoxFromStretchableTexture' function see Overview of GUI skin for more information about skinning in STK More...

class	GUIEngine::Skin
	Object used to render the GUI widgets see Overview of GUI skin for more information about skinning in STK. More...

class	GUIEngine::Widget
	The nearly-abstract base of all widgets (not fully abstract since a bare Widget can be created for the sole goal of containing children widgets in a group) More...

Enumerations
enum	GUIEngine::GameState : unsigned int { MENU , GAME , INGAME_MENU , GUIEngine::CURRENT }

enum	EventPropagation { EVENT_BLOCK , EVENT_BLOCK_BUT_HANDLED , EVENT_LET }

Functions
static void	GUIEngine::Screen::parseScreenFileDiv (irr::io::IXMLReader xml, PtrVector< Widget > &append_to, irr::gui::IGUIElement parent=NULL)
	Loads a GUI screen from its XML file.

Detailed Description

Contains the generic GUI engine (contains the widgets and the backing logic for event handling, the skin, screens and dialogs).

See module States_screens for the actual STK GUI screens. Note that all input comes through this module too.

Enumeration Type Documentation

Enumerator

CURRENT

Dummy GameState e.

g. for parameters.

void Screen::parseScreenFileDiv	(	irr::io::IXMLReader *	xml,
		PtrVector< Widget > &	append_to,
		irr::gui::IGUIElement *	parent = `NULL`
	)

static

Loads a GUI screen from its XML file.

Builds a hierarchy of Widget objects whose contents are a direct transcription of the XML file, with little analysis or layout performed on them.