CEGUI Wiki - Crazy Eddie's GUI System (Open Source) - User contributions [en]

Redirecting Lua Output

2012-08-29T00:04:19Z

Devil hunter: /* The setup */ fix

{{VersionBadge|0.7}}

=== What is the idea ===
I think you are here because you want to redirect Lua output to a window like a console or something similar. Then i will give you the answer.
There is more than one way to do this. I will use the easy lua way here.

=== The setup ===
We will use a similar console window like in [[CEGUI_In_Practice_-_A_Game_Console]]. So if you don't know this Tutorial yet you can take a look but it is not a must.
If you don't know how to use Lua with CEGUI take a look at [[Getting_Started_with_Lua_and_CEGUI]].

This will be the Layout for our console. If your CEGUI version does not have Vanilla then you can use "TaharezLook". This layout is copied from "VanillaConsole.layout" which comes with CEGUI examples at the moment.
<?xml version="1.0" ?>
<GUILayout>
<Window Type="Vanilla/FrameWindow" Name="Vanilla/Console">
<Property Name="AlwaysOnTop" Value="True" />
<Property Name="UnifiedMinSize" Value="{{0.2,0},{0.2,0}}" />
<Property Name="UnifiedMaxSize" Value="{{0.8,0},{0.8,0}}" />
<Property Name="UnifiedPosition" Value="{{0.5,0},{0.5,0}}" />
<Property Name="UnifiedSize" Value="{{0.5,0},{0.45,0}}" />
<Property Name="Text" Value="Console" />
<Property Name="CloseButtonEnabled" Value="False" />
<Window Type="Vanilla/Button" Name="Vanilla/Console/Submit">
<Property Name="ID" Value="1" />
<Property Name="VerticalAlignment" Value="Bottom" />
<Property Name="HorizontalAlignment" Value="Right" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedPosition" Value="{{0,-7},{0,-7}}" />
<Property Name="UnifiedSize" Value="{{0.25,0},{0,30}}" />
<Property Name="Text" Value="Submit" />
<Event Name="Clicked" Function="luabtn_clicked" />
</Window>
<Window Type="Vanilla/Editbox" Name="Vanilla/Console/Editbox">
<Property Name="ID" Value="2" />
<Property Name="VerticalAlignment" Value="Bottom" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedPosition" Value="{{0,7},{0,-7}}" />
<Property Name="UnifiedSize" Value="{{0.75,-21},{0,30}}" />
<Property Name="Text" Value="" />
</Window>
<Window Type="Vanilla/MultiLineEditbox" Name="Vanilla/Console/History">
<Property Name="ID" Value="3" />
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedPosition" Value="{{0,7},{0,7}}" />
<Property Name="UnifiedSize" Value="{{1,-14},{1,-47}}" />
<Property Name="Text">Console ready for input:</Property>
</Window>
</Window>
</GUILayout>
Please note that i have added the following line in the layout above to connect the event with the script i show later.
<Event Name="Clicked" Function="luabtn_clicked" />

After loading CEGUI we will do some basic setup. I use a Lua init script but you can also code this in C. My Lua init script looks like the following:
-- get CEGUI singletons
local logger = CEGUI.Logger:getSingleton()
logger:logEvent( ">>> Init script says hello" )
--logger:setLoggingLevel( CEGUI.Informative )

-- get a local reference to the singletons we use (not required)
local system = CEGUI.System:getSingleton()
local fontman = CEGUI.FontManager:getSingleton()
local schememan = CEGUI.SchemeManager:getSingleton()

-- load schemes
schememan:create( "TaharezLook.scheme" )
schememan:create( "WindowsLook.scheme" )
schememan:create( "VanillaSkin.scheme" )

-- load a default font
fontman:create( "DejaVuSans-10.font" )

-- set default mouse cursor
system:setDefaultMouseCursor( "Vanilla-Images", "MouseArrow" )

-- set default tooltip type
system:setDefaultTooltip("TaharezLook/Tooltip")

logger:logEvent( "<<< Init script says goodbye" )

=== The Trick ===
Here comes now the interresting part (MyConsole.lua):
-----------------------------------------
-- Start of handler functions
-----------------------------------------
-----------------------------------------
-- Handler to add line which will be executed and execute it
-----------------------------------------
function luabtn_clicked(args)
local winMgr = CEGUI.WindowManager:getSingleton()

local newText = winMgr:getWindow("Vanilla/Console/Editbox"):getText()
local oldText = winMgr:getWindow("Vanilla/Console/History"):getText()

print("executing: " .. newText)

--execute code
local f = loadstring(newText)
if f then
print(f())
else
print("invalid syntax!")
end
end

