Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changes between Version 1 and Version 2 of code/doc/GUI


Ignore:
Timestamp:
Mar 25, 2009, 11:54:05 PM (15 years ago)
Author:
bknecht
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • code/doc/GUI

    v1 v2  
    11= Graphical User Interface =
     2[[TracNav(TracNav/TOC_Development)]]
    23
    3 The GUI in Orxonox is administered with CEGUI. We use the GUI for interactions with the user in shops, Questsystem or parts of the HUD and of course the main menu.
     4The GUI in Orxonox is administered with CEGUI. We use the GUI for interactions with the user in shops, [wiki:Questsystem] or parts of the HUD and of course the main menu.
    45
    56== CEGUI ==
    67
    7 CEGUI (Crazy Edi's GUI) is available for various graphic engines like Ogre or Irrlicht. In Orxonox we use the OgreCEGUIRenderer to display our GUI.
     8CEGUI (Crazy Edi's GUI) is available for various graphic engines like [http://www.ogre3d.org Ogre] or [http://irrlicht.sourceforge.net/ Irrlicht]. In Orxonox we use the [http://www.orxonox.net/doxygen/classCEGUI_1_1OgreCEGUIRenderer.html OgreCEGUIRenderer] to display our GUI.
    89
    9 == GUI-Framework ==
     10== GUI Framework ==
    1011
    11 The framework consists of various elements, putting all necessary elements together for a functioning GUI. Those elements are basically the GUIManager, lua-scripts, layouts and the corresponding graphics.
     12The framework consists of various elements, putting all necessary elements together for a functioning GUI. Those elements are basically the GUIManager, Lua-scripts, layouts and the corresponding graphics.
    1213
    1314=== GUIManager ===
    1415
    15 Written in C++ the GUIManager manages all the GUIs in Orxonox and represents the interface to CEGUI. Connected to lua via a tolua++ interface it is able to load lua-scripts and connect C++-functions to lua and vice versa.
     16Written in C++ the GUIManager manages all the GUIs in Orxonox and represents the interface to CEGUI. Connected to Lua via a tolua++ interface it is able to load Lua-scripts and connect C++-functions to Lua and vice versa.
    1617
    17 === lua-scripts ===
     18=== Lua-scripts ===
    1819
    19 Lua-scripts are written in lua and implement the functionalities of CEGUI like interactivity.
     20Lua-scripts are written in Lua and implement the functionalities of CEGUI like interactivity. Each GUI needs a separate Lua-script which will be loaded by the main script.
    2021
     22Usually you would set some variables and define some events inside the Lua-script. You may want for instance to define what layout you want to load. Check out the existing scripts to get an idea of the intended use.
     23
     24=== Imagesets ===
     25
     26Images are loaded in so called imagesets. As the name suggests, you can group several images into one single imageset. This can be used for instance when defining "active", "hover", "clicked" and "inactive" state of a button. You'd load just one image file into the imageset, but define various images from that imageset.
     27
     28Imageset files are written in XML and very easy to use. To be able to use the specified images though, you need to include the imageset into a scheme file.
     29
     30=== Schemes ===
     31
     32=== Layouts ===
    2133
    2234=== GUI-Elements ===
    2335
    24 ==== Widgets ====
     36==== Winodws ====
    2537
    26 ==== Windows ====
    27 
    28 ==== Buttons ====
    29 
    30 ==== etc. ====
     38==== Cursor ====