CEGUI In Practice - Introduction - Revision history

Bakaiya: /* Bootstrapping CEGUI / Function actually takes argument of type 'Ogre::RenderTarget &target' not 'Ogre::RenderWindow', so the pointer symbol was removed.

2014-05-16T04:13:09Z

‎Bootstrapping CEGUI: Function actually takes argument of type 'Ogre::RenderTarget &target' not 'Ogre::RenderWindow*', so the pointer symbol was removed.

Superpws at 07:22, 30 March 2014

2014-03-30T07:22:27Z

Superpws: /* Back to Getting Started */

2014-03-29T14:37:09Z

‎Back to Getting Started

Superpws: /* Bootstrapping CEGUI */

2014-03-29T14:32:29Z

‎Bootstrapping CEGUI

Superpws: /* Including necessary headers */

2014-03-29T14:29:42Z

‎Including necessary headers

Doubleyou at 09:14, 20 June 2011

2011-06-20T09:14:17Z

Doubleyou at 08:55, 20 June 2011

2011-06-20T08:55:44Z

Kiwibonga: /* Getting Started */

2011-04-26T19:46:25Z

‎Getting Started

Kulik: PyCEGUIOgreRenderer is a module, the classes fully qualified name is longer

2011-03-24T17:08:39Z

PyCEGUIOgreRenderer is a module, the classes fully qualified name is longer

Kulik at 16:23, 17 March 2011

2011-03-17T16:23:53Z

@@ Line 55: / Line 55: @@
 [Note: This is a newer method using the bootstrapSystem, this was introduced in CEGUI 0.7.1.  There are examples on this wiki using older versions of CEGUI.  Please make note of which version you are using] <br />
-The above code creates an instance of the Ogre3d Render interface between Ogre3d and CEGUI.  You will not need to deal with this much after the above code has been run.  This creates the link which Ogre will use to render CEGUI.  Please note, you will want to call this if Ogre is auto-creating the render window ( pretty common ).  If you are manually creating the Ogre3d window, you will need to use the ''CEGUI::OgreRenderer::bootstrapSystem(Ogre::RenderWindow *)'' overload.
+The above code creates an instance of the Ogre3d Render interface between Ogre3d and CEGUI.  You will not need to deal with this much after the above code has been run.  This creates the link which Ogre will use to render CEGUI.  Please note, you will want to call this if Ogre is auto-creating the render window ( pretty common ).  If you are manually creating the Ogre3d window, you will need to use the ''CEGUI::OgreRenderer::bootstrapSystem(Ogre::RenderWindow)'' overload.
 An additional point to mention is that the bootstrapSystem() will create an instance of CEGUI::System.  This is important, as if you already have created CEGUI::System, an exception will be thrown.

@@ Line 1: / Line 1: @@
-{{VersionBadge|0.7}}
+{{VersionBadge|0.8}}
 {{Series|CEGUI In Practice|1}}
@@ Line 12: / Line 12: @@
 in this example.
-'''CEGUI::{{DoxygenClass|System|0.7}}''' - The big Kahuna.  This contains many of the functions for setting and getting defaults.  <br />
+'''CEGUI::{{DoxygenClass|System|0.8}}''' - The big Kahuna.  This contains many of the functions for setting and getting defaults.  <br />
-'''CEGUI::{{DoxygenClass|WindowManager|0.7}}''' - Manages the windows of CEGUI.  If a new window is going to be created or Deleted WindowManager is gonna be your class.<br />
+'''CEGUI::{{DoxygenClass|WindowManager|0.8}}''' - Manages the windows of CEGUI.  If a new window is going to be created or Deleted WindowManager is gonna be your class.<br />
-'''CEGUI::{{DoxygenClass|SchemeManager|0.7}}''' - Manages Schemes. <br />
+'''CEGUI::{{DoxygenClass|SchemeManager|0.8}}''' - Manages Schemes. <br />
-'''CEGUI::{{DoxygenClass|FontManager|0.7}}''' - Manages the different fonts you will use in your application. <br />
+'''CEGUI::{{DoxygenClass|FontManager|0.8}}''' - Manages the different fonts you will use in your application. <br />
 ==== Getting Started ====
@@ Line 28: / Line 28: @@
 C++=
 <source lang="cpp">
-#include "CEGUI.h"
+#include <CEGUI.h>
-#include "RendererModules/Ogre/CEGUIOgreRenderer.h"
+#include <RendererModules/Ogre/Renderer.h>
 </source>
 |-|