-----------------------------------------
-- Our print function which overrides default print behavior
-----------------------------------------
function consolePrint(s)
local winMgr = CEGUI.WindowManager:getSingleton()
local oldText = winMgr:getWindow("Vanilla/Console/History"):getText()
if s then
CEGUI.toMultiLineEditbox(winMgr:getWindow("Vanilla/Console/History")):setText(oldText .. s)
else
CEGUI.toMultiLineEditbox(winMgr:getWindow("Vanilla/Console/History")):setText(oldText .. "")
end
end

-----------------------------------------
-- Script Entry Point
-----------------------------------------
local guiSystem = CEGUI.System:getSingleton()
local winMgr = CEGUI.WindowManager:getSingleton()

-- load our demo8 window layout
local root = winMgr:loadWindowLayout("VanillaConsole.layout")
-- set the layout as the root
guiSystem:setGUISheet(root)

--print/output redirect to cegui console window - overriding normal behavior
print = consolePrint
io.write = consolePrint
out = consolePrint
As you can see we execute luabtn_clicked if someone clicks on the button. This function then trys to get a function out of the sting and trys to execute it if it is a function. If Lua is not able to build a function out of it the syntax is wrong and we will print that. 
Because we have replaced the normal print function with our print version this function gets called every "print" instead. It just adds the string to print to our history window.

Don't forget to start the script
System::getSingletonPtr()->executeScriptFile("MyConsole.lua");

=== Error handling ===
Because we can make a typo in console input and do not want to crash our app we now need a error handling.
We can not use try/catch in Lua but we can do the error handling using the pcall function. I decided to do the error handling in C++ because i like try catch more and we get a good error message prepared from CEGUI ;) 
We execute code in Lua if we click the button so we need to try/catch at the clickInjection. Because i don't know how i will use Lua in future i added the following try/catch everywhere i call a Lua script or inject something into CEGUI (also to the script execution call in the upper code block).
try {
CEGUI::System::getSingleton().injectMouseButtonDown(convertOgreButtonToCegui(id));
} catch( CEGUI::Exception& e ) {
showErrorMsgWindow((e.getMessage()+"\n\nFile: "+e.getFileName()+"\nLine: ").c_str(),__FILE__,__LINE__);
} catch (...) {
showErrorMsgWindow("Unknown CEGUI error!",__FILE__,__LINE__);
}

