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

Lucebac TODO

2015-07-04T18:23:06Z

Lucebac:

== Open ==
* write SDL2 image codec
* make SampleBrowser compatible to SDL2
* make SampleBrowser compatible to GLFW3

== Finished ==
* finish application templates

User:Lucebac

2015-03-19T23:24:19Z

Lucebac: Created page with "ToDo-List: http://cegui.org.uk/wiki/Lucebac_TODO"

ToDo-List: http://cegui.org.uk/wiki/Lucebac_TODO

Lucebac TODO

2015-03-19T23:22:59Z

Lucebac: Created page with "* write SDL2 image codec * make SampleBrowser compatible to SDL2 * make SampleBrowser compatible to GLFW3 * finish application templates"

* write SDL2 image codec
* make SampleBrowser compatible to SDL2
* make SampleBrowser compatible to GLFW3
* finish application templates

Building from source

2015-01-03T15:19:48Z

Lucebac: use tabber

{{VersionBadge|0.8}}
{{notice|message=This article is a work in progress and thus incomplete}}

==Official documentation==
PLEASE use the documentation of your CEGUI version as your main source of information, e.g.: [http://static.cegui.org.uk/docs/current/compiling.html Latest API docs for building/compiling]

==Stable Releases==
Source code from the stable mercurial branches is released at various points in time and made available as source code packages. These packages can be found on the [[Downloads]] page.

==Mercurial==
The source code is kept in mercurial repositories at bitbucket.org. There are code repositories for the main CEGUI libraries as well as for other related items.

A mercurial client (GUI or <abbr title="Command-line Interface">CLI</abbr>) is required to access the mercurial repositories and download code. The command necessary to obtain a copy of the code is 'clone':
hg clone SOURCE DESTINATION
where ''source'' is the URL of the repository to clone and ''destination'' is the local directory. To download a copy of CEGUI and place it in the ''cegui-source'' directory, you might use the following command:
hg clone https://bitbucket.org/cegui/cegui cegui-source

Once you have this, the cloned repository is updated to the default (latest, unstable) code, so you most likely will want to switch to a stable branch instead, like this:
hg update -C v0-8
{{Warning|Be aware that the -C option here will discard any local file changes without additional warning}}

===Repositories===
The available repositories can be found [https://bitbucket.org/cegui/ here] where you can also browse their code from your web browser. A couple of examples:
* Core CEGUI libraries - [https://bitbucket.org/cegui/cegui/src cegui]
hg clone https://bitbucket.org/cegui/cegui cegui-source
* CEED unified editor - [https://bitbucket.org/cegui/ceed/src CEED]
hg clone https://bitbucket.org/cegui/ceed

{{Note|The difference between the ''hg clone'' URLs and the web-interface URLs is the appended ''/src'' on the web URLs}}

=Building=
CEGUI uses [http://www.cmake.org/ CMake] as a build system. CMake is cross-platform and open source so it's available on many platforms. There are binaries available for Windows, Mac and Linux, although on Linux your distribution will most probably have a CMake package ready. Make sure you have some 2.8.X version installed because CMake 3.x.x will break with our scripts at the moment.
{{Note|CMake does not build the code directly, it generates native makefiles and workspaces that can be used in the compiler environment of your choice.}}
Thanks to CMake and CEGUI's modular design, configuring and building CEGUI is a breeze.

The following instructions assume you have a ''cegui'' directory somewhere on your system so that all CEGUI related projects reside in it.
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
cegui/CEED (editor)
cegui/... (something else)

==CEGUI==
This section will focus on building the core CEGUI libraries, which is all you need to use CEGUI in a project. Most people will also want [[Building from source#CEED|CEED]], the unified editor for CEGUI, but it is not required.

===Dependencies===
CEGUI can be built without any dependencies to outside libraries. However, typical configurations require [http://en.wikipedia.org/wiki/FreeType FreeType], a rendering module, an XML parser, and an image codec. CEGUI already provides support for several external libraries thanks to its modular design:

{| class="wikitable sortable" border="1" style="text-align: center;"
|+ External libraries supported by CEGUI
|-
! scope="col" | Type
! scope="col" | Name
! scope="col" halign="left" | Additional information

|- style="background: #eaffe8;"
| rowspan="5" | Rendering Module
| OpenGL 3.2+ Core Profile
| style="text-align: left;" | Uses the programmable rendering pipeline and only non-deprecated functionality and is therefore compatible with OpenGL Core Profile contexts (available since OpenGL 3.2). It can also be used with older OpenGL versions and/or Compatibility Profile, as long as the required functionalities are available.
|- style="background: #eaffe8;"
| OpenGL
| style="text-align: left;" | Uses the fixed-function rendering pipeline. It is designed to be compatible with very early OpenGL versions, as early as OpenGL 1.2, using some OpenGL extensions.
|- style="background: #eaffe8;"
| Microsoft Direct3D
| style="text-align: left;" | Microsoft Direct3D 9, 10, and 11 are supported using seperate modules.
|- style="background: #eaffe8;"
| OGRE
| style="text-align: left;" | The latest stable Ogre version is supported in the releases.
|- style="background: #eaffe8;"
| Irrlicht
| style="text-align: left;" | The latest stable Irrlicht version is supported in the releases.

|- style="background: #edfcfb;"
| rowspan="4" | Image Codec Module
| SILLY
| style="text-align: left;" | Default image codec, which is based on the SILLY library. Supports many formats, see [[SILLY]]
|- style="background: #edfcfb;"
| DevIL
| style="text-align: left;" | Image codec based on the DevIL library.
|- style="background: #edfcfb;"
| FreeImage
| style="text-align: left;" | Image codec based on the FreeImage library.
|- style="background: #edfcfb;"
| OGRE
| style="text-align: left;" | Image codec that loads data via image loading facilities of OGRE.

|- style="background: #dfeff1;"
| rowspan="3" | Resource Provider Module
| Default
| style="text-align: left;" | The default resource provider of CEGUI uses standard cross-platform file-access.
|- style="background: #dfeff1;"
| OGRE
| style="text-align: left;" | Ogre users can use CEGUI's Ogre ResourceManager. This way the resource locations of CEGUI can be specified in the same way as it is done for the Ogre resources already.
|- style="background: #dfeff1;"
| minizip
| style="text-align: left;" | CEGUI's MinizipResourceProvider allows users to provides the ability to load the resource files from locations within .zip files.

|- style="background: #e9ebfc;"
| rowspan="5" | XML Parser Module
| Expat
| style="text-align: left;" | Ddefault XML parser of CEGUI. Uses the Expat library for XML parsing.
|- style="background: #e9ebfc;"
| LibXML2
| style="text-align: left;" | Uses the LibXML2 library for XML parsing.
|- style="background: #e9ebfc;"
| RapidXml
| style="text-align: left;" | Uses the RapidXml library for XML parsing.
|- style="background: #e9ebfc;"
| TinyXML
| style="text-align: left;" | Uses the TinyXML library for XML parsing.
|- style="background: #e9ebfc;"
| Xerces-C++
| style="text-align: left;" | Uses the Xerces library for XML parsing. It can do schema validation using the .xsd files provided in CEGUI's resources.
|-

|- style="background: #fae9fc;"
| rowspan="1" | Font Module
| FreeType
| style="text-align: left;" | FreeType is the default font library of CEGUI and currently the only officially supported one.

|- style="background: #f4e0e7;"
| rowspan="1" | Regular Expression Module
| Perl Compatible Regular Expressions (PCRE)
| style="text-align: left;" | Default regular expression library and currently the only officially supported one. Uses the PCRE library.

|- style="background: #fcf3e9;"
| rowspan="2" | Scripting Module
| Lua
| style="text-align: left;" | Provides lua bindings using tolua++.
|- style="background: #fcf3e9;"
| Python
| style="text-align: left;" | Official Python bindings are available using [[PyCEGUI]]

|- style="background: #f2eeca;"
| rowspan="2" | Memory Management
| OGRE
| style="text-align: left;" | Ogre's memory allocator can optionally be used for CEGUI's memory management.
|- style="background: #f2eeca;"
| nedmalloc
| style="text-align: left;" | nedmalloc can optionally be used as memory allocator.

|- style="background: #f6fce9;"
| rowspan="2" | Bi-Directional Language Module
| MiniBIDI
| style="text-align: left;" | MiniBIDI based implementation of CEGUI's Bidi visual mapping.
|- style="background: #f6fce9;"
| FriBIDI
| style="text-align: left;" | FriBIDI based implementation of CEGUI's Bidi visual mapping.

|}

CMake will automatically detect which external libraries exist on your system and will build CEGUI accordingly so make sure you install any external libraries you want to use before proceeding.
{{Note|You can turn off individual CEGUI modules from building (even if you have the required libraries installed) by changing the default [[Building from source#Build Options|Build Options]].}}

===Directories===
If you're following the directory structure outlined above, you should have something like:
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
Create the directory ''cegui/cegui_mk2/build'' and clone the ''cegui'' repository inside cegui/cegui_mk2 with the name ''source''. Example:
{{CLI|~/cegui|mkdir cegui_mk2/build}}
{{CLI|~/cegui|hg clone https://bitbucket.org/cegui/cegui cegui_mk2/source}}
The result should be:
cegui/cegui_mk2 (core CEGUI)
cegui/cegui_mk2/build (will build here)
cegui/cegui_mk2/source (the mercurial repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

===Build Options===
There are several build options (or variables) supported by the CEGUI build system. To view them, you can use the command like or CMake GUI.

====Using the command line====
Enter the ''build'' directory and issue the following cmake command:
{{CLI|~/cegui/cegui_mk2|cd build}}
{{CLI|~/cegui/cegui_mk2/build|cmake -LH ../source}}
{{Note|On systems that default to python3 (like Arch Linux) you have to tell it to use python2 like this:}}
{{CLI|~/cegui/cegui_mk2/build|2=cmake -LH -DPYTHON_EXECUTABLE=/usr/bin/python2 ../source}}
CMake will run, it will look for the build systems available on your platform, will look for dependencies and then will print a list of variables, along with their description. For example:
// Select whether bi-directional text is enabled and which library should be used:
0: Disabled.
1: Use integrated minibidi library.
2: Use external fribidi library.
CEGUI_BIDI_SUPPORT:STRING=0
// Specifies whether to use embedded GLEW when external library was found
CEGUI_BUILD_EMBEDDED_GLEW:BOOL=OFF

====Using CMake GUI====
Start cmake-gui, select our ''source'' and ''build'' directories and click the ''Configure'' button. The available options will be listed in the main window. You can hover the mouse over an option and CMake will show a tooltip with a more detailed description.

{{Note|Changing the options and building is explained below, in [[#Building|Building]].}}

===Building===
====Configuring and Generating makefiles====
The first step is to use CMake to configure the build and generate native makefiles. Without making any configuration changes, the command would be:
{{CLI|~/cegui/cegui_mk2/build|cmake ../source}}
The same can be done using the CMake GUI. Select the ''source'' and ''build'' directories, click configure and finally click generate.

The build options can be changed via the GUI or via the CLI. If, for example, we want to turn off the slotted installation option and the python bindings we would run cmake like this:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source -DCEGUI_SLOTTED_INSTALLATION:BOOL=OFF -DCEGUI_BUILD_PYTHON_MODULES:BOOL=OFF}}
{{Note|The python bindings are required by [[#CEED|CEED]] so don't disable them if you plan to use it.}}

Another noteworthy option is the installation path, which is where CEGUI will be installed if you plan to install it via ''make install''. Change the value of the CMAKE_INSTALL_PREFIX configuration variable to set it. Example:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source <other options here> -DCMAKE_INSTALL_PREFIX:PATH=/opt}}
so it will be installed in /opt/CEGUI (or /opt/CEGUI-0.8 if you use slotted installation).

====Make====
The second (and last required) step is using the generated native makefiles to build it. This is specific to your build environment; you may need to open the generated solution with MSVC or Xcode, or simply issue the ''make'' command.

<tabber>
GNU Make=
* You can speed ''make'' up significantly if you have a multi-core CPU by adding the ''-jN'' parameter, when N is the number of CPU cores on your machine.
{{CLI|~/cegui/cegui_mk2/build|make -j4}}
* Optionally, run ''make install'' to install the binaries and the shared datafiles on your system.
|-|
MSVC=
{{Todo|MSVC notes}}
|-|
Xcode=
{{Todo|Xcode notes}}
</tabber>

===Running the samples===
Now that the build has finished, you can run the sample applications to check your build. The binaries should be in the ''bin'' directory:
cegui/cegui_mk2/build/bin

The samples may fail to run initially because they can't find the required data files.
According to ''"cegui/cegui_mk2/source/Samples/common/include/CEGUISamplesConfig.h.in"'', the samples will look for the datafiles on ''"../datafiles"'' on Windows and on ''${CMAKE_INSTALL_PREFIX}/${CEGUI_DATA_INSTALL_DIR}'' on other platforms.

It is possible to change this path without rebuilding, using the environment variable ''CEGUI_SAMPLE_DATAPATH''.
<tabber>
Linux=
{{CLI|~/cegui/cegui_mk2/build|2=CEGUI_SAMPLE_DATAPATH=../source/datafiles bin/CEGUIDemo8-0.8}}
|-|
Windows=
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=SET CEGUI_SAMPLE_DATAPATH="C:\Users\User\cegui\cegui_mk2\source\datafiles"}}
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=bin/CEGUIDemo8-0.8.exe}}
</tabber>

===Documentation===
{{Note|The documentation for stable releases can be found online [http://www.cegui.org.uk/docs/current here]}}

The documentation is written in doxygen format so you need [http://www.doxygen.org/ Doxygen] to build it. If you want to generate the nice class diagrams too, you need to install [http://graphviz.org/ Graphviz].

Building the docs with the default options is easy:
{{CLI|~/cegui/cegui_mk2/build|cd ../source/doc/doxygen}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|doxygen}}

This will create a directory named ''html'' with plenty of files, just open ''index.html''.

If you'd rather change some of doxygen's options, you can edit the file ''source/doc/doxygen/doxyfile'' or, alternatively, use ''doxywizard'' (GUI).
To change doxygen's output directory, one might do something like this:
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|mkdir ../../../build/doc}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|nano doxyfile or use your editor of choice to edit ''doxyfile''}}

Find the line
OUTPUT_DIRECTORY =
and change it to
OUTPUT_DIRECTORY = ../../../build/doc

Now run doxygen and it will create the html docs in ''build/doc''.

==CEED==
CEED is the new CEGUI unified editor. It can edit layouts and imagesets, supports projects and multiple open file tabs, visual and source editing, preview and more. Please see [[CEED]] for a detailed description.

CEED is written in [http://www.python.org/ Python] so there's no need to build it; all that's required is Python2 and it's dependencies.

{{Note|If you'd rather use a stable package that includes dependencies, please follow [[Downloads]]}}

===Dependencies===
CEED requires a Python 2 interpreter, version 2.6 or higher.
Apart from [[PyCEGUI]] (the CEGUI Python bindings), it depends on the following libraries:
* PyOpenGL
* Qt4, PySide (+ PySide Tools)
* Boost.Python

<tabber>
Windows=
{{Todo|Windows dependencies notes}}
|-|
Mac=
{{Todo|Mac dependencies notes}}
|-|
Arch Linux=
You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR).
{{Note|The packages from AUR may have been included in the ''[community]'' repository by now so check there first.}}
|-|
Debian=
;Wheezy

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list and then:

{{CLI||sudo apt-get update}}
{{CLI||sudo apt-get install cmake python-opengl pyside-tools boost-python}}
|-|
Fedora=
You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools.
|-|
Gentoo=
You can use these supplied ebuilds:[https://bitbucket.org/ChrisTrenkamp/gentoo-ogre3d-tools]. Copy these ebuilds to your local overlay[http://en.gentoo-wiki.com/wiki/Overlay#Local_Overlays], add the necessary options to your package.keywords and package.use files, and run '''''emerge -av dev-util/ceed'''''
</tabber>

===Running===
{{Todo|Update this section when CEED/CEGUI 0.8 is released}}
If you're following the directory structure outlined in [[#Building|Building]], you should have something like:
cegui (root working directory)
cegui/CEED (CEED repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

Running the main ''ceed-gui'' application could be as simple as:
{{CLI|~/cegui/CEED|2=PYTHONPATH=.:$PYTHONPATH python2 bin/ceed-gui}}

If you don't have PyCEGUI installed system-wide but built it in ''cegui/cegui_mk2/build'', you can run ''ceed-gui'' like this:
{{CLI|~/cegui/CEED|2=PYTHONPATH=../cegui_mk2/build/lib:.:$PYTHONPATH python2 bin/ceed-gui}}

====Running from Mercurial====
If you've cloned the CEED mercurial repository, you will most likely get the following error when you try to run ''ceed-gui'':
ImportError: No module named mainwindow
This is because the compiled .ui files are not part of the repository. Edit the file ''ceed/version.py'' with your favorite text editor and change the value of '''CEED_developerMode''' from '''False''' to '''True'''.

=Troubleshooting=
If you encounter a problem that's not listed here, please make a post on the appropriate forum: [http://www.cegui.org.uk/phpBB2/viewforum.php?f=10 CEGUI], [http://www.cegui.org.uk/phpBB2/viewforum.php?f=15 CEED].

For comments about this article, you may use it's discussion page.

=Related articles=
* [[Eclipse and CEGUI]]
* [[Contribution|Contributing to the development of CEGUI]]

[[Category:HowTo]]

Building from source

2015-01-03T15:18:13Z

Lucebac: use tabber

{{VersionBadge|0.8}}
{{notice|message=This article is a work in progress and thus incomplete}}

==Official documentation==
PLEASE use the documentation of your CEGUI version as your main source of information, e.g.: [http://static.cegui.org.uk/docs/current/compiling.html Latest API docs for building/compiling]

==Stable Releases==
Source code from the stable mercurial branches is released at various points in time and made available as source code packages. These packages can be found on the [[Downloads]] page.

==Mercurial==
The source code is kept in mercurial repositories at bitbucket.org. There are code repositories for the main CEGUI libraries as well as for other related items.

A mercurial client (GUI or <abbr title="Command-line Interface">CLI</abbr>) is required to access the mercurial repositories and download code. The command necessary to obtain a copy of the code is 'clone':
hg clone SOURCE DESTINATION
where ''source'' is the URL of the repository to clone and ''destination'' is the local directory. To download a copy of CEGUI and place it in the ''cegui-source'' directory, you might use the following command:
hg clone https://bitbucket.org/cegui/cegui cegui-source

Once you have this, the cloned repository is updated to the default (latest, unstable) code, so you most likely will want to switch to a stable branch instead, like this:
hg update -C v0-8
{{Warning|Be aware that the -C option here will discard any local file changes without additional warning}}

===Repositories===
The available repositories can be found [https://bitbucket.org/cegui/ here] where you can also browse their code from your web browser. A couple of examples:
* Core CEGUI libraries - [https://bitbucket.org/cegui/cegui/src cegui]
hg clone https://bitbucket.org/cegui/cegui cegui-source
* CEED unified editor - [https://bitbucket.org/cegui/ceed/src CEED]
hg clone https://bitbucket.org/cegui/ceed

{{Note|The difference between the ''hg clone'' URLs and the web-interface URLs is the appended ''/src'' on the web URLs}}

=Building=
CEGUI uses [http://www.cmake.org/ CMake] as a build system. CMake is cross-platform and open source so it's available on many platforms. There are binaries available for Windows, Mac and Linux, although on Linux your distribution will most probably have a CMake package ready. Make sure you have some 2.8.X version installed because CMake 3.x.x will break with our scripts at the moment.
{{Note|CMake does not build the code directly, it generates native makefiles and workspaces that can be used in the compiler environment of your choice.}}
Thanks to CMake and CEGUI's modular design, configuring and building CEGUI is a breeze.

The following instructions assume you have a ''cegui'' directory somewhere on your system so that all CEGUI related projects reside in it.
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
cegui/CEED (editor)
cegui/... (something else)

==CEGUI==
This section will focus on building the core CEGUI libraries, which is all you need to use CEGUI in a project. Most people will also want [[Building from source#CEED|CEED]], the unified editor for CEGUI, but it is not required.

===Dependencies===
CEGUI can be built without any dependencies to outside libraries. However, typical configurations require [http://en.wikipedia.org/wiki/FreeType FreeType], a rendering module, an XML parser, and an image codec. CEGUI already provides support for several external libraries thanks to its modular design:

{| class="wikitable sortable" border="1" style="text-align: center;"
|+ External libraries supported by CEGUI
|-
! scope="col" | Type
! scope="col" | Name
! scope="col" halign="left" | Additional information

|- style="background: #eaffe8;"
| rowspan="5" | Rendering Module
| OpenGL 3.2+ Core Profile
| style="text-align: left;" | Uses the programmable rendering pipeline and only non-deprecated functionality and is therefore compatible with OpenGL Core Profile contexts (available since OpenGL 3.2). It can also be used with older OpenGL versions and/or Compatibility Profile, as long as the required functionalities are available.
|- style="background: #eaffe8;"
| OpenGL
| style="text-align: left;" | Uses the fixed-function rendering pipeline. It is designed to be compatible with very early OpenGL versions, as early as OpenGL 1.2, using some OpenGL extensions.
|- style="background: #eaffe8;"
| Microsoft Direct3D
| style="text-align: left;" | Microsoft Direct3D 9, 10, and 11 are supported using seperate modules.
|- style="background: #eaffe8;"
| OGRE
| style="text-align: left;" | The latest stable Ogre version is supported in the releases.
|- style="background: #eaffe8;"
| Irrlicht
| style="text-align: left;" | The latest stable Irrlicht version is supported in the releases.

|- style="background: #edfcfb;"
| rowspan="4" | Image Codec Module
| SILLY
| style="text-align: left;" | Default image codec, which is based on the SILLY library. Supports many formats, see [[SILLY]]
|- style="background: #edfcfb;"
| DevIL
| style="text-align: left;" | Image codec based on the DevIL library.
|- style="background: #edfcfb;"
| FreeImage
| style="text-align: left;" | Image codec based on the FreeImage library.
|- style="background: #edfcfb;"
| OGRE
| style="text-align: left;" | Image codec that loads data via image loading facilities of OGRE.

|- style="background: #dfeff1;"
| rowspan="3" | Resource Provider Module
| Default
| style="text-align: left;" | The default resource provider of CEGUI uses standard cross-platform file-access.
|- style="background: #dfeff1;"
| OGRE
| style="text-align: left;" | Ogre users can use CEGUI's Ogre ResourceManager. This way the resource locations of CEGUI can be specified in the same way as it is done for the Ogre resources already.
|- style="background: #dfeff1;"
| minizip
| style="text-align: left;" | CEGUI's MinizipResourceProvider allows users to provides the ability to load the resource files from locations within .zip files.

|- style="background: #e9ebfc;"
| rowspan="5" | XML Parser Module
| Expat
| style="text-align: left;" | Ddefault XML parser of CEGUI. Uses the Expat library for XML parsing.
|- style="background: #e9ebfc;"
| LibXML2
| style="text-align: left;" | Uses the LibXML2 library for XML parsing.
|- style="background: #e9ebfc;"
| RapidXml
| style="text-align: left;" | Uses the RapidXml library for XML parsing.
|- style="background: #e9ebfc;"
| TinyXML
| style="text-align: left;" | Uses the TinyXML library for XML parsing.
|- style="background: #e9ebfc;"
| Xerces-C++
| style="text-align: left;" | Uses the Xerces library for XML parsing. It can do schema validation using the .xsd files provided in CEGUI's resources.
|-

|- style="background: #fae9fc;"
| rowspan="1" | Font Module
| FreeType
| style="text-align: left;" | FreeType is the default font library of CEGUI and currently the only officially supported one.

|- style="background: #f4e0e7;"
| rowspan="1" | Regular Expression Module
| Perl Compatible Regular Expressions (PCRE)
| style="text-align: left;" | Default regular expression library and currently the only officially supported one. Uses the PCRE library.

|- style="background: #fcf3e9;"
| rowspan="2" | Scripting Module
| Lua
| style="text-align: left;" | Provides lua bindings using tolua++.
|- style="background: #fcf3e9;"
| Python
| style="text-align: left;" | Official Python bindings are available using [[PyCEGUI]]

|- style="background: #f2eeca;"
| rowspan="2" | Memory Management
| OGRE
| style="text-align: left;" | Ogre's memory allocator can optionally be used for CEGUI's memory management.
|- style="background: #f2eeca;"
| nedmalloc
| style="text-align: left;" | nedmalloc can optionally be used as memory allocator.

|- style="background: #f6fce9;"
| rowspan="2" | Bi-Directional Language Module
| MiniBIDI
| style="text-align: left;" | MiniBIDI based implementation of CEGUI's Bidi visual mapping.
|- style="background: #f6fce9;"
| FriBIDI
| style="text-align: left;" | FriBIDI based implementation of CEGUI's Bidi visual mapping.

|}

CMake will automatically detect which external libraries exist on your system and will build CEGUI accordingly so make sure you install any external libraries you want to use before proceeding.
{{Note|You can turn off individual CEGUI modules from building (even if you have the required libraries installed) by changing the default [[Building from source#Build Options|Build Options]].}}

===Directories===
If you're following the directory structure outlined above, you should have something like:
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
Create the directory ''cegui/cegui_mk2/build'' and clone the ''cegui'' repository inside cegui/cegui_mk2 with the name ''source''. Example:
{{CLI|~/cegui|mkdir cegui_mk2/build}}
{{CLI|~/cegui|hg clone https://bitbucket.org/cegui/cegui cegui_mk2/source}}
The result should be:
cegui/cegui_mk2 (core CEGUI)
cegui/cegui_mk2/build (will build here)
cegui/cegui_mk2/source (the mercurial repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

===Build Options===
There are several build options (or variables) supported by the CEGUI build system. To view them, you can use the command like or CMake GUI.

====Using the command line====
Enter the ''build'' directory and issue the following cmake command:
{{CLI|~/cegui/cegui_mk2|cd build}}
{{CLI|~/cegui/cegui_mk2/build|cmake -LH ../source}}
{{Note|On systems that default to python3 (like Arch Linux) you have to tell it to use python2 like this:}}
{{CLI|~/cegui/cegui_mk2/build|2=cmake -LH -DPYTHON_EXECUTABLE=/usr/bin/python2 ../source}}
CMake will run, it will look for the build systems available on your platform, will look for dependencies and then will print a list of variables, along with their description. For example:
// Select whether bi-directional text is enabled and which library should be used:
0: Disabled.
1: Use integrated minibidi library.
2: Use external fribidi library.
CEGUI_BIDI_SUPPORT:STRING=0
// Specifies whether to use embedded GLEW when external library was found
CEGUI_BUILD_EMBEDDED_GLEW:BOOL=OFF

====Using CMake GUI====
Start cmake-gui, select our ''source'' and ''build'' directories and click the ''Configure'' button. The available options will be listed in the main window. You can hover the mouse over an option and CMake will show a tooltip with a more detailed description.

{{Note|Changing the options and building is explained below, in [[#Building|Building]].}}

===Building===
====Configuring and Generating makefiles====
The first step is to use CMake to configure the build and generate native makefiles. Without making any configuration changes, the command would be:
{{CLI|~/cegui/cegui_mk2/build|cmake ../source}}
The same can be done using the CMake GUI. Select the ''source'' and ''build'' directories, click configure and finally click generate.

The build options can be changed via the GUI or via the CLI. If, for example, we want to turn off the slotted installation option and the python bindings we would run cmake like this:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source -DCEGUI_SLOTTED_INSTALLATION:BOOL=OFF -DCEGUI_BUILD_PYTHON_MODULES:BOOL=OFF}}
{{Note|The python bindings are required by [[#CEED|CEED]] so don't disable them if you plan to use it.}}

Another noteworthy option is the installation path, which is where CEGUI will be installed if you plan to install it via ''make install''. Change the value of the CMAKE_INSTALL_PREFIX configuration variable to set it. Example:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source <other options here> -DCMAKE_INSTALL_PREFIX:PATH=/opt}}
so it will be installed in /opt/CEGUI (or /opt/CEGUI-0.8 if you use slotted installation).

====Make====
The second (and last required) step is using the generated native makefiles to build it. This is specific to your build environment; you may need to open the generated solution with MSVC or Xcode, or simply issue the ''make'' command.

<tabber>
GNU Make=
* You can speed ''make'' up significantly if you have a multi-core CPU by adding the ''-jN'' parameter, when N is the number of CPU cores on your machine.
{{CLI|~/cegui/cegui_mk2/build|make -j4}}
* Optionally, run ''make install'' to install the binaries and the shared datafiles on your system.
|-|
MSVC=
{{Todo|MSVC notes}}
|-|
Xcode=
{{Todo|Xcode notes}}
</tabber>

===Running the samples===
Now that the build has finished, you can run the sample applications to check your build. The binaries should be in the ''bin'' directory:
cegui/cegui_mk2/build/bin

The samples may fail to run initially because they can't find the required data files.
According to ''"cegui/cegui_mk2/source/Samples/common/include/CEGUISamplesConfig.h.in"'', the samples will look for the datafiles on ''"../datafiles"'' on Windows and on ''${CMAKE_INSTALL_PREFIX}/${CEGUI_DATA_INSTALL_DIR}'' on other platforms.

It is possible to change this path without rebuilding, using the environment variable ''CEGUI_SAMPLE_DATAPATH''.
<tabber>
Linux=
{{CLI|~/cegui/cegui_mk2/build|2=CEGUI_SAMPLE_DATAPATH=../source/datafiles bin/CEGUIDemo8-0.8}}
|-|
Windows=
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=SET CEGUI_SAMPLE_DATAPATH="C:\Users\User\cegui\cegui_mk2\source\datafiles"}}
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=bin/CEGUIDemo8-0.8.exe}}
</tabber>

===Documentation===
{{Note|The documentation for stable releases can be found online [http://www.cegui.org.uk/docs/current here]}}

The documentation is written in doxygen format so you need [http://www.doxygen.org/ Doxygen] to build it. If you want to generate the nice class diagrams too, you need to install [http://graphviz.org/ Graphviz].

Building the docs with the default options is easy:
{{CLI|~/cegui/cegui_mk2/build|cd ../source/doc/doxygen}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|doxygen}}

This will create a directory named ''html'' with plenty of files, just open ''index.html''.

If you'd rather change some of doxygen's options, you can edit the file ''source/doc/doxygen/doxyfile'' or, alternatively, use ''doxywizard'' (GUI).
To change doxygen's output directory, one might do something like this:
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|mkdir ../../../build/doc}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|nano doxyfile or use your editor of choice to edit ''doxyfile''}}

Find the line
OUTPUT_DIRECTORY =
and change it to
OUTPUT_DIRECTORY = ../../../build/doc

Now run doxygen and it will create the html docs in ''build/doc''.

==CEED==
CEED is the new CEGUI unified editor. It can edit layouts and imagesets, supports projects and multiple open file tabs, visual and source editing, preview and more. Please see [[CEED]] for a detailed description.

CEED is written in [http://www.python.org/ Python] so there's no need to build it; all that's required is Python2 and it's dependencies.

{{Note|If you'd rather use a stable package that includes dependencies, please follow [[Downloads]]}}

===Dependencies===
CEED requires a Python 2 interpreter, version 2.6 or higher.
Apart from [[PyCEGUI]] (the CEGUI Python bindings), it depends on the following libraries:
* PyOpenGL
* Qt4, PySide (+ PySide Tools)
* Boost.Python

<tabs>
<tab title="Windows">
{{Todo|Windows dependencies notes}}
</tab>
<tab title="Mac">
{{Todo|Mac dependencies notes}}
</tab>
<tab title="Arch Linux">
You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR).
{{Note|The packages from AUR may have been included in the ''[community]'' repository by now so check there first.}}
</tab>
<tab title="Debian">
;Wheezy

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list and then:

{{CLI||sudo apt-get update}}
{{CLI||sudo apt-get install cmake python-opengl pyside-tools boost-python}}

</tab>
<tab title="Fedora">
You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools.
</tab>
<tab title="Gentoo">
You can use these supplied ebuilds:[https://bitbucket.org/ChrisTrenkamp/gentoo-ogre3d-tools]. Copy these ebuilds to your local overlay[http://en.gentoo-wiki.com/wiki/Overlay#Local_Overlays], add the necessary options to your package.keywords and package.use files, and run '''''emerge -av dev-util/ceed'''''
</tab>
</tabs>

===Running===
{{Todo|Update this section when CEED/CEGUI 0.8 is released}}
If you're following the directory structure outlined in [[#Building|Building]], you should have something like:
cegui (root working directory)
cegui/CEED (CEED repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

Running the main ''ceed-gui'' application could be as simple as:
{{CLI|~/cegui/CEED|2=PYTHONPATH=.:$PYTHONPATH python2 bin/ceed-gui}}

If you don't have PyCEGUI installed system-wide but built it in ''cegui/cegui_mk2/build'', you can run ''ceed-gui'' like this:
{{CLI|~/cegui/CEED|2=PYTHONPATH=../cegui_mk2/build/lib:.:$PYTHONPATH python2 bin/ceed-gui}}

====Running from Mercurial====
If you've cloned the CEED mercurial repository, you will most likely get the following error when you try to run ''ceed-gui'':
ImportError: No module named mainwindow
This is because the compiled .ui files are not part of the repository. Edit the file ''ceed/version.py'' with your favorite text editor and change the value of '''CEED_developerMode''' from '''False''' to '''True'''.

=Troubleshooting=
If you encounter a problem that's not listed here, please make a post on the appropriate forum: [http://www.cegui.org.uk/phpBB2/viewforum.php?f=10 CEGUI], [http://www.cegui.org.uk/phpBB2/viewforum.php?f=15 CEED].

For comments about this article, you may use it's discussion page.

=Related articles=
* [[Eclipse and CEGUI]]
* [[Contribution|Contributing to the development of CEGUI]]

[[Category:HowTo]]

Building from source

2015-01-03T15:16:36Z

Lucebac: use tabber

{{VersionBadge|0.8}}
{{notice|message=This article is a work in progress and thus incomplete}}

==Official documentation==
PLEASE use the documentation of your CEGUI version as your main source of information, e.g.: [http://static.cegui.org.uk/docs/current/compiling.html Latest API docs for building/compiling]

==Stable Releases==
Source code from the stable mercurial branches is released at various points in time and made available as source code packages. These packages can be found on the [[Downloads]] page.

==Mercurial==
The source code is kept in mercurial repositories at bitbucket.org. There are code repositories for the main CEGUI libraries as well as for other related items.

A mercurial client (GUI or <abbr title="Command-line Interface">CLI</abbr>) is required to access the mercurial repositories and download code. The command necessary to obtain a copy of the code is 'clone':
hg clone SOURCE DESTINATION
where ''source'' is the URL of the repository to clone and ''destination'' is the local directory. To download a copy of CEGUI and place it in the ''cegui-source'' directory, you might use the following command:
hg clone https://bitbucket.org/cegui/cegui cegui-source

Once you have this, the cloned repository is updated to the default (latest, unstable) code, so you most likely will want to switch to a stable branch instead, like this:
hg update -C v0-8
{{Warning|Be aware that the -C option here will discard any local file changes without additional warning}}

===Repositories===
The available repositories can be found [https://bitbucket.org/cegui/ here] where you can also browse their code from your web browser. A couple of examples:
* Core CEGUI libraries - [https://bitbucket.org/cegui/cegui/src cegui]
hg clone https://bitbucket.org/cegui/cegui cegui-source
* CEED unified editor - [https://bitbucket.org/cegui/ceed/src CEED]
hg clone https://bitbucket.org/cegui/ceed

{{Note|The difference between the ''hg clone'' URLs and the web-interface URLs is the appended ''/src'' on the web URLs}}

=Building=
CEGUI uses [http://www.cmake.org/ CMake] as a build system. CMake is cross-platform and open source so it's available on many platforms. There are binaries available for Windows, Mac and Linux, although on Linux your distribution will most probably have a CMake package ready. Make sure you have some 2.8.X version installed because CMake 3.x.x will break with our scripts at the moment.
{{Note|CMake does not build the code directly, it generates native makefiles and workspaces that can be used in the compiler environment of your choice.}}
Thanks to CMake and CEGUI's modular design, configuring and building CEGUI is a breeze.

The following instructions assume you have a ''cegui'' directory somewhere on your system so that all CEGUI related projects reside in it.
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
cegui/CEED (editor)
cegui/... (something else)

==CEGUI==
This section will focus on building the core CEGUI libraries, which is all you need to use CEGUI in a project. Most people will also want [[Building from source#CEED|CEED]], the unified editor for CEGUI, but it is not required.

===Dependencies===
CEGUI can be built without any dependencies to outside libraries. However, typical configurations require [http://en.wikipedia.org/wiki/FreeType FreeType], a rendering module, an XML parser, and an image codec. CEGUI already provides support for several external libraries thanks to its modular design:

{| class="wikitable sortable" border="1" style="text-align: center;"
|+ External libraries supported by CEGUI
|-
! scope="col" | Type
! scope="col" | Name
! scope="col" halign="left" | Additional information

|- style="background: #eaffe8;"
| rowspan="5" | Rendering Module
| OpenGL 3.2+ Core Profile
| style="text-align: left;" | Uses the programmable rendering pipeline and only non-deprecated functionality and is therefore compatible with OpenGL Core Profile contexts (available since OpenGL 3.2). It can also be used with older OpenGL versions and/or Compatibility Profile, as long as the required functionalities are available.
|- style="background: #eaffe8;"
| OpenGL
| style="text-align: left;" | Uses the fixed-function rendering pipeline. It is designed to be compatible with very early OpenGL versions, as early as OpenGL 1.2, using some OpenGL extensions.
|- style="background: #eaffe8;"
| Microsoft Direct3D
| style="text-align: left;" | Microsoft Direct3D 9, 10, and 11 are supported using seperate modules.
|- style="background: #eaffe8;"
| OGRE
| style="text-align: left;" | The latest stable Ogre version is supported in the releases.
|- style="background: #eaffe8;"
| Irrlicht
| style="text-align: left;" | The latest stable Irrlicht version is supported in the releases.

|- style="background: #edfcfb;"
| rowspan="4" | Image Codec Module
| SILLY
| style="text-align: left;" | Default image codec, which is based on the SILLY library. Supports many formats, see [[SILLY]]
|- style="background: #edfcfb;"
| DevIL
| style="text-align: left;" | Image codec based on the DevIL library.
|- style="background: #edfcfb;"
| FreeImage
| style="text-align: left;" | Image codec based on the FreeImage library.
|- style="background: #edfcfb;"
| OGRE
| style="text-align: left;" | Image codec that loads data via image loading facilities of OGRE.

|- style="background: #dfeff1;"
| rowspan="3" | Resource Provider Module
| Default
| style="text-align: left;" | The default resource provider of CEGUI uses standard cross-platform file-access.
|- style="background: #dfeff1;"
| OGRE
| style="text-align: left;" | Ogre users can use CEGUI's Ogre ResourceManager. This way the resource locations of CEGUI can be specified in the same way as it is done for the Ogre resources already.
|- style="background: #dfeff1;"
| minizip
| style="text-align: left;" | CEGUI's MinizipResourceProvider allows users to provides the ability to load the resource files from locations within .zip files.

|- style="background: #e9ebfc;"
| rowspan="5" | XML Parser Module
| Expat
| style="text-align: left;" | Ddefault XML parser of CEGUI. Uses the Expat library for XML parsing.
|- style="background: #e9ebfc;"
| LibXML2
| style="text-align: left;" | Uses the LibXML2 library for XML parsing.
|- style="background: #e9ebfc;"
| RapidXml
| style="text-align: left;" | Uses the RapidXml library for XML parsing.
|- style="background: #e9ebfc;"
| TinyXML
| style="text-align: left;" | Uses the TinyXML library for XML parsing.
|- style="background: #e9ebfc;"
| Xerces-C++
| style="text-align: left;" | Uses the Xerces library for XML parsing. It can do schema validation using the .xsd files provided in CEGUI's resources.
|-

|- style="background: #fae9fc;"
| rowspan="1" | Font Module
| FreeType
| style="text-align: left;" | FreeType is the default font library of CEGUI and currently the only officially supported one.

|- style="background: #f4e0e7;"
| rowspan="1" | Regular Expression Module
| Perl Compatible Regular Expressions (PCRE)
| style="text-align: left;" | Default regular expression library and currently the only officially supported one. Uses the PCRE library.

|- style="background: #fcf3e9;"
| rowspan="2" | Scripting Module
| Lua
| style="text-align: left;" | Provides lua bindings using tolua++.
|- style="background: #fcf3e9;"
| Python
| style="text-align: left;" | Official Python bindings are available using [[PyCEGUI]]

|- style="background: #f2eeca;"
| rowspan="2" | Memory Management
| OGRE
| style="text-align: left;" | Ogre's memory allocator can optionally be used for CEGUI's memory management.
|- style="background: #f2eeca;"
| nedmalloc
| style="text-align: left;" | nedmalloc can optionally be used as memory allocator.

|- style="background: #f6fce9;"
| rowspan="2" | Bi-Directional Language Module
| MiniBIDI
| style="text-align: left;" | MiniBIDI based implementation of CEGUI's Bidi visual mapping.
|- style="background: #f6fce9;"
| FriBIDI
| style="text-align: left;" | FriBIDI based implementation of CEGUI's Bidi visual mapping.

|}

CMake will automatically detect which external libraries exist on your system and will build CEGUI accordingly so make sure you install any external libraries you want to use before proceeding.
{{Note|You can turn off individual CEGUI modules from building (even if you have the required libraries installed) by changing the default [[Building from source#Build Options|Build Options]].}}

===Directories===
If you're following the directory structure outlined above, you should have something like:
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
Create the directory ''cegui/cegui_mk2/build'' and clone the ''cegui'' repository inside cegui/cegui_mk2 with the name ''source''. Example:
{{CLI|~/cegui|mkdir cegui_mk2/build}}
{{CLI|~/cegui|hg clone https://bitbucket.org/cegui/cegui cegui_mk2/source}}
The result should be:
cegui/cegui_mk2 (core CEGUI)
cegui/cegui_mk2/build (will build here)
cegui/cegui_mk2/source (the mercurial repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

===Build Options===
There are several build options (or variables) supported by the CEGUI build system. To view them, you can use the command like or CMake GUI.

====Using the command line====
Enter the ''build'' directory and issue the following cmake command:
{{CLI|~/cegui/cegui_mk2|cd build}}
{{CLI|~/cegui/cegui_mk2/build|cmake -LH ../source}}
{{Note|On systems that default to python3 (like Arch Linux) you have to tell it to use python2 like this:}}
{{CLI|~/cegui/cegui_mk2/build|2=cmake -LH -DPYTHON_EXECUTABLE=/usr/bin/python2 ../source}}
CMake will run, it will look for the build systems available on your platform, will look for dependencies and then will print a list of variables, along with their description. For example:
// Select whether bi-directional text is enabled and which library should be used:
0: Disabled.
1: Use integrated minibidi library.
2: Use external fribidi library.
CEGUI_BIDI_SUPPORT:STRING=0
// Specifies whether to use embedded GLEW when external library was found
CEGUI_BUILD_EMBEDDED_GLEW:BOOL=OFF

====Using CMake GUI====
Start cmake-gui, select our ''source'' and ''build'' directories and click the ''Configure'' button. The available options will be listed in the main window. You can hover the mouse over an option and CMake will show a tooltip with a more detailed description.

{{Note|Changing the options and building is explained below, in [[#Building|Building]].}}

===Building===
====Configuring and Generating makefiles====
The first step is to use CMake to configure the build and generate native makefiles. Without making any configuration changes, the command would be:
{{CLI|~/cegui/cegui_mk2/build|cmake ../source}}
The same can be done using the CMake GUI. Select the ''source'' and ''build'' directories, click configure and finally click generate.

The build options can be changed via the GUI or via the CLI. If, for example, we want to turn off the slotted installation option and the python bindings we would run cmake like this:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source -DCEGUI_SLOTTED_INSTALLATION:BOOL=OFF -DCEGUI_BUILD_PYTHON_MODULES:BOOL=OFF}}
{{Note|The python bindings are required by [[#CEED|CEED]] so don't disable them if you plan to use it.}}

Another noteworthy option is the installation path, which is where CEGUI will be installed if you plan to install it via ''make install''. Change the value of the CMAKE_INSTALL_PREFIX configuration variable to set it. Example:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source <other options here> -DCMAKE_INSTALL_PREFIX:PATH=/opt}}
so it will be installed in /opt/CEGUI (or /opt/CEGUI-0.8 if you use slotted installation).

====Make====
The second (and last required) step is using the generated native makefiles to build it. This is specific to your build environment; you may need to open the generated solution with MSVC or Xcode, or simply issue the ''make'' command.

<tabber>
GNU Make=
* You can speed ''make'' up significantly if you have a multi-core CPU by adding the ''-jN'' parameter, when N is the number of CPU cores on your machine.
{{CLI|~/cegui/cegui_mk2/build|make -j4}}
* Optionally, run ''make install'' to install the binaries and the shared datafiles on your system.
|-|
MSVC=
{{Todo|MSVC notes}}
|-|
Xcode=
{{Todo|Xcode notes}}
</tabber>

===Running the samples===
Now that the build has finished, you can run the sample applications to check your build. The binaries should be in the ''bin'' directory:
cegui/cegui_mk2/build/bin

The samples may fail to run initially because they can't find the required data files.
According to ''"cegui/cegui_mk2/source/Samples/common/include/CEGUISamplesConfig.h.in"'', the samples will look for the datafiles on ''"../datafiles"'' on Windows and on ''${CMAKE_INSTALL_PREFIX}/${CEGUI_DATA_INSTALL_DIR}'' on other platforms.

It is possible to change this path without rebuilding, using the environment variable ''CEGUI_SAMPLE_DATAPATH''.
<tabs>
<tab title="Linux">
{{CLI|~/cegui/cegui_mk2/build|2=CEGUI_SAMPLE_DATAPATH=../source/datafiles bin/CEGUIDemo8-0.8}}
</tab>
<tab title="Windows">
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=SET CEGUI_SAMPLE_DATAPATH="C:\Users\User\cegui\cegui_mk2\source\datafiles"}}
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=bin/CEGUIDemo8-0.8.exe}}
</tab>
</tabs>

===Documentation===
{{Note|The documentation for stable releases can be found online [http://www.cegui.org.uk/docs/current here]}}

The documentation is written in doxygen format so you need [http://www.doxygen.org/ Doxygen] to build it. If you want to generate the nice class diagrams too, you need to install [http://graphviz.org/ Graphviz].

Building the docs with the default options is easy:
{{CLI|~/cegui/cegui_mk2/build|cd ../source/doc/doxygen}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|doxygen}}

This will create a directory named ''html'' with plenty of files, just open ''index.html''.

If you'd rather change some of doxygen's options, you can edit the file ''source/doc/doxygen/doxyfile'' or, alternatively, use ''doxywizard'' (GUI).
To change doxygen's output directory, one might do something like this:
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|mkdir ../../../build/doc}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|nano doxyfile or use your editor of choice to edit ''doxyfile''}}

Find the line
OUTPUT_DIRECTORY =
and change it to
OUTPUT_DIRECTORY = ../../../build/doc

Now run doxygen and it will create the html docs in ''build/doc''.

==CEED==
CEED is the new CEGUI unified editor. It can edit layouts and imagesets, supports projects and multiple open file tabs, visual and source editing, preview and more. Please see [[CEED]] for a detailed description.

CEED is written in [http://www.python.org/ Python] so there's no need to build it; all that's required is Python2 and it's dependencies.

{{Note|If you'd rather use a stable package that includes dependencies, please follow [[Downloads]]}}

===Dependencies===
CEED requires a Python 2 interpreter, version 2.6 or higher.
Apart from [[PyCEGUI]] (the CEGUI Python bindings), it depends on the following libraries:
* PyOpenGL
* Qt4, PySide (+ PySide Tools)
* Boost.Python

<tabs>
<tab title="Windows">
{{Todo|Windows dependencies notes}}
</tab>
<tab title="Mac">
{{Todo|Mac dependencies notes}}
</tab>
<tab title="Arch Linux">
You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR).
{{Note|The packages from AUR may have been included in the ''[community]'' repository by now so check there first.}}
</tab>
<tab title="Debian">
;Wheezy

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list and then:

{{CLI||sudo apt-get update}}
{{CLI||sudo apt-get install cmake python-opengl pyside-tools boost-python}}

</tab>
<tab title="Fedora">
You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools.
</tab>
<tab title="Gentoo">
You can use these supplied ebuilds:[https://bitbucket.org/ChrisTrenkamp/gentoo-ogre3d-tools]. Copy these ebuilds to your local overlay[http://en.gentoo-wiki.com/wiki/Overlay#Local_Overlays], add the necessary options to your package.keywords and package.use files, and run '''''emerge -av dev-util/ceed'''''
</tab>
</tabs>

===Running===
{{Todo|Update this section when CEED/CEGUI 0.8 is released}}
If you're following the directory structure outlined in [[#Building|Building]], you should have something like:
cegui (root working directory)
cegui/CEED (CEED repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

Running the main ''ceed-gui'' application could be as simple as:
{{CLI|~/cegui/CEED|2=PYTHONPATH=.:$PYTHONPATH python2 bin/ceed-gui}}

If you don't have PyCEGUI installed system-wide but built it in ''cegui/cegui_mk2/build'', you can run ''ceed-gui'' like this:
{{CLI|~/cegui/CEED|2=PYTHONPATH=../cegui_mk2/build/lib:.:$PYTHONPATH python2 bin/ceed-gui}}

====Running from Mercurial====
If you've cloned the CEED mercurial repository, you will most likely get the following error when you try to run ''ceed-gui'':
ImportError: No module named mainwindow
This is because the compiled .ui files are not part of the repository. Edit the file ''ceed/version.py'' with your favorite text editor and change the value of '''CEED_developerMode''' from '''False''' to '''True'''.

=Troubleshooting=
If you encounter a problem that's not listed here, please make a post on the appropriate forum: [http://www.cegui.org.uk/phpBB2/viewforum.php?f=10 CEGUI], [http://www.cegui.org.uk/phpBB2/viewforum.php?f=15 CEED].

For comments about this article, you may use it's discussion page.

=Related articles=
* [[Eclipse and CEGUI]]
* [[Contribution|Contributing to the development of CEGUI]]

[[Category:HowTo]]

Building from source

2014-09-22T14:44:50Z

Lucebac: /* Building */

{{VersionBadge|0.8}}
{{notice|message=This article is a work in progress and thus incomplete}}

==Official documentation==
PLEASE use the documentation of your CEGUI version as your main source of information, e.g.: [http://static.cegui.org.uk/docs/current/compiling.html Latest API docs for building/compiling]

==Stable Releases==
Source code from the stable mercurial branches is released at various points in time and made available as source code packages. These packages can be found on the [[Downloads]] page.

==Mercurial==
The source code is kept in mercurial repositories at bitbucket.org. There are code repositories for the main CEGUI libraries as well as for other related items.

A mercurial client (GUI or <abbr title="Command-line Interface">CLI</abbr>) is required to access the mercurial repositories and download code. The command necessary to obtain a copy of the code is 'clone':
hg clone SOURCE DESTINATION
where ''source'' is the URL of the repository to clone and ''destination'' is the local directory. To download a copy of CEGUI and place it in the ''cegui-source'' directory, you might use the following command:
hg clone https://bitbucket.org/cegui/cegui cegui-source

Once you have this, the cloned repository is updated to the default (latest, unstable) code, so you most likely will want to switch to a stable branch instead, like this:
hg update -C v0-8
{{Warning|Be aware that the -C option here will discard any local file changes without additional warning}}

===Repositories===
The available repositories can be found [https://bitbucket.org/cegui/ here] where you can also browse their code from your web browser. A couple of examples:
* Core CEGUI libraries - [https://bitbucket.org/cegui/cegui/src cegui]
hg clone https://bitbucket.org/cegui/cegui cegui-source
* CEED unified editor - [https://bitbucket.org/cegui/ceed/src CEED]
hg clone https://bitbucket.org/cegui/ceed

{{Note|The difference between the ''hg clone'' URLs and the web-interface URLs is the appended ''/src'' on the web URLs}}

=Building=
CEGUI uses [http://www.cmake.org/ CMake] as a build system. CMake is cross-platform and open source so it's available on many platforms. There are binaries available for Windows, Mac and Linux, although on Linux your distribution will most probably have a CMake package ready. Make sure you have some 2.8.X version installed because CMake 3.x.x will break with our scripts at the moment.
{{Note|CMake does not build the code directly, it generates native makefiles and workspaces that can be used in the compiler environment of your choice.}}
Thanks to CMake and CEGUI's modular design, configuring and building CEGUI is a breeze.

The following instructions assume you have a ''cegui'' directory somewhere on your system so that all CEGUI related projects reside in it.
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
cegui/CEED (editor)
cegui/... (something else)

==CEGUI==
This section will focus on building the core CEGUI libraries, which is all you need to use CEGUI in a project. Most people will also want [[Building from source#CEED|CEED]], the unified editor for CEGUI, but it is not required.

===Dependencies===
CEGUI can be built without any dependencies to outside libraries. However, typical configurations require [http://en.wikipedia.org/wiki/FreeType FreeType], a rendering module, an XML parser, and an image codec. CEGUI already provides support for several external libraries thanks to its modular design:

{| class="wikitable sortable" border="1" style="text-align: center;"
|+ External libraries supported by CEGUI
|-
! scope="col" | Type
! scope="col" | Name
! scope="col" halign="left" | Additional information

|- style="background: #eaffe8;"
| rowspan="5" | Rendering Module
| OpenGL 3.2+ Core Profile
| style="text-align: left;" | Uses the programmable rendering pipeline and only non-deprecated functionality and is therefore compatible with OpenGL Core Profile contexts (available since OpenGL 3.2). It can also be used with older OpenGL versions and/or Compatibility Profile, as long as the required functionalities are available.
|- style="background: #eaffe8;"
| OpenGL
| style="text-align: left;" | Uses the fixed-function rendering pipeline. It is designed to be compatible with very early OpenGL versions, as early as OpenGL 1.2, using some OpenGL extensions.
|- style="background: #eaffe8;"
| Microsoft Direct3D
| style="text-align: left;" | Microsoft Direct3D 9, 10, and 11 are supported using seperate modules.
|- style="background: #eaffe8;"
| OGRE
| style="text-align: left;" | The latest stable Ogre version is supported in the releases.
|- style="background: #eaffe8;"
| Irrlicht
| style="text-align: left;" | The latest stable Irrlicht version is supported in the releases.

|- style="background: #edfcfb;"
| rowspan="4" | Image Codec Module
| SILLY
| style="text-align: left;" | Default image codec, which is based on the SILLY library. Supports many formats, see [[SILLY]]
|- style="background: #edfcfb;"
| DevIL
| style="text-align: left;" | Image codec based on the DevIL library.
|- style="background: #edfcfb;"
| FreeImage
| style="text-align: left;" | Image codec based on the FreeImage library.
|- style="background: #edfcfb;"
| OGRE
| style="text-align: left;" | Image codec that loads data via image loading facilities of OGRE.

|- style="background: #dfeff1;"
| rowspan="3" | Resource Provider Module
| Default
| style="text-align: left;" | The default resource provider of CEGUI uses standard cross-platform file-access.
|- style="background: #dfeff1;"
| OGRE
| style="text-align: left;" | Ogre users can use CEGUI's Ogre ResourceManager. This way the resource locations of CEGUI can be specified in the same way as it is done for the Ogre resources already.
|- style="background: #dfeff1;"
| minizip
| style="text-align: left;" | CEGUI's MinizipResourceProvider allows users to provides the ability to load the resource files from locations within .zip files.

|- style="background: #e9ebfc;"
| rowspan="5" | XML Parser Module
| Expat
| style="text-align: left;" | Ddefault XML parser of CEGUI. Uses the Expat library for XML parsing.
|- style="background: #e9ebfc;"
| LibXML2
| style="text-align: left;" | Uses the LibXML2 library for XML parsing.
|- style="background: #e9ebfc;"
| RapidXml
| style="text-align: left;" | Uses the RapidXml library for XML parsing.
|- style="background: #e9ebfc;"
| TinyXML
| style="text-align: left;" | Uses the TinyXML library for XML parsing.
|- style="background: #e9ebfc;"
| Xerces-C++
| style="text-align: left;" | Uses the Xerces library for XML parsing. It can do schema validation using the .xsd files provided in CEGUI's resources.
|-

|- style="background: #fae9fc;"
| rowspan="1" | Font Module
| FreeType
| style="text-align: left;" | FreeType is the default font library of CEGUI and currently the only officially supported one.

|- style="background: #f4e0e7;"
| rowspan="1" | Regular Expression Module
| Perl Compatible Regular Expressions (PCRE)
| style="text-align: left;" | Default regular expression library and currently the only officially supported one. Uses the PCRE library.

|- style="background: #fcf3e9;"
| rowspan="2" | Scripting Module
| Lua
| style="text-align: left;" | Provides lua bindings using tolua++.
|- style="background: #fcf3e9;"
| Python
| style="text-align: left;" | Official Python bindings are available using [[PyCEGUI]]

|- style="background: #f2eeca;"
| rowspan="2" | Memory Management
| OGRE
| style="text-align: left;" | Ogre's memory allocator can optionally be used for CEGUI's memory management.
|- style="background: #f2eeca;"
| nedmalloc
| style="text-align: left;" | nedmalloc can optionally be used as memory allocator.

|- style="background: #f6fce9;"
| rowspan="2" | Bi-Directional Language Module
| MiniBIDI
| style="text-align: left;" | MiniBIDI based implementation of CEGUI's Bidi visual mapping.
|- style="background: #f6fce9;"
| FriBIDI
| style="text-align: left;" | FriBIDI based implementation of CEGUI's Bidi visual mapping.

|}

CMake will automatically detect which external libraries exist on your system and will build CEGUI accordingly so make sure you install any external libraries you want to use before proceeding.
{{Note|You can turn off individual CEGUI modules from building (even if you have the required libraries installed) by changing the default [[Building from source#Build Options|Build Options]].}}

===Directories===
If you're following the directory structure outlined above, you should have something like:
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
Create the directory ''cegui/cegui_mk2/build'' and clone the ''cegui'' repository inside cegui/cegui_mk2 with the name ''source''. Example:
{{CLI|~/cegui|mkdir cegui_mk2/build}}
{{CLI|~/cegui|hg clone https://bitbucket.org/cegui/cegui cegui_mk2/source}}
The result should be:
cegui/cegui_mk2 (core CEGUI)
cegui/cegui_mk2/build (will build here)
cegui/cegui_mk2/source (the mercurial repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

===Build Options===
There are several build options (or variables) supported by the CEGUI build system. To view them, you can use the command like or CMake GUI.

====Using the command line====
Enter the ''build'' directory and issue the following cmake command:
{{CLI|~/cegui/cegui_mk2|cd build}}
{{CLI|~/cegui/cegui_mk2/build|cmake -LH ../source}}
{{Note|On systems that default to python3 (like Arch Linux) you have to tell it to use python2 like this:}}
{{CLI|~/cegui/cegui_mk2/build|2=cmake -LH -DPYTHON_EXECUTABLE=/usr/bin/python2 ../source}}
CMake will run, it will look for the build systems available on your platform, will look for dependencies and then will print a list of variables, along with their description. For example:
// Select whether bi-directional text is enabled and which library should be used:
0: Disabled.
1: Use integrated minibidi library.
2: Use external fribidi library.
CEGUI_BIDI_SUPPORT:STRING=0
// Specifies whether to use embedded GLEW when external library was found
CEGUI_BUILD_EMBEDDED_GLEW:BOOL=OFF

====Using CMake GUI====
Start cmake-gui, select our ''source'' and ''build'' directories and click the ''Configure'' button. The available options will be listed in the main window. You can hover the mouse over an option and CMake will show a tooltip with a more detailed description.

{{Note|Changing the options and building is explained below, in [[#Building|Building]].}}

===Building===
====Configuring and Generating makefiles====
The first step is to use CMake to configure the build and generate native makefiles. Without making any configuration changes, the command would be:
{{CLI|~/cegui/cegui_mk2/build|cmake ../source}}
The same can be done using the CMake GUI. Select the ''source'' and ''build'' directories, click configure and finally click generate.

The build options can be changed via the GUI or via the CLI. If, for example, we want to turn off the slotted installation option and the python bindings we would run cmake like this:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source -DCEGUI_SLOTTED_INSTALLATION:BOOL=OFF -DCEGUI_BUILD_PYTHON_MODULES:BOOL=OFF}}
{{Note|The python bindings are required by [[#CEED|CEED]] so don't disable them if you plan to use it.}}

Another noteworthy option is the installation path, which is where CEGUI will be installed if you plan to install it via ''make install''. Change the value of the CMAKE_INSTALL_PREFIX configuration variable to set it. Example:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source <other options here> -DCMAKE_INSTALL_PREFIX:PATH=/opt}}
so it will be installed in /opt/CEGUI (or /opt/CEGUI-0.8 if you use slotted installation).

====Make====
The second (and last required) step is using the generated native makefiles to build it. This is specific to your build environment; you may need to open the generated solution with MSVC or Xcode, or simply issue the ''make'' command.

<tabs>
<tab title="GNU Make">
* You can speed ''make'' up significantly if you have a multi-core CPU by adding the ''-jN'' parameter, when N is the number of CPU cores on your machine.
{{CLI|~/cegui/cegui_mk2/build|make -j4}}
* Optionally, run ''make install'' to install the binaries and the shared datafiles on your system.
</tab>
<tab title="MSVC">
{{Todo|MSVC notes}}
</tab>
<tab title="Xcode">
{{Todo|Xcode notes}}
</tab>
</tabs>

===Running the samples===
Now that the build has finished, you can run the sample applications to check your build. The binaries should be in the ''bin'' directory:
cegui/cegui_mk2/build/bin

The samples may fail to run initially because they can't find the required data files.
According to ''"cegui/cegui_mk2/source/Samples/common/include/CEGUISamplesConfig.h.in"'', the samples will look for the datafiles on ''"../datafiles"'' on Windows and on ''${CMAKE_INSTALL_PREFIX}/${CEGUI_DATA_INSTALL_DIR}'' on other platforms.

It is possible to change this path without rebuilding, using the environment variable ''CEGUI_SAMPLE_DATAPATH''.
<tabs>
<tab title="Linux">
{{CLI|~/cegui/cegui_mk2/build|2=CEGUI_SAMPLE_DATAPATH=../source/datafiles bin/CEGUIDemo8-0.8}}
</tab>
<tab title="Windows">
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=SET CEGUI_SAMPLE_DATAPATH="C:\Users\User\cegui\cegui_mk2\source\datafiles"}}
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=bin/CEGUIDemo8-0.8.exe}}
</tab>
</tabs>

===Documentation===
{{Note|The documentation for stable releases can be found online [http://www.cegui.org.uk/docs/current here]}}

The documentation is written in doxygen format so you need [http://www.doxygen.org/ Doxygen] to build it. If you want to generate the nice class diagrams too, you need to install [http://graphviz.org/ Graphviz].

Building the docs with the default options is easy:
{{CLI|~/cegui/cegui_mk2/build|cd ../source/doc/doxygen}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|doxygen}}

This will create a directory named ''html'' with plenty of files, just open ''index.html''.

If you'd rather change some of doxygen's options, you can edit the file ''source/doc/doxygen/doxyfile'' or, alternatively, use ''doxywizard'' (GUI).
To change doxygen's output directory, one might do something like this:
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|mkdir ../../../build/doc}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|nano doxyfile or use your editor of choice to edit ''doxyfile''}}

Find the line
OUTPUT_DIRECTORY =
and change it to
OUTPUT_DIRECTORY = ../../../build/doc

Now run doxygen and it will create the html docs in ''build/doc''.

==CEED==
CEED is the new CEGUI unified editor. It can edit layouts and imagesets, supports projects and multiple open file tabs, visual and source editing, preview and more. Please see [[CEED]] for a detailed description.

CEED is written in [http://www.python.org/ Python] so there's no need to build it; all that's required is Python2 and it's dependencies.

{{Note|If you'd rather use a stable package that includes dependencies, please follow [[Downloads]]}}

===Dependencies===
CEED requires a Python 2 interpreter, version 2.6 or higher.
Apart from [[PyCEGUI]] (the CEGUI Python bindings), it depends on the following libraries:
* PyOpenGL
* Qt4, PySide (+ PySide Tools)
* Boost.Python

<tabs>
<tab title="Windows">
{{Todo|Windows dependencies notes}}
</tab>
<tab title="Mac">
{{Todo|Mac dependencies notes}}
</tab>
<tab title="Arch Linux">
You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR).
{{Note|The packages from AUR may have been included in the ''[community]'' repository by now so check there first.}}
</tab>
<tab title="Debian">
;Wheezy

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list and then:

{{CLI||sudo apt-get update}}
{{CLI||sudo apt-get install cmake python-opengl pyside-tools boost-python}}

</tab>
<tab title="Fedora">
You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools.
</tab>
<tab title="Gentoo">
You can use these supplied ebuilds:[https://bitbucket.org/ChrisTrenkamp/gentoo-ogre3d-tools]. Copy these ebuilds to your local overlay[http://en.gentoo-wiki.com/wiki/Overlay#Local_Overlays], add the necessary options to your package.keywords and package.use files, and run '''''emerge -av dev-util/ceed'''''
</tab>
</tabs>

===Running===
{{Todo|Update this section when CEED/CEGUI 0.8 is released}}
If you're following the directory structure outlined in [[#Building|Building]], you should have something like:
cegui (root working directory)
cegui/CEED (CEED repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

Running the main ''ceed-gui'' application could be as simple as:
{{CLI|~/cegui/CEED|2=PYTHONPATH=.:$PYTHONPATH python2 bin/ceed-gui}}

If you don't have PyCEGUI installed system-wide but built it in ''cegui/cegui_mk2/build'', you can run ''ceed-gui'' like this:
{{CLI|~/cegui/CEED|2=PYTHONPATH=../cegui_mk2/build/lib:.:$PYTHONPATH python2 bin/ceed-gui}}

====Running from Mercurial====
If you've cloned the CEED mercurial repository, you will most likely get the following error when you try to run ''ceed-gui'':
ImportError: No module named mainwindow
This is because the compiled .ui files are not part of the repository. Edit the file ''ceed/version.py'' with your favorite text editor and change the value of '''CEED_developerMode''' from '''False''' to '''True'''.

=Troubleshooting=
If you encounter a problem that's not listed here, please make a post on the appropriate forum: [http://www.cegui.org.uk/phpBB2/viewforum.php?f=10 CEGUI], [http://www.cegui.org.uk/phpBB2/viewforum.php?f=15 CEED].

For comments about this article, you may use it's discussion page.

=Related articles=
* [[Eclipse and CEGUI]]
* [[Contribution|Contributing to the development of CEGUI]]

[[Category:HowTo]]

Building from source

2014-09-22T14:29:05Z

Lucebac: /* Building */

{{VersionBadge|0.8}}
{{notice|message=This article is a work in progress and thus incomplete}}

==Official documentation==
PLEASE use the documentation of your CEGUI version as your main source of information, e.g.: [http://static.cegui.org.uk/docs/current/compiling.html Latest API docs for building/compiling]

==Stable Releases==
Source code from the stable mercurial branches is released at various points in time and made available as source code packages. These packages can be found on the [[Downloads]] page.

==Mercurial==
The source code is kept in mercurial repositories at bitbucket.org. There are code repositories for the main CEGUI libraries as well as for other related items.

A mercurial client (GUI or <abbr title="Command-line Interface">CLI</abbr>) is required to access the mercurial repositories and download code. The command necessary to obtain a copy of the code is 'clone':
hg clone SOURCE DESTINATION
where ''source'' is the URL of the repository to clone and ''destination'' is the local directory. To download a copy of CEGUI and place it in the ''cegui-source'' directory, you might use the following command:
hg clone https://bitbucket.org/cegui/cegui cegui-source

Once you have this, the cloned repository is updated to the default (latest, unstable) code, so you most likely will want to switch to a stable branch instead, like this:
hg update -C v0-8
{{Warning|Be aware that the -C option here will discard any local file changes without additional warning}}

===Repositories===
The available repositories can be found [https://bitbucket.org/cegui/ here] where you can also browse their code from your web browser. A couple of examples:
* Core CEGUI libraries - [https://bitbucket.org/cegui/cegui/src cegui]
hg clone https://bitbucket.org/cegui/cegui cegui-source
* CEED unified editor - [https://bitbucket.org/cegui/ceed/src CEED]
hg clone https://bitbucket.org/cegui/ceed

{{Note|The difference between the ''hg clone'' URLs and the web-interface URLs is the appended ''/src'' on the web URLs}}

=Building=
CEGUI uses [http://www.cmake.org/ CMake] as a build system. CMake is cross-platform and open source so it's available on many platforms. There are binaries available for Windows, Mac and Linux, although on Linux your distribution will most probably have a CMake package ready. Make sure you install version 2.8.12 before continuing.
{{Note|CMake does not build the code directly, it generates native makefiles and workspaces that can be used in the compiler environment of your choice.}}
Thanks to CMake and CEGUI's modular design, configuring and building CEGUI is a breeze.

The following instructions assume you have a ''cegui'' directory somewhere on your system so that all CEGUI related projects reside in it.
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
cegui/CEED (editor)
cegui/... (something else)

==CEGUI==
This section will focus on building the core CEGUI libraries, which is all you need to use CEGUI in a project. Most people will also want [[Building from source#CEED|CEED]], the unified editor for CEGUI, but it is not required.

===Dependencies===
CEGUI can be built without any dependencies to outside libraries. However, typical configurations require [http://en.wikipedia.org/wiki/FreeType FreeType], a rendering module, an XML parser, and an image codec. CEGUI already provides support for several external libraries thanks to its modular design:

{| class="wikitable sortable" border="1" style="text-align: center;"
|+ External libraries supported by CEGUI
|-
! scope="col" | Type
! scope="col" | Name
! scope="col" halign="left" | Additional information

|- style="background: #eaffe8;"
| rowspan="5" | Rendering Module
| OpenGL 3.2+ Core Profile
| style="text-align: left;" | Uses the programmable rendering pipeline and only non-deprecated functionality and is therefore compatible with OpenGL Core Profile contexts (available since OpenGL 3.2). It can also be used with older OpenGL versions and/or Compatibility Profile, as long as the required functionalities are available.
|- style="background: #eaffe8;"
| OpenGL
| style="text-align: left;" | Uses the fixed-function rendering pipeline. It is designed to be compatible with very early OpenGL versions, as early as OpenGL 1.2, using some OpenGL extensions.
|- style="background: #eaffe8;"
| Microsoft Direct3D
| style="text-align: left;" | Microsoft Direct3D 9, 10, and 11 are supported using seperate modules.
|- style="background: #eaffe8;"
| OGRE
| style="text-align: left;" | The latest stable Ogre version is supported in the releases.
|- style="background: #eaffe8;"
| Irrlicht
| style="text-align: left;" | The latest stable Irrlicht version is supported in the releases.

|- style="background: #edfcfb;"
| rowspan="4" | Image Codec Module
| SILLY
| style="text-align: left;" | Default image codec, which is based on the SILLY library. Supports many formats, see [[SILLY]]
|- style="background: #edfcfb;"
| DevIL
| style="text-align: left;" | Image codec based on the DevIL library.
|- style="background: #edfcfb;"
| FreeImage
| style="text-align: left;" | Image codec based on the FreeImage library.
|- style="background: #edfcfb;"
| OGRE
| style="text-align: left;" | Image codec that loads data via image loading facilities of OGRE.

|- style="background: #dfeff1;"
| rowspan="3" | Resource Provider Module
| Default
| style="text-align: left;" | The default resource provider of CEGUI uses standard cross-platform file-access.
|- style="background: #dfeff1;"
| OGRE
| style="text-align: left;" | Ogre users can use CEGUI's Ogre ResourceManager. This way the resource locations of CEGUI can be specified in the same way as it is done for the Ogre resources already.
|- style="background: #dfeff1;"
| minizip
| style="text-align: left;" | CEGUI's MinizipResourceProvider allows users to provides the ability to load the resource files from locations within .zip files.

|- style="background: #e9ebfc;"
| rowspan="5" | XML Parser Module
| Expat
| style="text-align: left;" | Ddefault XML parser of CEGUI. Uses the Expat library for XML parsing.
|- style="background: #e9ebfc;"
| LibXML2
| style="text-align: left;" | Uses the LibXML2 library for XML parsing.
|- style="background: #e9ebfc;"
| RapidXml
| style="text-align: left;" | Uses the RapidXml library for XML parsing.
|- style="background: #e9ebfc;"
| TinyXML
| style="text-align: left;" | Uses the TinyXML library for XML parsing.
|- style="background: #e9ebfc;"
| Xerces-C++
| style="text-align: left;" | Uses the Xerces library for XML parsing. It can do schema validation using the .xsd files provided in CEGUI's resources.
|-

|- style="background: #fae9fc;"
| rowspan="1" | Font Module
| FreeType
| style="text-align: left;" | FreeType is the default font library of CEGUI and currently the only officially supported one.

|- style="background: #f4e0e7;"
| rowspan="1" | Regular Expression Module
| Perl Compatible Regular Expressions (PCRE)
| style="text-align: left;" | Default regular expression library and currently the only officially supported one. Uses the PCRE library.

|- style="background: #fcf3e9;"
| rowspan="2" | Scripting Module
| Lua
| style="text-align: left;" | Provides lua bindings using tolua++.
|- style="background: #fcf3e9;"
| Python
| style="text-align: left;" | Official Python bindings are available using [[PyCEGUI]]

|- style="background: #f2eeca;"
| rowspan="2" | Memory Management
| OGRE
| style="text-align: left;" | Ogre's memory allocator can optionally be used for CEGUI's memory management.
|- style="background: #f2eeca;"
| nedmalloc
| style="text-align: left;" | nedmalloc can optionally be used as memory allocator.

|- style="background: #f6fce9;"
| rowspan="2" | Bi-Directional Language Module
| MiniBIDI
| style="text-align: left;" | MiniBIDI based implementation of CEGUI's Bidi visual mapping.
|- style="background: #f6fce9;"
| FriBIDI
| style="text-align: left;" | FriBIDI based implementation of CEGUI's Bidi visual mapping.

|}

CMake will automatically detect which external libraries exist on your system and will build CEGUI accordingly so make sure you install any external libraries you want to use before proceeding.
{{Note|You can turn off individual CEGUI modules from building (even if you have the required libraries installed) by changing the default [[Building from source#Build Options|Build Options]].}}

===Directories===
If you're following the directory structure outlined above, you should have something like:
cegui (root working directory)
cegui/cegui_mk2 (core CEGUI)
Create the directory ''cegui/cegui_mk2/build'' and clone the ''cegui'' repository inside cegui/cegui_mk2 with the name ''source''. Example:
{{CLI|~/cegui|mkdir cegui_mk2/build}}
{{CLI|~/cegui|hg clone https://bitbucket.org/cegui/cegui cegui_mk2/source}}
The result should be:
cegui/cegui_mk2 (core CEGUI)
cegui/cegui_mk2/build (will build here)
cegui/cegui_mk2/source (the mercurial repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

===Build Options===
There are several build options (or variables) supported by the CEGUI build system. To view them, you can use the command like or CMake GUI.

====Using the command line====
Enter the ''build'' directory and issue the following cmake command:
{{CLI|~/cegui/cegui_mk2|cd build}}
{{CLI|~/cegui/cegui_mk2/build|cmake -LH ../source}}
{{Note|On systems that default to python3 (like Arch Linux) you have to tell it to use python2 like this:}}
{{CLI|~/cegui/cegui_mk2/build|2=cmake -LH -DPYTHON_EXECUTABLE=/usr/bin/python2 ../source}}
CMake will run, it will look for the build systems available on your platform, will look for dependencies and then will print a list of variables, along with their description. For example:
// Select whether bi-directional text is enabled and which library should be used:
0: Disabled.
1: Use integrated minibidi library.
2: Use external fribidi library.
CEGUI_BIDI_SUPPORT:STRING=0
// Specifies whether to use embedded GLEW when external library was found
CEGUI_BUILD_EMBEDDED_GLEW:BOOL=OFF

====Using CMake GUI====
Start cmake-gui, select our ''source'' and ''build'' directories and click the ''Configure'' button. The available options will be listed in the main window. You can hover the mouse over an option and CMake will show a tooltip with a more detailed description.

{{Note|Changing the options and building is explained below, in [[#Building|Building]].}}

===Building===
====Configuring and Generating makefiles====
The first step is to use CMake to configure the build and generate native makefiles. Without making any configuration changes, the command would be:
{{CLI|~/cegui/cegui_mk2/build|cmake ../source}}
The same can be done using the CMake GUI. Select the ''source'' and ''build'' directories, click configure and finally click generate.

The build options can be changed via the GUI or via the CLI. If, for example, we want to turn off the slotted installation option and the python bindings we would run cmake like this:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source -DCEGUI_SLOTTED_INSTALLATION:BOOL=OFF -DCEGUI_BUILD_PYTHON_MODULES:BOOL=OFF}}
{{Note|The python bindings are required by [[#CEED|CEED]] so don't disable them if you plan to use it.}}

Another noteworthy option is the installation path, which is where CEGUI will be installed if you plan to install it via ''make install''. Change the value of the CMAKE_INSTALL_PREFIX configuration variable to set it. Example:
{{CLI|~/cegui/cegui_mk2/build|2=cmake ../source <other options here> -DCMAKE_INSTALL_PREFIX:PATH=/opt}}
so it will be installed in /opt/CEGUI (or /opt/CEGUI-0.8 if you use slotted installation).

====Make====
The second (and last required) step is using the generated native makefiles to build it. This is specific to your build environment; you may need to open the generated solution with MSVC or Xcode, or simply issue the ''make'' command.

<tabs>
<tab title="GNU Make">
* You can speed ''make'' up significantly if you have a multi-core CPU by adding the ''-jN'' parameter, when N is the number of CPU cores on your machine.
{{CLI|~/cegui/cegui_mk2/build|make -j4}}
* Optionally, run ''make install'' to install the binaries and the shared datafiles on your system.
</tab>
<tab title="MSVC">
{{Todo|MSVC notes}}
</tab>
<tab title="Xcode">
{{Todo|Xcode notes}}
</tab>
</tabs>

===Running the samples===
Now that the build has finished, you can run the sample applications to check your build. The binaries should be in the ''bin'' directory:
cegui/cegui_mk2/build/bin

The samples may fail to run initially because they can't find the required data files.
According to ''"cegui/cegui_mk2/source/Samples/common/include/CEGUISamplesConfig.h.in"'', the samples will look for the datafiles on ''"../datafiles"'' on Windows and on ''${CMAKE_INSTALL_PREFIX}/${CEGUI_DATA_INSTALL_DIR}'' on other platforms.

It is possible to change this path without rebuilding, using the environment variable ''CEGUI_SAMPLE_DATAPATH''.
<tabs>
<tab title="Linux">
{{CLI|~/cegui/cegui_mk2/build|2=CEGUI_SAMPLE_DATAPATH=../source/datafiles bin/CEGUIDemo8-0.8}}
</tab>
<tab title="Windows">
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=SET CEGUI_SAMPLE_DATAPATH="C:\Users\User\cegui\cegui_mk2\source\datafiles"}}
{{CLI|C:\Users\User\cegui\cegui_mk2\build|2=bin/CEGUIDemo8-0.8.exe}}
</tab>
</tabs>

===Documentation===
{{Note|The documentation for stable releases can be found online [http://www.cegui.org.uk/docs/current here]}}

The documentation is written in doxygen format so you need [http://www.doxygen.org/ Doxygen] to build it. If you want to generate the nice class diagrams too, you need to install [http://graphviz.org/ Graphviz].

Building the docs with the default options is easy:
{{CLI|~/cegui/cegui_mk2/build|cd ../source/doc/doxygen}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|doxygen}}

This will create a directory named ''html'' with plenty of files, just open ''index.html''.

If you'd rather change some of doxygen's options, you can edit the file ''source/doc/doxygen/doxyfile'' or, alternatively, use ''doxywizard'' (GUI).
To change doxygen's output directory, one might do something like this:
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|mkdir ../../../build/doc}}
{{CLI|~/cegui/cegui_mk2/source/doc/doxygen|nano doxyfile or use your editor of choice to edit ''doxyfile''}}

Find the line
OUTPUT_DIRECTORY =
and change it to
OUTPUT_DIRECTORY = ../../../build/doc

Now run doxygen and it will create the html docs in ''build/doc''.

==CEED==
CEED is the new CEGUI unified editor. It can edit layouts and imagesets, supports projects and multiple open file tabs, visual and source editing, preview and more. Please see [[CEED]] for a detailed description.

CEED is written in [http://www.python.org/ Python] so there's no need to build it; all that's required is Python2 and it's dependencies.

{{Note|If you'd rather use a stable package that includes dependencies, please follow [[Downloads]]}}

===Dependencies===
CEED requires a Python 2 interpreter, version 2.6 or higher.
Apart from [[PyCEGUI]] (the CEGUI Python bindings), it depends on the following libraries:
* PyOpenGL
* Qt4, PySide (+ PySide Tools)
* Boost.Python

<tabs>
<tab title="Windows">
{{Todo|Windows dependencies notes}}
</tab>
<tab title="Mac">
{{Todo|Mac dependencies notes}}
</tab>
<tab title="Arch Linux">
You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR).
{{Note|The packages from AUR may have been included in the ''[community]'' repository by now so check there first.}}
</tab>
<tab title="Debian">
;Wheezy

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list and then:

{{CLI||sudo apt-get update}}
{{CLI||sudo apt-get install cmake python-opengl pyside-tools boost-python}}

</tab>
<tab title="Fedora">
You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools.
</tab>
<tab title="Gentoo">
You can use these supplied ebuilds:[https://bitbucket.org/ChrisTrenkamp/gentoo-ogre3d-tools]. Copy these ebuilds to your local overlay[http://en.gentoo-wiki.com/wiki/Overlay#Local_Overlays], add the necessary options to your package.keywords and package.use files, and run '''''emerge -av dev-util/ceed'''''
</tab>
</tabs>

===Running===
{{Todo|Update this section when CEED/CEGUI 0.8 is released}}
If you're following the directory structure outlined in [[#Building|Building]], you should have something like:
cegui (root working directory)
cegui/CEED (CEED repository copy)

{{Todo|Add instructions on where to extract the stable source packages (when available) so that we maintain a common directory structure}}

Running the main ''ceed-gui'' application could be as simple as:
{{CLI|~/cegui/CEED|2=PYTHONPATH=.:$PYTHONPATH python2 bin/ceed-gui}}

If you don't have PyCEGUI installed system-wide but built it in ''cegui/cegui_mk2/build'', you can run ''ceed-gui'' like this:
{{CLI|~/cegui/CEED|2=PYTHONPATH=../cegui_mk2/build/lib:.:$PYTHONPATH python2 bin/ceed-gui}}

====Running from Mercurial====
If you've cloned the CEED mercurial repository, you will most likely get the following error when you try to run ''ceed-gui'':
ImportError: No module named mainwindow
This is because the compiled .ui files are not part of the repository. Edit the file ''ceed/version.py'' with your favorite text editor and change the value of '''CEED_developerMode''' from '''False''' to '''True'''.

=Troubleshooting=
If you encounter a problem that's not listed here, please make a post on the appropriate forum: [http://www.cegui.org.uk/phpBB2/viewforum.php?f=10 CEGUI], [http://www.cegui.org.uk/phpBB2/viewforum.php?f=15 CEED].

For comments about this article, you may use it's discussion page.

=Related articles=
* [[Eclipse and CEGUI]]
* [[Contribution|Contributing to the development of CEGUI]]

[[Category:HowTo]]

CEGUI In Practice - A Game Console

2014-09-13T22:11:05Z

Lucebac: Added tabber

{{VersionBadge|0.7}}
{{VersionBadge|0.8}}
{{Series|CEGUI In Practice|6}}

== CEGUI InPractice 6 ==

Welcome back! This tutorial we will put together the knowledge from the past few chapters to create a functioning Console window. The last few tutorials have given us the basics. Now its time to put that knowledge to use and make something we can use in our game.

==== Game Plan ====

Okay, now lets look at what we need to do. We will want to be able to type in commands, press the send button, and have them output into the text box. We will also probably want to acknowledge when enter is pressed as thats the 'normal' feel of typing into a chat.

We discussed earlier how to send input to CEGUI ([[CEGUI In Practice - Managing input]]), so we will have to assume that you have that working (and probably built the application structure behind it). We will also assume you used the previous tutorial's layout file and naming for the console window ( [[CEGUI In Practice - Using .layout files]]).

Due to the fact that we are getting to a slightly more advanced implementation of CEGUI here, and because we may want the ConsoleWindow to do other more useful things (like parsing strings for /say commands) I'm going to create a class to encompass the CEGUI ConsoleWindow.

<source lang="cpp">
#include <CEGUI/CEGUI.h>

class GameConsoleWindow
{
public:
GameConsoleWindow(); // Constructor
void setVisible(bool visible); // Hide or show the console
bool isVisible(); // return true if console is visible, false if is hidden

private:
void CreateCEGUIWindow(); // The function which will load in the CEGUI Window and register event handlers
void RegisterHandlers(); // Register our handler functions
bool Handle_TextSubmitted(const CEGUI::EventArgs &e); // Handle when we press Enter after typing
bool Handle_SendButtonPressed(const CEGUI::EventArgs &e); // Handle when we press the Send button
void ParseText(CEGUI::String inMsg); // Parse the text the user submitted.
void OutputText(CEGUI::String inMsg, // Post the message to the ChatHistory listbox.
CEGUI::Colour colour = CEGUI::Colour( 0xFFFFFFFF)); // with a white color default

CEGUI::Window *m_ConsoleWindow; // This will be a pointer to the ConsoleRoot window.
CEGUI::String sNamePrefix; // This will be the prefix name we give the layout
static int iInstanceNumber; // This will be the instance number for this class.
bool m_bConsole;
};
</source>

Alright, so that will be our class. It might look daunting, but don't worry it will all make sense in the end.

==== The Constructor ====

I'm going to use the constructor as the main point of automation here. And while I believe it is normally bad practice to call functions which could potentially fail within a constructor, I'm going to anyway for ease of this tutorial. We will have it Initialize some variables, and then call the CreateCEGUIWindow function.

<source lang="cpp">

int GameConsoleWindow::iInstanceNumber; // Don't forget this declaration

GameConsoleWindow::GameConsoleWindow()
{
m_ConsoleWindow = NULL; // Always good practice to initialize a pointer to a NULL value, helps when switching to Release Builds.
iInstanceNumber = 0;
sNamePrefix = "";
CreateCEGUIWindow();
setVisible(false);
m_bConsole = false;
}
</source>
==== Setting up the Window ====

Now we need to setup the window. We have done this before in the .layout tutorial so we will do it again here. However, we mentioned before that you could use a prefix when loading a .layout to avoid name conflicts if you load multiple layouts. So we need to account for that. Will we need multiple consoles? Who knows, might as well build it in while we're designing it right?

Lets write the CreateCEGUIWindow function:

<source lang="cpp">
void GameConsoleWindow::CreateCEGUIWindow()
{
// Get a local pointer to the CEGUI Window Manager, Purely for convenience to reduce typing
CEGUI::WindowManager *pWindowManager = CEGUI::WindowManager::getSingletonPtr();

// Now before we load anything, lets increase our instance number to ensure no conflicts.
// I like the format #_ConsoleRoot so thats how i'm gonna make the prefix. This simply
// Increments the iInstanceNumber then puts it + a _ into the sNamePrefix string.
sNamePrefix = ++iInstanceNumber + "_";

// Now that we can ensure that we have a safe prefix, and won't have any naming conflicts lets create the window
// and assign it to our member window pointer m_ConsoleWindow
// inLayoutName is the name of your layout file (for example "console.layout"), don't forget to rename inLayoutName by our layout file
// Note : for CEGUI 0.7
m_ConsoleWindow = pWindowManager->loadWindowLayout(inLayoutName,sNamePrefix);

// Note : for CEGUI 0.8
m_ConsoleWindow = pWindowManager->loadLayoutFromFile(inLayoutName);

// Being a good programmer, its a good idea to ensure that we got a valid window back.
if (m_ConsoleWindow)
{
// Lets add our new window to the Root GUI Window
CEGUI::System::getSingleton().getGUISheet()->addChildWindow(m_ConsoleWindow);
// Now register the handlers for the events (Clicking, typing, etc)
(this)->RegisterHandlers();
}
else
{
// Something bad happened and we didn't successfully create the window lets output the information
CEGUI::Logger::getSingleton().logEvent("Error: Unable to load the ConsoleWindow from .layout");
}
}
</source>

Alright so that created the window. And after the window was created, we Registered its handlers. Lets look at how we go about
registering those handlers. Below is the RegisterHandlers function, it will probably look familiar if you have been reading along:

<source lang="cpp">
void GameConsoleWindow::RegisterHandlers()
{
// Alright now we need to register the handlers. We mentioned above we want to acknowledge when the user presses Enter, and
// when they click the 'Send' button. So we need to register each of those events

// First lets register the Send button. Our buttons name is "ConsoleRoot/SendButton", but don't forget we prepended a name to
// all the windows which were loaded. So we need to take that into account here.
m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/SendButton")->subscribeEvent(
CEGUI::PushButton::EventClicked, // If we recall our button was of type CEGUI::PushButton in the .scheme
// and we want to acknowledge the EventClicked action.
CEGUI::Event::Subscriber( // What function to call when this is clicked. Remember, all functions
// are contained within (this) class.
&GameConsoleWindow::Handle_SendButtonPressed, // Call Handle_SendButtonPressed member of GameConsoleWindow
this)); // Using (this) instance we're in right now

// Now for the TextSubmitted, we will be registering the event on the edit box, which is where the users cursor will be when
//they press Enter. I'm not going to break this down as much, because I believe that is very ugly to read, but was a good
//way of expressing it. Here is the function call.
m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/EditBox")->subscribeEvent(CEGUI::Editbox::EventTextAccepted,
CEGUI::Event::Subscriber(&GameConsoleWindow::Handle_TextSubmitted,this));
}
</source>

That last line looks pretty ugly, but remember if you include namespace CEGUI; you won't have all those Ugly CEGUI:: prefixing all the code. As you can see, once you get the hang of registering events its pretty easy. One thing to note, is there are more than one way to account for certain actions. On the button, you could also have registered for:

<source lang="cpp">
CEGUI::PushButton::EventMouseClick
CEGUI::PushButton::EventMouseButtonDown
CEGUI::PushButton::EventMouseButtonUp
</source>
Depending on what result you were looking for, and where you wanted the action to take place. For example, windows interfaces usually react on the MouseButtonUp, allowing the user to click it, and then slide off the mouse if it wasn't what they really wanted to press.

==== The Handlers ====

Now that we have registered the events, we need to actually write the functions which will handle those events. We need to handle both the Text Submitted, and the SendButton's event.

<source lang="cpp">
bool GameConsoleWindow::Handle_TextSubmitted(const CEGUI::EventArgs &e)
{
// The following line of code is not really needed in this particular example, but is good to show. The EventArgs by itself
// only has limited uses. You will find it more useful to cast this to another type of Event. In this case WindowEventArgs
// could be much more useful as we are dealing with a CEGUI::Window. Notably, this will allow you access to the .window
// member of the argument, which will have a pointer to the window which called the event. You can imagine that would be
// useful!
const CEGUI::WindowEventArgs* args = static_cast<const CEGUI::WindowEventArgs*>(&e);

// Now we need to get the text that is in the edit box right now.
CEGUI::String Msg = m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/EditBox")->getText();

// Since we have that string, lets send it to the TextParser which will handle it from here
(this)->ParseText(Msg);

// Now that we've finished with the text, we need to ensure that we clear out the EditBox. This is what we would expect
// To happen after we press enter
m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/EditBox")->setText("");

return true;
}
</source>

Now you might be wondering why we didn't just Parse the text in here? Well If the user presses Enter, or presses the Send button the text will either way have to be parsed, and it will be parsed in the same manner. So why write the same code twice?

Below is the code for handling the SendButton being pressed. I know I just harped on rewriting code, and this will ironically look alot like the Code for when text has been submitted. But thats because we don't really need the button to do much. We probably could have just had the ButtonPress trigger the Handle_TextSubmitted above when we registered the handlers, but what if we wanted a clicking noise to be played when the player pressed the button? Then we would need a seperate handler for the Send button. Anyway 'nuff said, lets show the code.
Note : For CEGUI 0.8 the root node for layout (ConsoleRoot in this case) is not necessary so you must use this : "EditBox" and not "ConsoleRoot/EditBox" (it's the same thing for Button and other)

<source lang="cpp">
bool GameConsoleWindow::Handle_SendButtonPressed(const CEGUI::EventArgs &e)
{
CEGUI::String Msg = m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/EditBox")->getText();
(this)->ParseText(Msg);
m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/EditBox")->setText("");

return true;
}
</source>

==== Parsing that Text ====

This portion is not going to be so much CEGUI Related as it will be string manipulation.

<source lang="cpp">

void GameConsoleWindow::ParseText(CEGUI::String inMsg)
{

// I personally like working with std::string. So i'm going to convert it here.
std::string inString = inMsg.c_str();

if (inString.length() >= 1) // Be sure we got a string longer than 0
{
if (inString.at(0) == '/') // Check if the first letter is a 'command'
{
std::string::size_type commandEnd = inString.find(" ", 1);
std::string command = inString.substr(1, commandEnd - 1);
std::string commandArgs = inString.substr(commandEnd + 1, inString.length() - (commandEnd + 1));
//convert command to lower case
for(std::string::size_type i=0; i < command.length(); i++)
{
command[i] = tolower(command[i]);
}

// Begin processing

if (command == "say")
{
std::string outString = "You:" + inString; // Append our 'name' to the message we'll display in the list
OutputText(outString);
}
else if (command == "quit")
{
// do a /quit
}
else if (command == "help")
{
// do a /help
}
else
{
std::string outString = "<" + inString + "> is an invalid command.";
(this)->OutputText(outString,CEGUI::Colour(1.0f,0.0f,0.0f)); // With red ANGRY colors!
}
} // End if /
else
{
(this)->OutputText(inString); // no commands, just output what they wrote
}
}
}
</source>

Phew, thats kinda an annoying function isn't it? Well, the point to note is that it checks for a forward slash, if it finds one then it enters the if/else conditions to see if it found an applicable command. If it does it does something. In this example it handles the actions right there, if you were to write it a little more advanced, it could goto a (this)->ShowHelp() or (this)->QuitGame().

The point to note is the OutputText. That will add the items to the ListBox of Chat history. We will work on that function now.

==== OutputText ====

A point to note here. A CEGUI::Listbox window doesn't naturally word wrap. And wordwrapping is a very nice thing to have in a chat window, as everyone has different resolutions on their screens, and some people REALLY like to ramble! (But not this magnificant author of course!). So we will use a Custom created widget which is available on the forums [http://www.cegui.org.uk/phpBB2/viewtopic.php?f=10&t=4322]. you could use a normal listbox, but you wouldn't get word-wrapping.

<source lang="cpp">
void GameConsoleWindow::OutputText(CEGUI::String inMsg, CEGUI::Colour colour)
{

// Get a pointer to the ChatBox so we don't have to use this ugly getChild function everytime.
CEGUI::Listbox *outputWindow = static_cast<CEGUI::Listbox*>(m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/ChatBox"));

CEGUI::ListboxTextItem* newItem=0; // This will hold the actual text and will be the listbox segment / item

newItem = new CEGUI::ListboxTextItem(inMsg); // instance new item
newItem->setTextColours(colour); // Set the text color
outputWindow->addItem(newItem); // Add the new ListBoxTextItem to the ListBox
}
</source>

Now we add function setVisible and isVisible to toggle the visibility of the console :
<source lang="cpp">
void GameConsoleWindow::setVisible(bool visible)
{
m_ConsoleWindow->setVisible(visible);
m_bConsole = visible;

CEGUI::EditBox* editBox = m_ConsoleWindow->getChild(sNamePrefix + "ConsoleRoot/EditBox");
if(visible)
editBox->activate();
else
editBox->deactivate();
}

bool GameConsoleWindow::isVisible()
{
return m_ConsoleWindow->isVisible();
}
</source>
Here is the console.layout file:
<tabber>
CEGUI 0.8=
You can make your own with CEED if this one doesn't suit you.

<source lang="xml">
<?xml version="1.0" ?>

<GUILayout version="4">
<Window name="Console" type="TaharezLook/FrameWindow">
<Property name="AlwaysOnTop" value="True" />
<Property name="MinSize" value="{{0.2,0},{0.2,0}}" />
<Property name="MaxSize" value="{{0.8,0},{0.8,0}}" />
<Property name="Position" value="{{0.5,0},{0.5,0}}" />
<Property name="Size" value="{{0.5,0},{0.45,0}}" />
<Property name="Text" value="Console" />
<Property name="CloseButtonEnabled" value="False" />

<Window name="Submit" type="TaharezLook/Button">
<Property name="ID" value="1" />
<Property name="VerticalAlignment" value="Bottom" />
<Property name="HorizontalAlignment" value="Right" />
<Property name="MaxSize" value="{{1,0},{1,0}}" />
<Property name="Position" value="{{0,-7},{0,-7}}" />
<Property name="Size" value="{{0.25,0},{0,30}}" />
<Property name="Text" value="Submit" />
</Window>

<Window name="Editbox" type="TaharezLook/Editbox">
<Property name="ID" value="2" />
<Property name="VerticalAlignment" value="Bottom" />
<Property name="MaxSize" value="{{1,0},{1,0}}" />
<Property name="Position" value="{{0,7},{0,-7}}" />
<Property name="Size" value="{{0.75,-21},{0,30}}" />
<Property name="Text" value="" />
</Window>

<Window name="History" type="TaharezLook/Listbox">
<Property name="ID" value="3" />
<Property name="MaxSize" value="{{1,0},{1,0}}" />
<Property name="Position" value="{{0,7},{0,7}}" />
<Property name="Size" value="{{1,-14},{1,-47}}" />
</Window>
</Window>
</GUILayout>

</source>
|-|
CEGUI 0.7=
<source lang="xml">
<?xml version="1.0" encoding="UTF-8"?>

<GUILayout>
<Window Type="TaharezLook/FrameWindow" Name="ConsoleRoot" >
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,848},{0,226}}" />
<Property Name="Text" Value="Console" />
<Property Name="RollUpEnabled" Value="False" />
<Property Name="SizingEnabled" Value="False" />
<Property Name="DragMovingEnabled" Value="False" />
<AutoWindow NameSuffix="__auto_titlebar__" >
<Property Name="DraggingEnabled" Value="False" />
</AutoWindow>
<Window Type="TaharezLook/Listbox" Name="ConsoleRoot/ChatBox" >
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,0},{0,812},{0,160}}" />
</Window>
<Window Type="TaharezLook/Editbox" Name="ConsoleRoot/EditBox" >
<Property Name="UnifiedAreaRect" Value="{{0,0},{0,166},{0,649},{0,197}}" />
</Window>
<Window Type="TaharezLook/Button" Name="ConsoleRoot/SendButton" >
<Property Name="UnifiedAreaRect" Value="{{0,672},{0,164},{0,771},{0,196}}" />
<Property Name="Text" Value="Send" />
</Window>
</Window>
</GUILayout>
</source>
</tabber>

==== Conclusion ====

And that ladies and gentleman, is our Console box. Not too terrible was it? Now of course, remember there are many ways to skin the proverbial cat. This is just an example of ways to do things. If you would like some homework, you could investigate why the SendButton does weird things when you drag and resize the window. I'll give you a hint, look at the way we're defining how big the ConsoleRoot is and where its child windows are placed... and what implications we might have by using relative scales for things.. Okay, i guess that was a big hint wasn't it!

Till next time...

[[Category:Tutorials]]

Mpreisler TODO

2014-09-02T11:24:51Z

Lucebac: /* Done (good job, very nice, awesome job!) */

== Open Tasks ==

* Split OpenGL Renderer into OpenGL and OpenGL3 Renderer while sharing common files
* Merge CoreWindowRenderer into CEGUI base and maybe some of the other CEGUI libs as well (?)
* "we should do a better job at guessing paths in the sample browser though. I wanted to look into that"
* replace Vector2f, Vector3f and Quaternion with glm classes"

== Done (good job, very nice, awesome job!) ==
* Fix the PyCEGUI bindings for the PropertyDefinitions, PropertyLinkDefinitions, etc
* "we probably should add code examples to EventSet <br /> mpreisler how to bind a free function, class method, how to use it with boost::bind and C++ lambdas"
* Merge all sample dlls of the SampleBrowser into a single executable (done by lucebac)

Mpreisler TODO

2014-09-02T11:24:40Z

Lucebac:

CELayout Editor - Getting Started / Building

2014-08-24T21:04:32Z

Lucebac:

{{VersionBadge|0.6}}

{{notice|message=It is strongly recommended ''not'' to use CELayoutEditor anymore. Use [[CEED]] instead, please.}}

== Abstract ==

This page tries to get you up and running with the layout editor. It will explain both the use of a distribution, and downloading from SVN. If you have problems, don't hesitate to visit the forums. And besides, you may alter this page with any information you think will be helpful to future readers of this page.
Some parts might be a little too verbose, but better safe then sorry ;-) If you're done reading, don't forget to read the [http://www.cegui.org.uk/wiki/index.php/Manual manual].

== Using a distribution ==

This is the recommended way. The distributions are stable and compatible with official CEGUI library releases. For example the 0.4.1 editor will work fine ("proven") with the 0.4.1 CEGUI release. Visit the [http://www.cegui.org.uk/wiki/index.php/Downloads download page] for Windows installer(s) and Linux source distribution(s). Before installing a new version, it is recommeded that you uninstall a previous version first, because files might get removed in newer versions and such.
On windows you can stop reading now. Linux and/or SVN users must read on for a bit more.

== Compiling yourself ==
If you are a non-windows user, or prefer SVN access over distributions, you must follow the steps mentioned in this topic.

=== Setup CEGUI ===
Please see the [http://www.cegui.org.uk/wiki/index.php/HOWTO:_Obtain_the_library_source_from_subversion CEGUI download info] for downloading and compiling the cegui library.

= Compile WxWidgets =

This topic explains how to get and setup this cross-platform application framework.

Distributions for many platforms can be found [http://www.wxwidgets.org/downld2.htm here].

== On Windows ==

=== Recommended: WxWidgets (2.8.11) ===

* [http://prdownloads.sourceforge.net/wxwindows/wxWidgets-2.8.11.zip Download as .zip]
* I recommend applying the following change manually in the file '''wxWidgets-2.8.11\src\msw\stdpaths.cpp''' :
In the function '''wxString wxStandardPaths::GetAppDir()''' ( starting at line 249 ) delete the lines 253 - 263 which should be equal to the following code snippet:
<source lang="cpp">
// allow running the apps directly from build directory in debug builds
#ifdef __WXDEBUG__
wxString lastdir;
if ( fn.GetDirCount() )
{
lastdir = fn.GetDirs().Last();
lastdir.MakeLower();
if ( lastdir.Matches(_T("debug*")) || lastdir.Matches(_T("vc_msw*")) )
fn.RemoveLastDir();
}
#endif // __WXDEBUG__
</source>
Deleting those lines will fix a bug leading to inconsistency between debug and release and allows you to load the splash screen png-file directly from the debug directory, same as it is the case for release. Otherwise, for the debug configuration the splash screen will be loaded from the bin directory (one level above).
* For compiling you have two options:
** Option 1 (fast): Compile using Visual Studio command line
*** Open the VS command line ( Start->All Programs->Microsoft Visual Studio->Visual Studio Tools->Visual Studio command line )
*** In the command line change to the build directory '''wxWidgets-2.8.11\build\msw''' (example: "'''cd C:\wxWidgets-2.8.11\build\msw'''")
*** To compile the debug configuration enter '''nmake -f makefile.vc BUILD=debug UNICODE=1 USE_OPENGL=1'''
*** To compile the release configuration enter '''nmake -f makefile.vc BUILD=release UNICODE=1 USE_OPENGL=1'''
** Option 2: Compile using the Visual Studio solution:
*** Change the lines '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1''' in the following files:
*** '''wxWidgets-2.8.11\include\wx\msw\setup.h'''
*** '''wxWidgets-2.8.11\include\wx\msw\setup0.h'''
*** '''wxWidgets-2.8.11\include\wx\univ\setup.h'''
*** Start '''wxWidgets-2.8.11\build\msw\wx.dsw''' (if saving the project afterwards, you can open wx.sln for later use cases)
*** Build all projects in "Unicode Debug" and "Unicode Release" configurations

=== WxWidgets (2.9.0) ===
* '''NOTE:''' Appearently this release doesn't work well with the editor yet. Please use 2.8.10 as latest 'safe' release.
* Download [http://www.wxwidgets.org/downloads/ wxAll].
* Edit '''wxWidgets-2.9.0\include\wx\msw\setup.h''', '''wxWidgets-2.9.0\include\wx\msw\setup0.h''' and '''wxWidgets-2.9.0\include\wx\univ\setup.h''' to change from '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1'''.
* Build '''wxWidgets-2.9.0\build\msw\wx.dsw''' (Appearently recent wx releases include solutions for vc7, 8 and 9 too).
* More unknown changes???

=== WxWidgets (2.8.3 - 2.8.10) ===

* Download [http://www.wxwidgets.org/downloads/ wxAll].
* Edit '''wxWidgets-2.8.3\include\wx\msw\setup0.h''' and '''wxWidgets-2.8.3\include\wx\univ\setup.h''' to change from '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1'''.
* Build '''wxWidgets-2.8.3\build\msw\wx.dsw'''
* More unknown changes???

=== WxWidgets (2.6.4) ===

* Download [http://www.wxwidgets.org/downloads/ wxAll].
* Edit '''wxWidgets-2.6.4\include\wx\msw\setup.h''' and '''wxWidgets-2.6.4\include\wx\univ\setup.h''' to change from '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1'''.
* Build '''wxWidgets-2.6.4\build\msw\wx.dsw'''

'''Note: '''I (scriptkid) always use the regular 'unicode debug' and 'unicode release' builds. But i assume that the DLLs will work fine too. If it hasn't been done so already, add 'include/msvc' and include to the include build paths and 'lib/vc_lib' to the library paths in Visual Studio.

=== WxWidgets (less than 2.6.4) ===

Because of issues I had compiling wxWidgets properly, I'm going to go into more depth for using Visual Studio 7.1 or 8.0 to do so. (Jouninkomiko 05-20-2006)

* Because the editor uses the wxGLCanvas, open include/msvc/wx/setup.h, and change the define for wxUSE_GLCANVAS from 0 to 1.
** Within the src/wxWindows.dsw solution you'll find this setting inside the wxWindows project, under Headers/Setup/setup.h

'''NOTE:''' Another Windows specific step-by-step guide was posted in the forums by [[User:fjeronimo|fjeronimo]] and can be read here: http://www.cegui.org.uk/phpBB2/viewtopic.php?t=2760

== On Linux ==
* Enter ./configure --with-opengl --enable-unicode
* Enter make
* Enter make install

=== Setup the editor ===
This topic explains how to get and setup the editor from sources.

==== Checkout ====
If you use a non-command line utility such as TortoiseSVN, you can choose one of these URLs to respectively checkout the HEAD or one of the stable branches.
http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/trunk
http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/v-0-4-1
http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/before_wxwidgets

Or, from the command line (same order):
svn co http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/trunk MyEditorFolder
svn co http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/v-0-4-1 MyEditorFolder
svn co http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/before_wxwidgets MyEditorFolder

Retreiving is always "anonymous", so it should work immediately.

==== Compile ====

On windows:
* Open vc++6/CELayoutEditor.dsw (VS6) or vc++6/CELayoutEditor.sln (VS7.1). Conversions should happen automatically when opening on newer versions. Make sure that you add the directories 'wxWidgets-x.x.x\include' and 'wxWidgets-x.x.x\include\msvc' to your Include Directories, and 'wxWidgets-x.x.x\lib\vc_lib' to your Library Directories.
* Also add CEGUI-0.5.0 to the project include folders.
* Also add CEGUI-0.5.0\include to the project include folders.
* Build either Debug or Release.

On Linux:
* Enter ./bootstrap
* Enter ./configure
* Enter make
* Enter make install
* Optionally set the CELAYOUTEDITOR_DATAPATH environment variable to point the editor to the correct 'datafiles' directory. If you do not set this variable, the editor will default to the location where it thinks the datafiles were installed (this will be typically be something like /usr/local/share/CELayoutEditor/datafiles). See the configuration file for additional details.

Hopefully, we will have a mac-compatible project or makefile in the future as well, so watch this space! :-)

== Setup CELayoutEditor ==

* If using the Visual Studio solution: go to the '''Project Settings''' and under '''Debugging''' set '''$(TargetDir)''' as the '''working directory''' for your configurations ('''Debug''' and '''Release''').

* Get all the '''CEGUI dll s''' you need and place them in your working directories. ( e.g. in '''C:\CELayoutEditor\bin\debug''' and '''C:\CELayoutEditor\bin\release''' if "C:\CELayoutEditor" is your checkout directory). You will also need '''SILLY.dll''' and '''SILLY_d.dll''' from the CEGUI dependencies respectively placed in the release and debug directories.

* Now after compiling, the CELayoutEditor should be ready to start and working. Everything regarding the .ini files and handling the editor should be covered in the manual.

[[Category:Tutorials]]

CELayout Editor - Getting Started / Building

2014-08-24T20:54:46Z

Lucebac:

{{VersionBadge|0.6}}

== Advice ==

CELayoutEditor is out-of-date. Please use [[CEED]] instead.

== Abstract ==

This page tries to get you up and running with the layout editor. It will explain both the use of a distribution, and downloading from SVN. If you have problems, don't hesitate to visit the forums. And besides, you may alter this page with any information you think will be helpful to future readers of this page.
Some parts might be a little too verbose, but better safe then sorry ;-) If you're done reading, don't forget to read the [http://www.cegui.org.uk/wiki/index.php/Manual manual].

== Using a distribution ==

This is the recommended way. The distributions are stable and compatible with official CEGUI library releases. For example the 0.4.1 editor will work fine ("proven") with the 0.4.1 CEGUI release. Visit the [http://www.cegui.org.uk/wiki/index.php/Downloads download page] for Windows installer(s) and Linux source distribution(s). Before installing a new version, it is recommeded that you uninstall a previous version first, because files might get removed in newer versions and such.
On windows you can stop reading now. Linux and/or SVN users must read on for a bit more.

== Compiling yourself ==
If you are a non-windows user, or prefer SVN access over distributions, you must follow the steps mentioned in this topic.

=== Setup CEGUI ===
Please see the [http://www.cegui.org.uk/wiki/index.php/HOWTO:_Obtain_the_library_source_from_subversion CEGUI download info] for downloading and compiling the cegui library.

= Compile WxWidgets =

This topic explains how to get and setup this cross-platform application framework.

Distributions for many platforms can be found [http://www.wxwidgets.org/downld2.htm here].

== On Windows ==

=== Recommended: WxWidgets (2.8.11) ===

* [http://prdownloads.sourceforge.net/wxwindows/wxWidgets-2.8.11.zip Download as .zip]
* I recommend applying the following change manually in the file '''wxWidgets-2.8.11\src\msw\stdpaths.cpp''' :
In the function '''wxString wxStandardPaths::GetAppDir()''' ( starting at line 249 ) delete the lines 253 - 263 which should be equal to the following code snippet:
<source lang="cpp">
// allow running the apps directly from build directory in debug builds
#ifdef __WXDEBUG__
wxString lastdir;
if ( fn.GetDirCount() )
{
lastdir = fn.GetDirs().Last();
lastdir.MakeLower();
if ( lastdir.Matches(_T("debug*")) || lastdir.Matches(_T("vc_msw*")) )
fn.RemoveLastDir();
}
#endif // __WXDEBUG__
</source>
Deleting those lines will fix a bug leading to inconsistency between debug and release and allows you to load the splash screen png-file directly from the debug directory, same as it is the case for release. Otherwise, for the debug configuration the splash screen will be loaded from the bin directory (one level above).
* For compiling you have two options:
** Option 1 (fast): Compile using Visual Studio command line
*** Open the VS command line ( Start->All Programs->Microsoft Visual Studio->Visual Studio Tools->Visual Studio command line )
*** In the command line change to the build directory '''wxWidgets-2.8.11\build\msw''' (example: "'''cd C:\wxWidgets-2.8.11\build\msw'''")
*** To compile the debug configuration enter '''nmake -f makefile.vc BUILD=debug UNICODE=1 USE_OPENGL=1'''
*** To compile the release configuration enter '''nmake -f makefile.vc BUILD=release UNICODE=1 USE_OPENGL=1'''
** Option 2: Compile using the Visual Studio solution:
*** Change the lines '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1''' in the following files:
*** '''wxWidgets-2.8.11\include\wx\msw\setup.h'''
*** '''wxWidgets-2.8.11\include\wx\msw\setup0.h'''
*** '''wxWidgets-2.8.11\include\wx\univ\setup.h'''
*** Start '''wxWidgets-2.8.11\build\msw\wx.dsw''' (if saving the project afterwards, you can open wx.sln for later use cases)
*** Build all projects in "Unicode Debug" and "Unicode Release" configurations

=== WxWidgets (2.9.0) ===
* '''NOTE:''' Appearently this release doesn't work well with the editor yet. Please use 2.8.10 as latest 'safe' release.
* Download [http://www.wxwidgets.org/downloads/ wxAll].
* Edit '''wxWidgets-2.9.0\include\wx\msw\setup.h''', '''wxWidgets-2.9.0\include\wx\msw\setup0.h''' and '''wxWidgets-2.9.0\include\wx\univ\setup.h''' to change from '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1'''.
* Build '''wxWidgets-2.9.0\build\msw\wx.dsw''' (Appearently recent wx releases include solutions for vc7, 8 and 9 too).
* More unknown changes???

=== WxWidgets (2.8.3 - 2.8.10) ===

* Download [http://www.wxwidgets.org/downloads/ wxAll].
* Edit '''wxWidgets-2.8.3\include\wx\msw\setup0.h''' and '''wxWidgets-2.8.3\include\wx\univ\setup.h''' to change from '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1'''.
* Build '''wxWidgets-2.8.3\build\msw\wx.dsw'''
* More unknown changes???

=== WxWidgets (2.6.4) ===

* Download [http://www.wxwidgets.org/downloads/ wxAll].
* Edit '''wxWidgets-2.6.4\include\wx\msw\setup.h''' and '''wxWidgets-2.6.4\include\wx\univ\setup.h''' to change from '''#define wxUSE_GLCANVAS 0''' to '''#define wxUSE_GLCANVAS 1'''.
* Build '''wxWidgets-2.6.4\build\msw\wx.dsw'''

'''Note: '''I (scriptkid) always use the regular 'unicode debug' and 'unicode release' builds. But i assume that the DLLs will work fine too. If it hasn't been done so already, add 'include/msvc' and include to the include build paths and 'lib/vc_lib' to the library paths in Visual Studio.

=== WxWidgets (less than 2.6.4) ===

Because of issues I had compiling wxWidgets properly, I'm going to go into more depth for using Visual Studio 7.1 or 8.0 to do so. (Jouninkomiko 05-20-2006)

* Because the editor uses the wxGLCanvas, open include/msvc/wx/setup.h, and change the define for wxUSE_GLCANVAS from 0 to 1.
** Within the src/wxWindows.dsw solution you'll find this setting inside the wxWindows project, under Headers/Setup/setup.h

'''NOTE:''' Another Windows specific step-by-step guide was posted in the forums by [[User:fjeronimo|fjeronimo]] and can be read here: http://www.cegui.org.uk/phpBB2/viewtopic.php?t=2760

== On Linux ==
* Enter ./configure --with-opengl --enable-unicode
* Enter make
* Enter make install

=== Setup the editor ===
This topic explains how to get and setup the editor from sources.

==== Checkout ====
If you use a non-command line utility such as TortoiseSVN, you can choose one of these URLs to respectively checkout the HEAD or one of the stable branches.
http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/trunk
http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/v-0-4-1
http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/before_wxwidgets

Or, from the command line (same order):
svn co http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/trunk MyEditorFolder
svn co http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/v-0-4-1 MyEditorFolder
svn co http'''s'''://crayzedsgui.svn.sourceforge.net/svnroot/crayzedsgui/CELayoutEditor/branches/before_wxwidgets MyEditorFolder

Retreiving is always "anonymous", so it should work immediately.

==== Compile ====

On windows:
* Open vc++6/CELayoutEditor.dsw (VS6) or vc++6/CELayoutEditor.sln (VS7.1). Conversions should happen automatically when opening on newer versions. Make sure that you add the directories 'wxWidgets-x.x.x\include' and 'wxWidgets-x.x.x\include\msvc' to your Include Directories, and 'wxWidgets-x.x.x\lib\vc_lib' to your Library Directories.
* Also add CEGUI-0.5.0 to the project include folders.
* Also add CEGUI-0.5.0\include to the project include folders.
* Build either Debug or Release.

On Linux:
* Enter ./bootstrap
* Enter ./configure
* Enter make
* Enter make install
* Optionally set the CELAYOUTEDITOR_DATAPATH environment variable to point the editor to the correct 'datafiles' directory. If you do not set this variable, the editor will default to the location where it thinks the datafiles were installed (this will be typically be something like /usr/local/share/CELayoutEditor/datafiles). See the configuration file for additional details.

Hopefully, we will have a mac-compatible project or makefile in the future as well, so watch this space! :-)

== Setup CELayoutEditor ==

* If using the Visual Studio solution: go to the '''Project Settings''' and under '''Debugging''' set '''$(TargetDir)''' as the '''working directory''' for your configurations ('''Debug''' and '''Release''').

* Get all the '''CEGUI dll s''' you need and place them in your working directories. ( e.g. in '''C:\CELayoutEditor\bin\debug''' and '''C:\CELayoutEditor\bin\release''' if "C:\CELayoutEditor" is your checkout directory). You will also need '''SILLY.dll''' and '''SILLY_d.dll''' from the CEGUI dependencies respectively placed in the release and debug directories.

* Now after compiling, the CELayoutEditor should be ready to start and working. Everything regarding the .ini files and handling the editor should be covered in the manual.

[[Category:Tutorials]]

CEED

2014-07-17T14:30:24Z

Lucebac: /* Building CEED on Windows */

The CEGUI unified editor. Includes project management and multi-file/multi-tab editing.

== Building CEED on Windows ==
Follow these instructions for building and installing CEED on Windows OS: http://cegui.org.uk/wiki/Building_CEED_for_Windows

Or, if you don't want to build it yourself, you can use the precompiled binaries: http://sourceforge.net/projects/crayzedsgui/files/CEED/0.8/

== Install ==

CEED from the v0-8 branch (and all snapshots) depend on CEGUI 0.8. Even though it may work with CEGUI "default" it is not tested with it so don't expect any help if you try to make it work that way.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums] (very old, don't use!)

=== Dependencies ===

You need CMake, Python >= 2.6 (preferably Python 2.7), PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

==== Arch Linux ====

You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR). PySide will bring in several other packages and will probably take a few hours to compile.

Note: You probably need to add "-DPYTHON_EXECUTABLE=/usr/bin/python2" (without the quotes) to the cmake command line below because Arch Linux defaults to python 3 but the python modules CMake script expects python2.

Arch Linux has the entire ceed packaged, see the AUR repo and save yourself all this trouble.

==== Fedora ====

You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools

=== Build CEGUI and PyCEGUI ===

(Or get it from distribution repo and skip this)

hg clone https://bitbucket.org/cegui/cegui
hg clone https://bitbucket.org/cegui/ceed
cd ceed
hg update v0-8
cd ../
cd cegui
hg update v0-8
cd ../
mkdir cegui/build
cd cegui/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON -DCEGUI_BUILD_RENDERER_OPENGL=ON -DCEGUI_BUILD_RENDERER_OPENGL3=ON ../

==== Renderers ====

CEED requires the OpenGL2 renderer to be enabled. This is what it uses to function. However in CEGUI 0.8 you have to enable both OpenGL2 and OpenGL3 renderers for the bindings to work correctly.

Make sure "CEGUI_BUILD_RENDERER_OPENGL" and "CEGUI_BUILD_RENDERER_OPENGL3" are both enabled before you build CEGUI.

== Launch ==

cd ../ceed
cd bin
./runwrapper.sh
./ceed-gui

or
$ cd ../ceed/bin
$ PYTHONPATH=../../cegui/build/lib:../:$PYTHONPATH python2 ./ceed-gui

You will see a window like this:

[[Image:Ceed_main_window.png]]

=== Troubleshooting ===
* If it fails to import ceed.ui.* then you need to compile UI files, call
[ceed] ./maintenance compile-ui-files
Or alternatively edit ceed/version.py and set CEED_developerMode to True.
* If the data files are missing you need to run the 'maintenance' script like this:
[ceed/bin]$ cd ..
[ceed]$ ./maintenance fetch-datafiles

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

To create a new widget, drag it from the left bottom panel.

To edit it, you can either do it visually, or switch to "Code" tab seen below, and edit it manually. There's also "Preview" tab, where you can test your layout in real time.

=== Imagesets ===

[[Image:Ceed_imageset.png]]

To create a new image, press tool bar button second from the right, or click with the right mouse button on the image itself and select '''Create image''':

[[Image:Ceed_imageset_create_image.png]]

It creates a 50 x 50 rectangle centered at where mouse cursor is. Move and resize it as you see fit.

== Settings ==
Go to '''Edit -> Application settings'''.

[[Image:Ceed_application_settings.png]]

There are many settings you can tweak. One of the most important might be '''Shortcuts'''. It allows you to assign shortcuts to zoom, image creation, opening a project, and so on.

== Notes ==

You can now use the ceed-migrate tool for converting between old and new CEGUI datafiles. Here is a quick guide for that: http://cegui.org.uk/wiki/Using_CEED-Migrate

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

CEED

2014-07-17T14:30:05Z

Lucebac: /* Building CEED on Windows */

The CEGUI unified editor. Includes project management and multi-file/multi-tab editing.

== Building CEED on Windows ==
Follow these instructions for building and installing CEED on Windows OS: http://cegui.org.uk/wiki/Building_CEED_for_Windows

Or, if you don't want to build it for yourself, you can use the precompiled binaries: http://sourceforge.net/projects/crayzedsgui/files/CEED/0.8/

== Install ==

CEED from the v0-8 branch (and all snapshots) depend on CEGUI 0.8. Even though it may work with CEGUI "default" it is not tested with it so don't expect any help if you try to make it work that way.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums] (very old, don't use!)

=== Dependencies ===

You need CMake, Python >= 2.6 (preferably Python 2.7), PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

==== Arch Linux ====

You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR). PySide will bring in several other packages and will probably take a few hours to compile.

Note: You probably need to add "-DPYTHON_EXECUTABLE=/usr/bin/python2" (without the quotes) to the cmake command line below because Arch Linux defaults to python 3 but the python modules CMake script expects python2.

Arch Linux has the entire ceed packaged, see the AUR repo and save yourself all this trouble.

==== Fedora ====

You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools

=== Build CEGUI and PyCEGUI ===

(Or get it from distribution repo and skip this)

hg clone https://bitbucket.org/cegui/cegui
hg clone https://bitbucket.org/cegui/ceed
cd ceed
hg update v0-8
cd ../
cd cegui
hg update v0-8
cd ../
mkdir cegui/build
cd cegui/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON -DCEGUI_BUILD_RENDERER_OPENGL=ON -DCEGUI_BUILD_RENDERER_OPENGL3=ON ../

==== Renderers ====

CEED requires the OpenGL2 renderer to be enabled. This is what it uses to function. However in CEGUI 0.8 you have to enable both OpenGL2 and OpenGL3 renderers for the bindings to work correctly.

Make sure "CEGUI_BUILD_RENDERER_OPENGL" and "CEGUI_BUILD_RENDERER_OPENGL3" are both enabled before you build CEGUI.

== Launch ==

cd ../ceed
cd bin
./runwrapper.sh
./ceed-gui

or
$ cd ../ceed/bin
$ PYTHONPATH=../../cegui/build/lib:../:$PYTHONPATH python2 ./ceed-gui

You will see a window like this:

[[Image:Ceed_main_window.png]]

=== Troubleshooting ===
* If it fails to import ceed.ui.* then you need to compile UI files, call
[ceed] ./maintenance compile-ui-files
Or alternatively edit ceed/version.py and set CEED_developerMode to True.
* If the data files are missing you need to run the 'maintenance' script like this:
[ceed/bin]$ cd ..
[ceed]$ ./maintenance fetch-datafiles

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

To create a new widget, drag it from the left bottom panel.

To edit it, you can either do it visually, or switch to "Code" tab seen below, and edit it manually. There's also "Preview" tab, where you can test your layout in real time.

=== Imagesets ===

[[Image:Ceed_imageset.png]]

To create a new image, press tool bar button second from the right, or click with the right mouse button on the image itself and select '''Create image''':

[[Image:Ceed_imageset_create_image.png]]

It creates a 50 x 50 rectangle centered at where mouse cursor is. Move and resize it as you see fit.

== Settings ==
Go to '''Edit -> Application settings'''.

[[Image:Ceed_application_settings.png]]

There are many settings you can tweak. One of the most important might be '''Shortcuts'''. It allows you to assign shortcuts to zoom, image creation, opening a project, and so on.

== Notes ==

You can now use the ceed-migrate tool for converting between old and new CEGUI datafiles. Here is a quick guide for that: http://cegui.org.uk/wiki/Using_CEED-Migrate

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

CEED

2014-07-17T14:29:03Z

Lucebac: /* Building CEED on Windows */

The CEGUI unified editor. Includes project management and multi-file/multi-tab editing.

== Building CEED on Windows ==
Follow these instructions for building and installing CEED on Windows OS: http://cegui.org.uk/wiki/Building_CEED_for_Windows
Or, if you don't want to build it for yourself, you can use the precompiled binaries: http://sourceforge.net/projects/crayzedsgui/files/CEED/0.8/

== Install ==

CEED from the v0-8 branch (and all snapshots) depend on CEGUI 0.8. Even though it may work with CEGUI "default" it is not tested with it so don't expect any help if you try to make it work that way.

[http://www.cegui.org.uk/phpBB2/viewtopic.php?f=15&t=5566 Original post at the forums] (very old, don't use!)

=== Dependencies ===

You need CMake, Python >= 2.6 (preferably Python 2.7), PyOpenGL, PySide (+ utils/tools), Boost.Python.

==== Debian Wheezy ====

PySide is part of Sid at the moment, so you have to add its repository address to your /etc/apt/sources.list

apt-get install cmake python-opengl pyside-tools boost-python

==== Arch Linux ====

You need at least python2, boost, python-opengl, pyside (AUR), pyside-tools (AUR). PySide will bring in several other packages and will probably take a few hours to compile.

Note: You probably need to add "-DPYTHON_EXECUTABLE=/usr/bin/python2" (without the quotes) to the cmake command line below because Arch Linux defaults to python 3 but the python modules CMake script expects python2.

Arch Linux has the entire ceed packaged, see the AUR repo and save yourself all this trouble.

==== Fedora ====

You need boost-devel, python-devel, python-opengl, python-pyside, pyside-tools

=== Build CEGUI and PyCEGUI ===

(Or get it from distribution repo and skip this)

hg clone https://bitbucket.org/cegui/cegui
hg clone https://bitbucket.org/cegui/ceed
cd ceed
hg update v0-8
cd ../
cd cegui
hg update v0-8
cd ../
mkdir cegui/build
cd cegui/build
cmake -DCEGUI_BUILD_PYTHON_MODULES=ON -DCEGUI_BUILD_RENDERER_OPENGL=ON -DCEGUI_BUILD_RENDERER_OPENGL3=ON ../

==== Renderers ====

CEED requires the OpenGL2 renderer to be enabled. This is what it uses to function. However in CEGUI 0.8 you have to enable both OpenGL2 and OpenGL3 renderers for the bindings to work correctly.

Make sure "CEGUI_BUILD_RENDERER_OPENGL" and "CEGUI_BUILD_RENDERER_OPENGL3" are both enabled before you build CEGUI.

== Launch ==

cd ../ceed
cd bin
./runwrapper.sh
./ceed-gui

or
$ cd ../ceed/bin
$ PYTHONPATH=../../cegui/build/lib:../:$PYTHONPATH python2 ./ceed-gui

You will see a window like this:

[[Image:Ceed_main_window.png]]

=== Troubleshooting ===
* If it fails to import ceed.ui.* then you need to compile UI files, call
[ceed] ./maintenance compile-ui-files
Or alternatively edit ceed/version.py and set CEED_developerMode to True.
* If the data files are missing you need to run the 'maintenance' script like this:
[ceed/bin]$ cd ..
[ceed]$ ./maintenance fetch-datafiles

== Project ==

Unlike old editors (CELayoutEditor and CEImagesetEditor), CEED has a notion of a project. Each project has its own combination of resources and runs its own CEGUI version to render your CEGUI resources. This allows you to have more that one scheme loaded at a time.

To create a new project, you should go to '''File -> New project'''.

The dialog appears. You should input project name and location of the ".project" file. '''Note''': parent directory of the ".project" file must exist.

[[Image:Ceed_new_project.png]]

After you press '''OK''', Project settings window appears.

=== Project settings ===

(The window is also accessible from '''Edit -> Project settings''')

[[Image:Ceed_project_settings.png]]

CEED can create assets for CEGUI versions: 0.6 to 0.8. 0.7 is the latest stable, so select it.

Point "Resource directory" to the place where "fonts", "schemes" and the rest directories are located, then press '''Apply'''. It will change the paths below.

Press '''OK''' and will load your resources. If it fails to, it will show you a warning dialog:

[[Image:Ceed_new_project_warning.png]]

In our case, the resource directory does not have "schemes" subdirectory, as noted on the last line. Correct the paths and retry.

=== Project resources ===

Currently CEED can only work with imagesets and layouts. Add them to your project by clicking with the right mouse button on '''Project manager''' and selecting '''Add existing file(s)''':

[[Image:Ceed_project_add_existing.png]]

Select the necessary imagesets and layouts, and save the project.

=== Layouts ===

[[Image:Ceed_layout.png]]

To create a new widget, drag it from the left bottom panel.

To edit it, you can either do it visually, or switch to "Code" tab seen below, and edit it manually. There's also "Preview" tab, where you can test your layout in real time.

=== Imagesets ===

[[Image:Ceed_imageset.png]]

To create a new image, press tool bar button second from the right, or click with the right mouse button on the image itself and select '''Create image''':

[[Image:Ceed_imageset_create_image.png]]

It creates a 50 x 50 rectangle centered at where mouse cursor is. Move and resize it as you see fit.

== Settings ==
Go to '''Edit -> Application settings'''.

[[Image:Ceed_application_settings.png]]

There are many settings you can tweak. One of the most important might be '''Shortcuts'''. It allows you to assign shortcuts to zoom, image creation, opening a project, and so on.

== Notes ==

You can now use the ceed-migrate tool for converting between old and new CEGUI datafiles. Here is a quick guide for that: http://cegui.org.uk/wiki/Using_CEED-Migrate

Currently you may have problems with Imagesets that use TGA, since some versions of Qt may be built without TGA support. CEGUI 0.8 has all imagery as PNG (CEGUI 0.7 used TGA), and we advise you to use PNG instead of TGA.

Overview of GUI files

2014-07-16T14:46:38Z

Lucebac:

There are a lot of files that go into creating a GUI with CEGUI. Here is an overview (thanks to lindquist for the original version). An expanded version of this brief overview would be quite useful.

== Overview of CEGUI resource files ==
=== '''.imageset Files''' ===
An imageset is an xml file describing a set of images contained in an image file.
When an imageset is loaded, images from that file become available to the application via the [http://static.cegui.org.uk/docs/current/classCEGUI_1_1ImageManager.html ImageManager].

Editor: [[CEED]]

=== '''[[Scheme files]]''' ===
A scheme file is an xml file describing the binding of widgets defined in a looknfeel file and the base Falagard widget set. Once loaded the components in the scheme file are available via the [http://static.cegui.org.uk/docs/current/classCEGUI_1_1WindowManager.html WindowManager]. A detailed description of [[Scheme files]] is also available.

Editor: none

=== '''.looknfeel Files''' ===
These are also xml files, which define the visual aspect of widgets declared in the scheme file.

Editor: none

=== '''.layout Files''' ===
A layout file is also in xml format. It describes a set of widgets to create and their positions, sizes, and other attributes. Basically this describes the final on-screen layout of your GUI, hence the name.

Editor: [[CEED]]

=== '''.font Files''' ===
These simple xml files give the location of a font file (like a TrueType .ttf file) and define a few extra properties about how CEGUI should use that font.

Editor:

== About Falagard Skinning System ==
Falagard is the part of the API that makes it possible to create a completely new set of widgets (at the visual level) from XML files.

You can, with a looknfeel, describe a widget and make it appear as you want (by using images defined in some imageset) and finally bind it to one of the widgets from a Falagard Base widget set in a scheme file.

Link: [http://static.cegui.org.uk/docs/current/fal_man.html Falagard skinning system for CEGUI]

== Related Documents ==
* [[XML File formats]] - Detailed documentation of the various XML file formats.

[[Category:Manuals]]