@@ Line 120: / Line 120: @@
 <source lang="cpp">
 // Load the scheme
-CEGUI::SchemeManager::getSingleton().create( "TaharezLook.scheme" );
+CEGUI::SchemeManager::getSingleton().createFromFile( "TaharezLook.scheme" );
 </source>
 |-|
@@ Line 126: / Line 126: @@
 <source lang="python">
 # Load the scheme
-PyCEGUI.SchemeManager.getSingleton().create( "TaharezLook.scheme" )
+PyCEGUI.SchemeManager.getSingleton().createFromFile( "TaharezLook.scheme" )
 </source>
 </tabber>
@@ Line 138: / Line 138: @@
 <source lang="cpp">
 // Set the defaults
-CEGUI::System::getSingleton().setDefaultFont( "DejaVuSans-10" );
+CEGUI::System::getSingleton().getDefaultGUIContext().setDefaultFont("DejaVuSans-10");
-CEGUI::System::getSingleton().setDefaultMouseCursor( "TaharezLook", "MouseArrow" );
+CEGUI::System::getSingleton().getDefaultGUIContext().getMouseCursor().setDefaultImage("TaharezLook/MouseArrow");
 </source>
 |-|
@@ Line 145: / Line 145: @@
 <source lang="python">
 # Set the defaults
-PyCEGUI.System.getSingleton().setDefaultFont( "DejaVuSans-10" )
+PyCEGUI.System.getSingleton().getDefaultGUIContext().setDefaultFont( "DejaVuSans-10" )
-PyCEGUI.System.getSingleton().setDefaultMouseCursor( "TaharezLook", "MouseArrow" )
+PyCEGUI.System.getSingleton().getDefaultGUIContext().getMouseCursor().setDefaultImage("TaharezLook/MouseArrow")
 </source>
 </tabber>
@@ Line 176: / Line 176: @@
 C++=
 <source lang="cpp">
-CEGUI::System::getSingleton().setGUISheet( myRoot );
+CEGUI::System::getSingleton().getDefaultGUIContext().setRootWindow( myRoot );
 </source>
 |-|
 Python=
 <source lang="python">
-PyCEGUI.System.getSingleton().setGUISheet( myRoot )
+PyCEGUI.System.getSingleton().getDefaultGUIContext().setRootWindow( myRoot )
 </source>
 </tabber>

@@ Line 116: / Line 116: @@
 Where we left off, CEGUI was just started. But in and of itself, it doesn't know what you want to do. First thing we should do is tell it what Scheme we want to use. As mentioned above, a .Scheme contains a listing of Widget and Other scripts to include, a Scheme can include an Imageset, lookNFeel, and font to use.
-<tabs>
+<tabber>
-<tab title="C++">
+C++=
 <source lang="cpp">
 // Load the scheme
 CEGUI::SchemeManager::getSingleton().create( "TaharezLook.scheme" );
 </source>
-</tab>
+|-|
-<tab title="Python">
+Python=
 <source lang="python">
 # Load the scheme
 PyCEGUI.SchemeManager.getSingleton().create( "TaharezLook.scheme" )
 </source>
-</tab>
+</tabber>
-</tabs>
 If you wanted to use an imageset or Font which is not designated in the .Scheme file its easy to do. Simply use the associated manager to load them. Since i'm trying my best to keep this as an introductory tutorial, I'll keep to the mission and explain these managers in a later tutorial.
@@ Line 135: / Line 134: @@
 Next up, lets define a few defaults:
-<tabs>
+<tabber>
-<tab title="C++">
+C++=
 <source lang="cpp">
 // Set the defaults
@@ Line 142: / Line 141: @@
 CEGUI::System::getSingleton().setDefaultMouseCursor( "TaharezLook", "MouseArrow" );
 </source>
-</tab>
+|-|
-<tab title="Python">
+Python=
 <source lang="python">
 # Set the defaults
@@ Line 149: / Line 148: @@
 PyCEGUI.System.getSingleton().setDefaultMouseCursor( "TaharezLook", "MouseArrow" )
 </source>
-</tab>
+</tabber>
-</tabs>
 These calls will summon the CEGUI::System from global scope and set the DefaultFont, and the default Mouse Cursor. If you reference TaharezLook.scheme (located in the cegui/datafiles/schemes folder). You will see that it loaded a font named DejaVuSans-10.font with the <font> tag in the .scheme. The MouseArrow is found inside the imageset called "TharezLook" under the tag of "MouseArrow". Pretty self explanetory I'd hope.