inline void showErrorMsgWindow(const char* c_str, const char *file, const unsigned long line) {
std::string str = c_str;
str.append(file);
str.append(CEGUI::PropertyHelper::intToString(line).c_str());//bad hack don't do this at home
#ifdef _WIN32
MessageBox( NULL, str.c_str(), "Error",MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << str.c_str() << std::endl;
#endif
}
Don't forget the right includes ;) 
Now we will get a message window in windows systems and a error message in other systems.

=== Conclusion ===
This shows by example how to redirect Lua output to a CEGUI window.

[[User:DEvil HUnter]] 22:20 - 28. August 2012 (MEZ)

[[Category:Tutorials]]

Redirecting Lua Output

2012-08-28T20:19:58Z

Devil hunter: Redirecting Lua Output

{{VersionBadge|0.7}}

=== What is the idea ===
I think you are here because you want to redirect Lua output to a window like a console or something similar. Then i will give you the answer.
There is more than one way to do this. I will use the easy lua way here.

=== The setup ===
We will use a similar console window like in [[CEGUI_In_Practice_-_A_Game_Console]]. So if you don't know this Tutorial yet you can take a look but it is not a must.
If you don't know how to use Lua with CEGUI take a look at [[Getting_Started_with_Lua_and_CEGUI]].

This will be the Layout for our console. If your CEGUI version does not have Vanilla then you can use "TaharezLook". This layout is copied from "VanillaConsole.layout" which comes with CEGUI examples at the moment.
<?xml version="1.0" ?>
<GUILayout>
<Window Type="Vanilla/FrameWindow" Name="Vanilla/Console">
<Property Name="AlwaysOnTop" Value="True" />
<Property Name="UnifiedMinSize" Value="{{0.2,0},{0.2,0}}" />
<Property Name="UnifiedMaxSize" Value="{{0.8,0},{0.8,0}}" />
<Property Name="UnifiedPosition" Value="{{0.5,0},{0.5,0}}" />
<Property Name="UnifiedSize" Value="{{0.5,0},{0.45,0}}" />
<Property Name="Text" Value="Console" />
<Property Name="CloseButtonEnabled" Value="False" />
<Window Type="Vanilla/Button" Name="Vanilla/Console/Submit">
<Property Name="ID" Value="1" />
<Property Name="VerticalAlignment" Value="Bottom" />
<Property Name="HorizontalAlignment" Value="Right" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedPosition" Value="{{0,-7},{0,-7}}" />
<Property Name="UnifiedSize" Value="{{0.25,0},{0,30}}" />
<Property Name="Text" Value="Submit" />
</Window>
<Window Type="Vanilla/Editbox" Name="Vanilla/Console/Editbox">
<Property Name="ID" Value="2" />
<Property Name="VerticalAlignment" Value="Bottom" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedPosition" Value="{{0,7},{0,-7}}" />
<Property Name="UnifiedSize" Value="{{0.75,-21},{0,30}}" />
<Property Name="Text" Value="" />
<Event Name="Clicked" Function="luabtn_clicked" />
</Window>
<Window Type="Vanilla/MultiLineEditbox" Name="Vanilla/Console/History">
<Property Name="ID" Value="3" />
<Property Name="ReadOnly" Value="True" />
<Property Name="UnifiedMaxSize" Value="{{1,0},{1,0}}" />
<Property Name="UnifiedPosition" Value="{{0,7},{0,7}}" />
<Property Name="UnifiedSize" Value="{{1,-14},{1,-47}}" />
<Property Name="Text">Console ready for input:</Property>
</Window>
</Window>
</GUILayout>
Please note that i have added the following line in the layout above to connect the event with the script i show later.
<Event Name="Clicked" Function="luabtn_clicked" />

After loading CEGUI we will do some basic setup. I use a Lua init script but you can also code this in C. My Lua init script looks like the following:
-- get CEGUI singletons
local logger = CEGUI.Logger:getSingleton()
logger:logEvent( ">>> Init script says hello" )
--logger:setLoggingLevel( CEGUI.Informative )

-- get a local reference to the singletons we use (not required)
local system = CEGUI.System:getSingleton()
local fontman = CEGUI.FontManager:getSingleton()
local schememan = CEGUI.SchemeManager:getSingleton()

-- load schemes
schememan:create( "TaharezLook.scheme" )
schememan:create( "WindowsLook.scheme" )
schememan:create( "VanillaSkin.scheme" )

-- load a default font
fontman:create( "DejaVuSans-10.font" )

-- set default mouse cursor
system:setDefaultMouseCursor( "Vanilla-Images", "MouseArrow" )

-- set default tooltip type
system:setDefaultTooltip("TaharezLook/Tooltip")

logger:logEvent( "<<< Init script says goodbye" )

=== The Trick ===
Here comes now the interresting part (MyConsole.lua):
-----------------------------------------
-- Start of handler functions
-----------------------------------------
-----------------------------------------
-- Handler to add line which will be executed and execute it
-----------------------------------------
function luabtn_clicked(args)
local winMgr = CEGUI.WindowManager:getSingleton()

local newText = winMgr:getWindow("Vanilla/Console/Editbox"):getText()
local oldText = winMgr:getWindow("Vanilla/Console/History"):getText()

print("executing: " .. newText)

--execute code
local f = loadstring(newText)
if f then
print(f())
else
print("invalid syntax!")
end
end

-----------------------------------------
-- Our print function which overrides default print behavior
-----------------------------------------
function consolePrint(s)
local winMgr = CEGUI.WindowManager:getSingleton()
local oldText = winMgr:getWindow("Vanilla/Console/History"):getText()
if s then
CEGUI.toMultiLineEditbox(winMgr:getWindow("Vanilla/Console/History")):setText(oldText .. s)
else
CEGUI.toMultiLineEditbox(winMgr:getWindow("Vanilla/Console/History")):setText(oldText .. "")
end
end

-----------------------------------------
-- Script Entry Point
-----------------------------------------
local guiSystem = CEGUI.System:getSingleton()
local winMgr = CEGUI.WindowManager:getSingleton()

-- load our demo8 window layout
local root = winMgr:loadWindowLayout("VanillaConsole.layout")
-- set the layout as the root
guiSystem:setGUISheet(root)

--print/output redirect to cegui console window - overriding normal behavior
print = consolePrint
io.write = consolePrint
out = consolePrint
As you can see we execute luabtn_clicked if someone clicks on the button. This function then trys to get a function out of the sting and trys to execute it if it is a function. If Lua is not able to build a function out of it the syntax is wrong and we will print that. 
Because we have replaced the normal print function with our print version this function gets called every "print" instead. It just adds the string to print to our history window.

Don't forget to start the script
System::getSingletonPtr()->executeScriptFile("MyConsole.lua");

=== Error handling ===
Because we can make a typo in console input and do not want to crash our app we now need a error handling.
We can not use try/catch in Lua but we can do the error handling using the pcall function. I decided to do the error handling in C++ because i like try catch more and we get a good error message prepared from CEGUI ;) 
We execute code in Lua if we click the button so we need to try/catch at the clickInjection. Because i don't know how i will use Lua in future i added the following try/catch everywhere i call a Lua script or inject something into CEGUI (also to the script execution call in the upper code block).
try {
CEGUI::System::getSingleton().injectMouseButtonDown(convertOgreButtonToCegui(id));
} catch( CEGUI::Exception& e ) {
showErrorMsgWindow((e.getMessage()+"\n\nFile: "+e.getFileName()+"\nLine: ").c_str(),__FILE__,__LINE__);
} catch (...) {
showErrorMsgWindow("Unknown CEGUI error!",__FILE__,__LINE__);
}

