Namespace OmegaGUI

OmegaGUI is a GUI toolkit for OmegaEngine.

Note

NuGet package: OmegaGUI

OmegaGUI is a texture-based 2D GUI toolkit with Lua scripting support. It provides a flexible system for creating interactive user interfaces with a Model-View separation pattern.

Architecture

The GUI system uses a Model-View pattern with four key components:

• OmegaGUI.Model - Defines the structure and data of GUI elements (dialogs, controls)
• OmegaGUI.Render - Handles the actual rendering of GUI elements as textures
• GuiManager - Manages all active dialogs and handles input/update cycles
• DialogPresenter - Connects a Model dialog to its Render counterpart and manages the Lua scripting context

The Model namespace contains serializable definitions that can be saved to XML, while the Render namespace contains the runtime rendering implementations.

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
    namespace OmegaGUI.Model {
        class Model.Dialog["Dialog"]
        class Model.Control["Control"]
        class Model.Label["Label"]
        class Model.Button["Button"]
        class Model.CheckBox["CheckBox"]
    }

    namespace OmegaGUI.Render {
        class Render.Dialog["Dialog"]
        class Render.Control["Control"]
        class Render.Label["Label"]
        class Render.Button["Button"]
        class Render.CheckBox["CheckBox"]
    }

    DialogPresenter o--> Model.Dialog
    DialogPresenter o--> Render.Dialog

    Model.Dialog *--> "*" Model.Control
    Render.Dialog *--> "*" Render.Control

    Model.Control <|-- Model.Label
    Model.Control <|-- Model.Button
    Model.Control <|-- Model.CheckBox

    Render.Control <|-- Render.Label
    Render.Control <|-- Render.Button
    Render.Control <|-- Render.CheckBox

XML storage

GUI definitions are stored in XML files using the OmegaGUI.Model namespace classes. This allows dialogs to be designed visually in editors and loaded at runtime:

// Load dialog from XML
var dialog = Dialog.FromContent("MainMenu.xml");

// Convert to renderable dialog
var dialogPresenter = new DialogPresenter(guiManager, dialog.ToRenderable(), lua: myLuaInstance);
dialogPresenter.Show();

Tip

AlphaEditor provides a WYSIWYG editor for creating and editing GUI dialogs visually.

Scripting

OmegaGUI uses Lua for event handling and interactive behavior. Each dialog has its own Lua instance.

Control events (like button clicks) can execute Lua scripts specified in the OnClick property:

var button = new Button
{
    Text = "Start Game",
    OnClick = "StartNewGame()" // Calls Lua function
};

Theming

Controls are rendered using texture atlases loaded via the storage system from GUI/Textures/<YourThemeName>.png. The default theme is base.

Create custom themes by:

1. Creating a texture atlas with the required control elements (see texture atlas coordinates)
2. Saving it as GUI/Textures/<YourThemeName>.png
3. Referencing the theme name in your GUI configuration

Texture atlas coordinates

Control	Element	Left	Top	Right	Bottom
Button	Normal	0	0	136	54
	Hover	136	0	252	54
CheckBox	Box	0	54	27	81
	Check	27	54	54	81
RadioButton	Box	54	54	81	81
	Check	81	54	108	81
DropdownList	Main	7	81	247	123
	Button	98	189	151	238
	Dropdown	13	123	241	160
	Selection	12	163	239	183
Slider	Track	1	187	93	228
	Button	151	193	192	234
Scrollbar	Track	196	212	218	223
	Up Arrow	196	192	218	212
	Down Arrow	196	223	218	244
	Button	220	192	238	234
TextBox	Text area	14	90	241	113
	Top left border	8	82	14	90
	Top border	14	82	241	90
	Top right border	241	82	246	90
	Left border	8	90	14	113
	Right border	241	90	246	113
	Lower left border	8	113	14	121
	Lower border	14	113	241	121
	Lower right border	241	113	246	121
Listbox	Main	13	123	241	160
	Selection	16	166	240	183

API

Namespaces

OmegaGUI.Model

Editor-friendly, XML-serializable data model of the GUI. No render code.

OmegaGUI.Render

Actual rendering widgets with DirectX resources.

Classes

DialogPresenter

Displays a Dialog model using Dialog rendering widgets.

GuiManager

Maintains lists of all DialogPresenters