@@ Line 158: / Line 156: @@
 CEGUI uses a Parent/Child system for organizing the windows. So the first useful thing to do is create a parent which all other windows will be the child
-<tabs>
+<tabber>
-<tab title="C++">
+C++=
 <source lang="cpp">
 CEGUI::Window* myRoot = CEGUI::WindowManager::getSingleton().createWindow( "DefaultWindow", "_MasterRoot" );
 </source>
-</tab>
+|-|
-<tab title="Python">
+Python=
 <source lang="python">
 myRoot = PyCEGUI.WindowManager.getSingleton().createWindow( "DefaultWindow", "_MasterRoot" )
 </source>
-</tab>
+</tabber>
-</tabs>
@@ Line 176: / Line 173: @@
 Now that we have created the window, we need to set it as the root window.
-<tabs>
+<tabber>
-<tab title="C++">
+C++=
 <source lang="cpp">
 CEGUI::System::getSingleton().setGUISheet( myRoot );
 </source>
-</tab>
+|-|
-<tab title="Python">
+Python=
 <source lang="python">
 PyCEGUI.System.getSingleton().setGUISheet( myRoot )
 </source>
-</tab>
+</tabber>
-</tabs>
 This calls upon the system, and assigns myRoot as the default window. Recall myRoot was created above with the name "_MasterRoot".

@@ Line 41: / Line 41: @@
 ===== Bootstrapping CEGUI =====
-<tabs>
+<tabber>
-<tab title="C++">
+C++=
-<source lang="cpp">CEGUI::OgreRenderer* renderer = &CEGUI::OgreRenderer::bootstrapSystem();</source>
+<source lang="cpp">
-</tab>
+CEGUI::OgreRenderer* renderer = &CEGUI::OgreRenderer::bootstrapSystem();
-<tab title="Python">
+</source>
-<source lang="python">renderer = PyCEGUIOgreRenderer.OgreRenderer.bootstrapSystem()</source>
+|-|
-</tab>
+Python=
-</tabs>
+<source lang="python">
 [Note: This is a newer method using the bootstrapSystem, this was introduced in CEGUI 0.7.1.  There are examples on this wiki using older versions of CEGUI.  Please make note of which version you are using] <br />

@@ Line 25: / Line 25: @@
 ===== Including necessary headers =====
-<tabs>
+<tabber>
-<tab title="C++">
+C++=
 <source lang="cpp">
 #include "CEGUI.h"
 #include "RendererModules/Ogre/CEGUIOgreRenderer.h"
 </source>
-</tab>
+|-|
-<tab title="Python">
+Python=
 <source lang="python">
 import PyCEGUI
 import PyCEGUIOgreRenderer
 </source>
-</tab>
+</tabber>
-</tabs>
 ===== Bootstrapping CEGUI =====