inline void showErrorMsgWindow(const char* c_str, const char *file, const unsigned long line) {
std::string str = c_str;
str.append(file);
str.append(CEGUI::PropertyHelper::intToString(line).c_str());//bad hack don't do this at home
#ifdef _WIN32
MessageBox( NULL, str.c_str(), "Error",MB_OK | MB_ICONERROR | MB_TASKMODAL);
#else
std::cerr << str.c_str() << std::endl;
#endif
}
Don't forget the right includes ;) 
Now we will get a message window in windows systems and a error message in other systems.

=== Conclusion ===
This shows by example how to redirect Lua output to a CEGUI window.

[[User:DEvil HUnter]] 22:20 - 28. August 2012 (MEZ)

[[Category:Tutorials]]

Getting Started with Lua and CEGUI

2012-08-28T19:08:54Z

Devil hunter: now it is working with cegui 0.7

{{VersionBadge|0.7}}
The Lua scripting module for CEGUI is based on [http://www.lua.org Lua 5.1] and [http://www.codenix.com/~tolua/ tolua++ 1.0.6pre2-1].
As these libraries were difficult (or impossible) to find in working precompiled versions, I decided to include them with the scripting module (That is the source is included, and there are makefiles available).
There is no link to the tolua++ version used on their website, but it's available [http://www.codenix.com/~tolua/tolua++_1.0.6pre2-1.tar.gz here]

When using CEGUI with a scripting module a lot of the interface programming can be replaced by scripts, these script can be modified and used without recompling your program, thus leave more time for tweaking your UI instead of waiting for your compiler to finish.

The current Lua script module is still fairly early in development.
It supports most of the core system, and the base window class, more specific widgets can currently only be configured using the properties system.

At this time the Lua script module is only in CVS.

Ok. Let's get started. I assume that you are familiar with the CEGUI basics. Initialisation, creating windows etc. and Lua, so I'll pick up from about there.

== Initialisation ==
The Lua scripting module exports all the manager classes and such it is possible to do the basic CEGUI initialization from Lua.

the basic CEGUI init sequence is like this:

#include "CEGUILua.h"

CEGUI::''YourRendererOfChoice''& renderer = CEGUI::''YourRendererOfChoice''::create();
CEGUI::''YourResourceProviderOfChoice''& rp= CEGUI::''YourResourceProviderOfChoice''::create();
CEGUI::''YourImageCodecOfChoice''& ic= CEGUI::''YourImageCodecOfChoice''::create();
CEGUI::LuaScriptModule& script_module = CEGUI::LuaScriptModule::create();
// (Pass 0 for the third argument, which is the xml parser to use. 0 means the default one)
System::create(renderer, reinterpret_cast<ResourceProvider*>(&rp), static_cast<XMLParser*>(0), reinterpret_cast<ImageCodec*>(&ic),&scriptmod,"cegui.config");

now the CEGUI::System is created and the scripting module is attached properly.

You would probably want to do some stuff if you are using custom functions in the init-script (cegui.config defines the init script later).

== Init / Exit Script ==
CEGUI supports a configuration file. The filename for this is an optional parameter to the CEGUI::System constructor. It defaults to "cegui.config".

This configuration file gives you the posibility to execute a script during system creation and destruction.
A configuration file could look like this:

<?xml version="1.0" ?>
<CEGUIConfig>
<Scripting
initScript="init_script.lua"
terminateScript="exit_script.lua"
/>
</CEGUIConfig>

init_script.lua is a text file containing the Lua script code to be executed on init.
Here's an example:

-- get CEGUI singletons
local logger = CEGUI.Logger:getSingleton()
logger:logEvent( ">>> Init script says hello" )
--logger:setLoggingLevel( CEGUI.Informative )

-- get a local reference to the singletons we use (not required)
local system = CEGUI.System:getSingleton()
local fontman = CEGUI.FontManager:getSingleton()
local schememan = CEGUI.SchemeManager:getSingleton()

-- load schemes
schememan:create( "TaharezLook.scheme" )
schememan:create( "WindowsLook.scheme" )

-- load a default font
fontman:create( "DejaVuSans-10.font" )

-- set default mouse cursor
system:setDefaultMouseCursor( "TaharezLook","MouseArrow" )

logger:logEvent( "<<< Init script says goodbye" )

you don't have to have both init and exit scripts, but if you allocate "global" memory from the initscript you should free it in the exit script (or somewhere else appropriate).

Now you know how to initialise CEGUI with the Lua scripting module.
More tutorials will follow soon with more advanced topics.

You can execute more scripts from c side like this:

System::getSingleton().executeScriptFile("demo8.lua");

or from Lua like this:

system:executeScriptFile("demo8.lua")

As you can see all CEGUI functions are exposed to Lua and you can use them from there.

--[[User:Lindquist]] 19:25, 5 May 2005 (BST)
updated to 0.7 --[[User:DEvil HUnter]] 21:10, 28 August 2012 (MEZ)

[[Category:Tutorials]]

The Beginner Guide - Overview to CEGUI

2012-08-28T18:11:07Z

Devil hunter: /* CEGUI subprojects */

{{VersionBadge|0.7}}
{{Series|The Beginner Guide|0}}

{{notice|message=This tutorial is for CEGUI versions up to 0.7.7. For later releases, see the tutorials in [http://www.cegui.org.uk/docs/current/ the main documentation].}}

CEGUI is a GUI library so it's job is to create your GUI.
CEGUI makes use of some libraries and is divided in a number of subprojects. This article should just give you a simple overview.

=== Creating your GUI ===
There are different options to create/discribe your GUI (more in the next Guide).
* constuct it from c++ code
* constuct it using Lua or python code
* constuct it using XML (and the events from code)

=== Files/Fileformats ===
CEGUI uses different files/fileformats to load your stuff.
*[http://www.cegui.org.uk/docs/current/xml_imageset.html imageset] to use images and imagesets
*[http://www.cegui.org.uk/docs/current/xml_font.html font] for fonts ;)
*[http://www.cegui.org.uk/docs/current/xml_scheme.html scheme] discribes the look
*[http://www.cegui.org.uk/docs/current/xml_layout.html layout] discribes your GUI windows and their parts
*[http://www.cegui.org.uk/docs/current/xml_config.html config] a configuration (you do not need this)
*[http://www.cegui.org.uk/docs/current/xml_animation.html animation] animations for advanced behavior
*[http://www.cegui.org.uk/docs/current/fal_man.html falagard xml] falagard files provide lookAndFeel for advanced behavior or completely new window types

=== CEGUI subprojects ===
CEGUI divides into the following subprojects:
*Render modules (discussed in the next Guide)
*falagard window renderer
*image codecs
**tga image codec
**silly image codec
**devil image codec
**freeimage image codec
**corona image codec
**stb image codec
*XML parser
**expat parser
**xerces parser
**tinyxml parser
**rapidxml parser
**libxml parser
*Scripting modules
**Lua (comming with tolua++)
**Python

You can choose what module to use in the build-config file (projects/premake/config.lua). 
You need a renderer to display your GUI. Which one to use depends on your Engine/Application you want to programm. 
You also need an image codec and a XML parser. The main differences of the modules are in performance so default should be fine for you as a Beginner. 
You can use Lua or Python scripting module or none depending on what you like most. 
The [http://www.cegui.org.uk/docs/current/fal_tut1.html Falagard window renderer] will be necessary for advanced features like new window forms and behavior. Falagard is the "factory" that combines the engine(rendererset) with the layout (the LooknFeel). With Falagard WR you can make something like "blueprints" of windows.

=== Conclusion ===
This provides a very basic overview to CEGUI.

[[User:DEvil HUnter]] 19:30, 28 August 2012 (MEZ)

[[Category:Tutorials]]

The Beginner Guide - Overview to CEGUI

2012-08-28T18:08:59Z

Devil hunter: /* CEGUI subprojects */

{{VersionBadge|0.7}}
{{Series|The Beginner Guide|0}}

{{notice|message=This tutorial is for CEGUI versions up to 0.7.7. For later releases, see the tutorials in [http://www.cegui.org.uk/docs/current/ the main documentation].}}

CEGUI is a GUI library so it's job is to create your GUI.
CEGUI makes use of some libraries and is divided in a number of subprojects. This article should just give you a simple overview.

=== Creating your GUI ===
There are different options to create/discribe your GUI (more in the next Guide).
* constuct it from c++ code
* constuct it using Lua or python code
* constuct it using XML (and the events from code)

=== Files/Fileformats ===
CEGUI uses different files/fileformats to load your stuff.
*[http://www.cegui.org.uk/docs/current/xml_imageset.html imageset] to use images and imagesets
*[http://www.cegui.org.uk/docs/current/xml_font.html font] for fonts ;)
*[http://www.cegui.org.uk/docs/current/xml_scheme.html scheme] discribes the look
*[http://www.cegui.org.uk/docs/current/xml_layout.html layout] discribes your GUI windows and their parts
*[http://www.cegui.org.uk/docs/current/xml_config.html config] a configuration (you do not need this)
*[http://www.cegui.org.uk/docs/current/xml_animation.html animation] animations for advanced behavior
*[http://www.cegui.org.uk/docs/current/fal_man.html falagard xml] falagard files provide lookAndFeel for advanced behavior or completely new window types

=== CEGUI subprojects ===
CEGUI divides into the following subprojects:
*Render modules (discussed in the next Guide)
*falagard window renderer
*image codecs
**tga image codec
**silly image codec
**devil image codec
**freeimage image codec
**corona image codec
**stb image codec
*XML parser
**expat parser
**xerces parser
**tinyxml parser
**rapidxml parser
**libxml parser
*Scripting modules
**Lua (comming with tolua++)
**Python

You can choose what module to use in the build-config file (projects/premake/config.lua). 
You need a renderer to display your GUI. Which one to use depends on your Engine/Application you want to programm. 
You also need an image codec and a XML parser. The main differences of the modules are in performance so default should be fine for you as a Beginner. 
You can use Lua or Python scripting module or none depending on what you like most. 
The [http://www.cegui.org.uk/docs/current/fal_tut1.html Falagard window renderer] will be necessary for advanced features like new window forms and behavior. With Falagard WR you can make something like "blueprints" of windows.

=== Conclusion ===
This provides a very basic overview to CEGUI.

[[User:DEvil HUnter]] 19:30, 28 August 2012 (MEZ)

[[Category:Tutorials]]

The Beginner Guide - Overview to CEGUI

2012-08-28T18:06:15Z

Devil hunter: /* CEGUI subprojects */

{{VersionBadge|0.7}}
{{Series|The Beginner Guide|0}}

{{notice|message=This tutorial is for CEGUI versions up to 0.7.7. For later releases, see the tutorials in [http://www.cegui.org.uk/docs/current/ the main documentation].}}

CEGUI is a GUI library so it's job is to create your GUI.
CEGUI makes use of some libraries and is divided in a number of subprojects. This article should just give you a simple overview.

=== Creating your GUI ===
There are different options to create/discribe your GUI (more in the next Guide).
* constuct it from c++ code
* constuct it using Lua or python code
* constuct it using XML (and the events from code)

=== Files/Fileformats ===
CEGUI uses different files/fileformats to load your stuff.
*[http://www.cegui.org.uk/docs/current/xml_imageset.html imageset] to use images and imagesets
*[http://www.cegui.org.uk/docs/current/xml_font.html font] for fonts ;)
*[http://www.cegui.org.uk/docs/current/xml_scheme.html scheme] discribes the look
*[http://www.cegui.org.uk/docs/current/xml_layout.html layout] discribes your GUI windows and their parts
*[http://www.cegui.org.uk/docs/current/xml_config.html config] a configuration (you do not need this)
*[http://www.cegui.org.uk/docs/current/xml_animation.html animation] animations for advanced behavior
*[http://www.cegui.org.uk/docs/current/fal_man.html falagard xml] falagard files provide lookAndFeel for advanced behavior or completely new window types

=== CEGUI subprojects ===
CEGUI divides into the following subprojects:
*Render modules (discussed in the next Guide)
*falagard window renderer
*image codecs
**tga image codec
**silly image codec
**devil image codec
**freeimage image codec
**corona image codec
**stb image codec
*XML parser
**expat parser
**xerces parser
**tinyxml parser
**rapidxml parser
**libxml parser
*Scripting modules
**Lua (comming with tolua++)
**Python

You can choose what module to use in the build-config file (projects/premake/config.lua). 
You need a renderer to display your GUI. Which one to use depends on your Engine/Application you want to programm. 
You also need an image codec and a XML parser. The main differences of the modules are in performance so default should be fine for you as a Beginner. 
You can use Lua or Python scripting module or none depending on what you like most. 
The Falagard window renderer will be necessary for advanced features like new window forms and behavior. With Falagard WR you can make something like "blueprints" of windows.

=== Conclusion ===
This provides a very basic overview to CEGUI.

[[User:DEvil HUnter]] 19:30, 28 August 2012 (MEZ)

[[Category:Tutorials]]

The Beginner Guide - Overview to CEGUI

2012-08-28T17:56:15Z

Devil hunter:

{{VersionBadge|0.7}}
{{Series|The Beginner Guide|0}}

{{notice|message=This tutorial is for CEGUI versions up to 0.7.7. For later releases, see the tutorials in [http://www.cegui.org.uk/docs/current/ the main documentation].}}

CEGUI is a GUI library so it's job is to create your GUI.
CEGUI makes use of some libraries and is divided in a number of subprojects. This article should just give you a simple overview.

=== Creating your GUI ===
There are different options to create/discribe your GUI (more in the next Guide).
* constuct it from c++ code
* constuct it using Lua or python code
* constuct it using XML (and the events from code)

=== Files/Fileformats ===
CEGUI uses different files/fileformats to load your stuff.
*[http://www.cegui.org.uk/docs/current/xml_imageset.html imageset] to use images and imagesets
*[http://www.cegui.org.uk/docs/current/xml_font.html font] for fonts ;)
*[http://www.cegui.org.uk/docs/current/xml_scheme.html scheme] discribes the look
*[http://www.cegui.org.uk/docs/current/xml_layout.html layout] discribes your GUI windows and their parts
*[http://www.cegui.org.uk/docs/current/xml_config.html config] a configuration (you do not need this)
*[http://www.cegui.org.uk/docs/current/xml_animation.html animation] animations for advanced behavior
*[http://www.cegui.org.uk/docs/current/fal_man.html falagard xml] falagard files provide lookAndFeel for advanced behavior or completely new window types

=== CEGUI subprojects ===
CEGUI divides into the following subprojects:
*Render modules (discussed in the next Guide)
*falagard window renderer
*image codecs
**tga image codec
**silly image codec
**devil image codec
**freeimage image codec
**corona image codec
**stb image codec
*XML parser
**expat parser
**xerces parser
**tinyxml parser
**rapidxml parser
**libxml parser
*Scripting modules
**Lua (comming with tolua++)
**Python

You can choose what module to use in the build-config file (projects/premake/config.lua). 
You need a renderer to display your GUI. Which one to use depends on your Engine/Application you want to programm. 
You also need an image codec and a XML parser. The main differences of the modules are in performance so default should be fine for you as a Beginner. 
You can use Lua or Python scripting module or none depending on what you like most. 
The Falagard window renderer will be necessary for advanced features like new window forms and behavior.

=== Conclusion ===
This provides a very basic overview to CEGUI.

[[User:DEvil HUnter]] 19:30, 28 August 2012 (MEZ)

[[Category:Tutorials]]

The Beginner Guide - Overview to CEGUI

2012-08-28T17:54:20Z

Devil hunter:

{{VersionBadge|0.7}}
{{Series|The Beginner Guide|0}}

{{notice|message=This tutorial is for CEGUI versions up to 0.7.7. For later releases, see the tutorials in [http://www.cegui.org.uk/docs/current/ the main documentation].}}

CEGUI is a GUI library so it's job is to create your GUI.
CEGUI makes use of some libraries and is divided in a number of subprojects. This article should just give you a simple overview.

There are different options to create/discribe your GUI (more in the next Guide).
* constuct it from c++ code
* constuct it using Lua or python code
* constuct it using XML (and the events from code)

CEGUI uses different files/fileformats to load your stuff.
*[http://www.cegui.org.uk/docs/current/xml_imageset.html imageset] to use images and imagesets
*[http://www.cegui.org.uk/docs/current/xml_font.html font] for fonts ;)
*[http://www.cegui.org.uk/docs/current/xml_scheme.html scheme] discribes the look
*[http://www.cegui.org.uk/docs/current/xml_layout.html layout] discribes your GUI windows and their parts
*[http://www.cegui.org.uk/docs/current/xml_config.html config] a configuration (you do not need this)
*[http://www.cegui.org.uk/docs/current/xml_animation.html animation] animations for advanced behavior
*[http://www.cegui.org.uk/docs/current/fal_man.html falagard xml] falagard files provide lookAndFeel for advanced behavior or completely new window types

CEGUI divides into the following subprojects:
*Render modules (discussed in the next Guide)
*falagard window renderer
*image codecs
**tga image codec
**silly image codec
**devil image codec
**freeimage image codec
**corona image codec
**stb image codec
*XML parser
**expat parser
**xerces parser
**tinyxml parser
**rapidxml parser
**libxml parser
*Scripting modules
**Lua (comming with tolua++)
**Python

You can choose what module to use in the build-config file (projects/premake/config.lua). 
You need a renderer to display your GUI. Which one to use depends on your Engine/Application you want to programm. 
You also need an image codec and a XML parser. The main differences of the modules are in performance so default should be fine for you as a Beginner. 
You can use Lua or Python scripting module or none depending on what you like most. 
The Falagard window renderer will be necessary for advanced features like new window forms and behavior.

=== Conclusion ===
This provides a very basic overview to CEGUI.

[[User:DEvil HUnter]] 19:30, 28 August 2012 (MEZ)

[[Category:Tutorials]]

The Beginner Guide - Overview to CEGUI

2012-08-28T17:51:42Z

Devil hunter:

{{VersionBadge|0.7}}
{{Series|The Beginner Guide|0}}

{{notice|message=This tutorial is for CEGUI versions up to 0.7.7. For later releases, see the tutorials in [http://www.cegui.org.uk/docs/current/ the main documentation].}}

CEGUI is a GUI library so it's job is to create your GUI.
CEGUI makes use of some libraries and is divided in a number of subprojects. This article should just give you a simple overview.

There are different options to create/discribe your GUI (more in the next Guide).
# constuct it from c++ code
# constuct it using Lua or python code
# constuct it using XML (and the events from code)

CEGUI uses different files/fileformats to load your stuff.
#[http://www.cegui.org.uk/docs/current/xml_imageset.html imageset] to use images and imagesets
#[http://www.cegui.org.uk/docs/current/xml_font.html font] for fonts ;)
#[http://www.cegui.org.uk/docs/current/xml_scheme.html scheme] discribes the look
#[http://www.cegui.org.uk/docs/current/xml_layout.html layout] discribes your GUI windows and their parts
#[http://www.cegui.org.uk/docs/current/xml_config.html config] a configuration (you do not need this)
#[http://www.cegui.org.uk/docs/current/xml_animation.html animation] animations for advanced behavior
#[http://www.cegui.org.uk/docs/current/fal_man.html falagard xml] falagard files provide lookAndFeel for advanced behavior or completely new window types

CEGUI divides into the following subprojects:
#Render modules (discussed in the next Guide)
#falagard window renderer
#Image codecs
##tga image codec
##silly image codec
##devil image codec
##freeimage image codec
##corona image codec
##stb image codec
#XML parser
##expat parser
##xerces parser
##tinyxml parser
##rapidxml parser
##libxml parser
#Scripting modules
##Lua (comming with tolua++)
##Python

You can choose what module to use in the build-config file (projects/premake/config.lua). 
You need a renderer to display your GUI. Which one to use depends on your Engine/Application you want to programm. 
You also need an image codec and a XML parser. The main differences of the modules are in performance so default should be fine for you as a Beginner. 
You can use Lua or Python scripting module or none depending on what you like most. 
The Falagard window renderer will be necessary for advanced features like new window forms and behavior.

=== Conclusion ===
This provides a very basic overview to CEGUI.

[[User:DEvil HUnter]] 19:30, 28 August 2012 (MEZ)

[[Category:Tutorials]]

The Beginner Guide - Overview to CEGUI

2012-08-28T17:42:09Z

Devil hunter: simple overview to CEGUI

{{VersionBadge|0.7}}
{{Series|The Beginner Guide|0}}

{{notice|message=This tutorial is for CEGUI versions up to 0.7.7. For later releases, see the tutorials in [http://www.cegui.org.uk/docs/current/ the main documentation].}}

CEGUI is a GUI library so it's job is to create your GUI.
CEGUI makes use of some libraries and is divided in a number of subprojects. This article should just give you a simple overview.

There are different options to create/discribe your GUI (more in the next Guide).
# constuct it from c++ code
# constuct it using Lua or python code
# constuct it using XML (and the events from code)

CEGUI uses different files/fileformats to load your stuff.
#[http://www.cegui.org.uk/docs/current/xml_imageset.html imageset] to use images and imagesets
#[http://www.cegui.org.uk/docs/current/xml_font.html font] for fonts ;)
#[http://www.cegui.org.uk/docs/current/xml_scheme.html scheme] discribes the look
#[http://www.cegui.org.uk/docs/current/xml_layout.html layout] discribes your GUI windows and their parts
#[http://www.cegui.org.uk/docs/current/xml_config.html config] a configuration (you do not need this)
#[http://www.cegui.org.uk/docs/current/xml_animation.html animation] animations for advanced behavior
#[http://www.cegui.org.uk/docs/current/fal_man.html falagard xml] falagard files provide lookAndFeel for advanced behavior ???

CEGUI divides into the following subprojects:
#Render modules (discussed in the next Guide)
#falagard window renderer
#Image codecs
##tga image codec
##silly image codec
##devil image codec
##freeimage image codec
##corona image codec
##stb image codec
#XML parser
##expat parser
##xerces parser
##tinyxml parser
##rapidxml parser
##libxml parser
#Scripting modules
##Lua
##Python

You can choose what module to use in the build-config file (projects/premake/config.lua). 
You need a renderer to display your GUI. Which one to use depends on your Engine/Application you want to programm. 
You also need an image codec and a XML parser. The main differences of the modules are in performance so default should be fine for you as a Beginner. 
You can use Lua or Python scripting module or none depending on what you like most. 
The Falagard window renderer will be necessary for advanced features like ???.

=== Conclusion ===
This provides a very basic overview to CEGUI.

[[User:DEvil HUnter]] 19:30, 28 August 2012 (MEZ)

[[Category:Tutorials]]