OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Package Functions | Properties | List of all members
OmegaGUI.GuiManager Class Reference

Maintains lists of all DialogRenderers More...

Inheritance diagram for OmegaGUI.GuiManager:

Public Member Functions

 GuiManager (Engine engine)
 Sets up the GUI system for rendering with the engine. More...
 
void CloseAll ()
 Closes all open DialogRenderers. More...
 
void Reset ()
 Closes all open DialogRenderers and resets the GUI system (i.e. clears all its caches). More...
 
void Update ()
 Invokes DialogRenderer.Update on all open DialogRenderers. More...
 
bool OnMsgProc (Message m)
 Handles Windows Messages for the GUI More...
 
void Dispose ()
 Deactivates the OmegaGUI system and unhooks it from the Engine More...
 

Package Functions

void AddNormal (DialogRenderer dialog)
 Adds a normal DialogRenderer to the GUI system that shares user-input with all other DialogRenderers. More...
 
void AddModal (DialogRenderer dialog)
 Adds a modal DialogRenderer to the GUI system that locks all other DialogRenderers while it is active. More...
 
void Remove (DialogRenderer dialog)
 Removes/closes an open DialogRenderer. More...
 
void QueueLuaDispose (Lua lua)
 Queues a Lua controller for disposal as soon as it stops executing its current script More...
 

Properties

Render.DialogManager DialogManager [get, set]
 Manages shared resources of all OmegaGUI.Render.Dialogs. More...
 

Detailed Description

Maintains lists of all DialogRenderers

Constructor & Destructor Documentation

OmegaGUI.GuiManager.GuiManager ( Engine  engine)
inline

Sets up the GUI system for rendering with the engine.

Parameters
engineThe Engine to render in.

Member Function Documentation

void OmegaGUI.GuiManager.AddModal ( DialogRenderer  dialog)
inlinepackage

Adds a modal DialogRenderer to the GUI system that locks all other DialogRenderers while it is active.

Parameters
dialogThe DialogRenderer to add.
void OmegaGUI.GuiManager.AddNormal ( DialogRenderer  dialog)
inlinepackage

Adds a normal DialogRenderer to the GUI system that shares user-input with all other DialogRenderers.

Parameters
dialogThe DialogRenderer to add.
void OmegaGUI.GuiManager.CloseAll ( )
inline

Closes all open DialogRenderers.

void OmegaGUI.GuiManager.Dispose ( )
inline

Deactivates the OmegaGUI system and unhooks it from the Engine

bool OmegaGUI.GuiManager.OnMsgProc ( Message  m)
inline

Handles Windows Messages for the GUI

Parameters
mThe message to handle
Returns
true if the message was handled and no further processing is necessary
void OmegaGUI.GuiManager.QueueLuaDispose ( Lua  lua)
inlinepackage

Queues a Lua controller for disposal as soon as it stops executing its current script

Parameters
luaThe object to be disposed
void OmegaGUI.GuiManager.Remove ( DialogRenderer  dialog)
inlinepackage

Removes/closes an open DialogRenderer.

Parameters
dialogThe DialogRenderer to close.
void OmegaGUI.GuiManager.Reset ( )
inline

Closes all open DialogRenderers and resets the GUI system (i.e. clears all its caches).

void OmegaGUI.GuiManager.Update ( )
inline

Invokes DialogRenderer.Update on all open DialogRenderers.

Property Documentation

Render.DialogManager OmegaGUI.GuiManager.DialogManager
getsetpackage

Manages shared resources of all OmegaGUI.Render.Dialogs.


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