@@ Line 112: / Line 112: @@
 Now that we have a minimal idea about what scripts CEGUI uses (and don't worry, they make more sense and are less intimidating as you proceede. You will likely use .layout the most in the beginning) lets start doing something useful!
-Where we left off, CEGUI was just started. But in and of itself, it doesn't know what you want to do. First thing we should do is tell it what Scheme we want to use. As mentioned above, a .Scheme contains a listing of Widget and Other scripts to include. a Scheem can include an Imageset, looknFeel, and font to use.
+Where we left off, CEGUI was just started. But in and of itself, it doesn't know what you want to do. First thing we should do is tell it what Scheme we want to use. As mentioned above, a .Scheme contains a listing of Widget and Other scripts to include, a Scheme can include an Imageset, lookNFeel, and font to use.
 <tabs>

@@ Line 73: / Line 73: @@
 </GUIScheme></source> <br />
-The next script we will mention is the '''Layouts''' (*.layout).  This is also an xml file, and will defines the layout (obviously!) of the window we want to display on the screen.  For example, if we wanted a to create a Chat window, we would probably have a ChatWindow.layout file somewhere. This would describe how the window looks (How big, where on the screen its displayed, etc), where the typing box would be located within this window, and where the button to 'send' the chat message would be.  Below is a quick example of what a .layout file looks like:
+The next script we will mention is the '''Layouts''' (*.layout).  This is also an xml file, which defines the layout (obviously!) of the window we want to display on the screen.  For example, if we wanted a to create a Chat window, we would probably have a ChatWindow.layout file somewhere. This would describe how the window looks (How big, where on the screen its displayed, etc), where the typing box would be located within this window, and where the button to 'send' the chat message would be.  Below is a quick example of what a .layout file looks like:
 <source lang="xml">
@@ Line 96: / Line 96: @@
 <Font Name="DejaVuSans-10" Filename="DejaVuSans.ttf" Type="FreeType" Size="10" NativeHorzRes="800" NativeVertRes="600" AutoScaled="true"/>
 </source>
 Another important script is the '''Imageset''' (*.imageset). This is the file which determines the visuals of each widget. In CEGUI the visual part of a widget which the user see's is a small X/Y coordinate on a larger texture file. For example, a basic Button will have the graphics defined in a .imageset to be a certain position on a texture image (*.png, *.bmp, *.jpg, etc) with a certain height and width. It may be located at Pixel 100x320 and be 50x50 in size. This will be defined in the imageset. Below is an example.

@@ Line 20: / Line 20: @@
 ==== Getting Started ====
-Lets jump in and get some stuff setup.  The first thing we need to do is get the system up and running.  Since I am an Ogre user, I will show the code to get the system up and running with ogre. There are methods of getting it started for numerous other Rendering systems.  Shown here [[The Beginner Guide to Getting CEGUI Rendering]]. <br />
+Let's jump in and get some stuff setup.  The first thing we need to do is get the system up and running.  Since I am an Ogre user, I will show the code to get the system up and running with ogre. There are methods of getting it started for numerous other Rendering systems.  Shown here [[The Beginner Guide to Getting CEGUI Rendering]]. <br />
 The Ogre3d Method is shown here:
@@ Line 55: / Line 55: @@
 The above code creates an instance of the Ogre3d Render interface between Ogre3d and CEGUI.  You will not need to deal with this much after the above code has been run.  This creates the link which Ogre will use to render CEGUI.  Please note, you will want to call this if Ogre is auto-creating the render window ( pretty common ).  If you are manually creating the Ogre3d window, you will need to use the ''CEGUI::OgreRenderer::bootstrapSystem(Ogre::RenderWindow *)'' overload.
-And additional point to mention, is that the bootstrapSystem() will create an instance of CEGUI::System.  This is important as if you already have created CEGUI::System, an exception will be thrown.
+An additional point to mention is that the bootstrapSystem() will create an instance of CEGUI::System.  This is important, as if you already have created CEGUI::System, an exception will be thrown.
 ==== Oh there will be scripts ====

@@ Line 47: / Line 47: @@
 </tab>
 <tab title="Python">
-<source lang="python">renderer = PyCEGUI.OgreRenderer.bootstrapSystem()</source>
+<source lang="python">renderer = PyCEGUIOgreRenderer.bootstrapSystem()</source>
 </tab>
 </tabs>
@@ Line 75: / Line 75: @@
 The next script we will mention is the '''Layouts''' (*.layout).  This is also an xml file, and will defines the layout (obviously!) of the window we want to display on the screen.  For example, if we wanted a to create a Chat window, we would probably have a ChatWindow.layout file somewhere. This would describe how the window looks (How big, where on the screen its displayed, etc), where the typing box would be located within this window, and where the button to 'send' the chat message would be.  Below is a quick example of what a .layout file looks like:
-<source lang="xml"><?xml version="1.0" encoding="UTF-8"?>
+<source lang="xml">
 <GUILayout >
      <Window Type="TaharezLook/FrameWindow" Name="ConsoleRoot" >
@@ Line 87: / Line 88: @@
              <Property Name="TextParsingEnabled" Value="False" />
          </Window>
-</GUILayout></source>
+</GUILayout>
 Another script which is useful to mention is a '''Font''' (*.font). This describes fonts which will be used in cegui. Below is an example:
@@ Line 103: / Line 106: @@
 	<Image Name="MouseArrow" XPos="138" YPos="127" Width="31" Height="25" XOffset="0" YOffset="0" />
 </Imageset>
- </source>
+</source>
 Lastly, '''LookNFeel''' (*.looknfeel). This is a fairly evil looking file, and to save everyone from nightmarish horrors, I will not post an example (and to save space). This is the file which determines how every widget (CEGUI speak for window/object/item) looks and acts. For example, what it looks like when you mouse over a button, or how to build the border and background of a Window. Each scheme will generally have its own LookNFeel to allow more customization of the basic construction of CEGUI Widgets.