This page has been translated automatically.
Setting Up Development Environment
High-Level Systems
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
Double Precision Coordinates
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
Rendering-Related Classes
Warning! This version of documentation is OUTDATED, as it describes an older SDK version! Please switch to the documentation for the latest SDK version.
Warning! This version of documentation describes an old SDK version which is no longer supported! Please upgrade to the latest SDK version.

Usage Example

This article describes a simple example of how to create Unigine native GUI by using User interface (UI) files.

Create UI Files

Use a plain text editor to create a *.uifile that describes the GUI of your project. Then describe all of the requiredcontainers, widgets and their layout:

Source code (XML)
<?xml version="1.0" encoding="utf-8"?>
<ui version="1.0">	
	<window name="window" export="1" width="250" height="150" sizeable="1" enabled="1" space_y="10">
		<text align="left">Language</text>
		<align align="left">
			<label><text>Choose the language:</text></label>
			<checkbox name="radiobutton_0" export="1" checked="1">
			<checkbox name="radiobutton_1" export="1">
			<callback type="clicked">translation</callback>
To get access to the widgets from the script, you must specify the nameparameter and set theexportparameter to1 for each of them.

To set the callback for the widget, simply define callbackas a child tag and set the required value for itstype parameter. Also the callback function must be defined in the script.

Create Dictionary

To support several languages in your project, create a single dictionary in the project folder that contains all necessary translations. For example, you can create English-Chinese dictionary, which is required to switch from English to Chinese and vice versa:

Source code (XML)
<?xml version="1.0" encoding="utf-8"?>
<dictionary version="1.00">
		<src>Choose the language:</src>
		<en>Choose the language:</en>
To be shown correctly, the Chinese font file (for example, font_ch.ttf) should be added to the project folder and loaded when it is necessary.

Add Script Logic

When the *.ui file is created, the GUI is described, the dictionary is prepared and all the necessary fonts are added to the project, you need to add a script logic.

  1. Declare the root widget, its children (if necessary) and User interface as global variables in the script:
    Source code (UnigineScript)
    WidgetWindow window; // root widget
    WidgetCheckBox radiobutton_0; // the first radiobutton
    WidgetCheckBox radiobutton_1; // the second radiobutton
    UserInterface ui; // user interface
    The name of each variable must match the name of the widget defined in the UI file.
  2. Load User interface by using the UserInterface()constructor:
    Source code (UnigineScript)
    int init(){
        ui = new UserInterface(engine.getGui(),"my_project/my_project.ui");
    	return 1;
  3. Create an object of the GUI class and add the root widget to be rendered in the GUI interface via Gui::addChild():
    Source code (UnigineScript)
    int init(){
        ui = new UserInterface(engine.getGui(),"my_project/my_project.ui");
    	Gui gui = engine.getGui();
    	return 1;
    To set the root widget alignment via scripting, define one of the GUI_ALIGN_* pre-defined variables as the second argument of the addChild() function.
  4. Define callback function that loads the chosen dictionary via engine.gui.addDictionary()(if necessary) and applies the language changes viaupdateWidgets():
    Source code (UnigineScript)
    void translation(){
    	if (radiobutton_0.isChecked()){
    		// load English-Chinese dictionary and specify <en> tag as the source of translation
    		// set the default font
    	else {
    		// load English-Chinese dictionary and specify <ch> tag as the source of translation
    		// set the Chinese font for correct characters displaying

The script logic described in the example enables switching between English and Chinese:

The first radiobutton was checked.
The second radiobutton was checked.
Last update: 2017-07-03
Build: ()