The Main Menu - Revision history

Kulik at 01:39, 6 March 2011

2011-03-06T01:39:14Z

Capek: because references rule

2011-03-06T01:38:23Z

because references rule

Kulik at 16:26, 4 March 2011

2011-03-04T16:26:24Z

Kulik at 16:17, 4 March 2011

2011-03-04T16:17:35Z

Capek: Experiment to make the wiki more interlinked

2011-03-03T23:16:52Z

Experiment to make the wiki more interlinked

Capek: make CEGUI's name consistent across the wiki

2011-03-03T23:07:03Z

make CEGUI's name consistent across the wiki

Capek: Lets use instead of , it is much less typo-prone

2011-02-28T11:23:05Z

Lets use <source> instead of <syntaxhighlight>, it is much less typo-prone

Show changes

Capek: Bot: Automated text replacement (-`[:space:]?(.*?)` +\1)

2011-02-27T12:48:49Z

Bot: Automated text replacement (-<code>[:space:]?<cpp/>(.*?)</code> +<syntaxhighlight lang="cpp">\1</syntaxhighlight>)

Show changes

Capek: Robot: Adding Category:Uncategorised

2011-02-26T16:56:58Z

Robot: Adding Category:Uncategorised

BayerMeister: tag was missing

2008-03-06T10:00:17Z

</code> tag was missing

← Older revision		Revision as of 01:39, 6 March 2011
Line 572:		Line 572:

	[[Category:Tutorials]]		[[Category:Tutorials]]
		+	[[Category:Update requested]]

@@ Line 18: / Line 18: @@
 <source lang="cpp">
 // Initialisation Area
-CEGUI::OgreCEGUIRenderer* mGUIRenderer = new CEGUI::OgreCEGUIRenderer(Root::getSingletonPtr()->getAutoCreatedWindow(), Ogre::RENDER_QUEUE_OVERLAY, false, 3000);
+CEGUI::OgreCEGUIRenderer* mGUIRenderer = new CEGUI::OgreCEGUIRenderer(Root::getSingleton().getAutoCreatedWindow(), Ogre::RENDER_QUEUE_OVERLAY, false, 3000);
 CEGUI::System* mGUISystem = new CEGUI::System(mGUIRenderer);
 CEGUI::Logger::getSingleton().setLoggingLevel(CEGUI::Informative); // this is recommended to help with debugging, but not neccessary
@@ Line 117: / Line 117: @@
 Note that you could easily create a full image from a texture using the line below, the auto-created image will be called "full_image"
 <source lang="cpp">
-Imageset* foo = ImagesetManager::getSingletonPtr()->createImagesetFromImageFile("NameOfImageset", "Image.jpg");
+Imageset* foo = ImagesetManager::getSingleton().createImagesetFromImageFile("NameOfImageset", "Image.jpg");
 </source>
 But if you want to split it up it'll be alittle harder. You'll need to define a texture
 <source lang="cpp">
-Texture* texturePtr = System::getSingletonPtr()->getRenderer()->createTexture("ImageFile.jpg", "");
+Texture* texturePtr = System::getSingleton().getRenderer()->createTexture("ImageFile.jpg", "");
-Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImageset("ImageName", texturePtr);
+Imageset* MenuImageset = ImagesetManager::getSingleton().createImageset("ImageName", texturePtr);
 </source>
@@ Line 136: / Line 136: @@
 <source lang="cpp">
-Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImagesetFromImageFile("Background","MenuBackground.jpg");
+Imageset* MenuImageset = ImagesetManager::getSingleton().createImagesetFromImageFile("Background","MenuBackground.jpg");
-Texture* texturePtr = System::getSingletonPtr()->getRenderer()->createTexture("MenuButtons.jpg", "");
+Texture* texturePtr = System::getSingleton().getRenderer()->createTexture("MenuButtons.jpg", "");
-Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImageset("Buttons", texturePtr);
+Imageset* MenuImageset = ImagesetManager::getSingleton().createImageset("Buttons", texturePtr);
 </source>
@@ Line 164: / Line 164: @@
 // Creating Imagesets and defining images
-Imageset* MenuImageset = ImagesetManager::getSingletonPtr()->createImagesetFromImageFile("Background","MenuBackground.jpg");
+Imageset* MenuImageset = ImagesetManager::getSingleton().createImagesetFromImageFile("Background","MenuBackground.jpg");
-Texture* texturePtr = System::getSingletonPtr()->getRenderer()->createTexture("MenuButtons.jpg", ""); // default resource group
+Texture* texturePtr = System::getSingleton().getRenderer()->createTexture("MenuButtons.jpg", ""); // default resource group
-Imageset* ButtonsImageset = ImagesetManager::getSingletonPtr()->createImageset("Buttons", texturePtr);
+Imageset* ButtonsImageset = ImagesetManager::getSingleton().createImageset("Buttons", texturePtr);
 ButtonsImageset->defineImage("ButtonUp", Point(0.0f,0.0f), Size( 0.5f, 0.5f ), Point(0.0f,0.0f));
 ButtonsImageset->defineImage("ButtonDown", Point(0.0f,0.5f), Size( 0.5f, 0.5f ), Point(0.0f,0.0f));
@@ Line 280: / Line 280: @@
 While the ResourceGroup="" line isn't necessary, I just added it so you can see where to use it.
 To load Imagesets by code you do
-  ImagesetManager::getSingletonPtr()->createImageset( "MenuBackground.imageset");
+  ImagesetManager::getSingleton().createImageset( "MenuBackground.imageset");
 ===== Layouts =====
@@ Line 328: / Line 328: @@
 To load a .layout file in code you do
 <source lang="cpp">
-  Window* Menu = WindowManager::getSingletonPtr()->loadWindowLayout("Menu.layout");
+  Window* Menu = WindowManager::getSingleton().loadWindowLayout("Menu.layout");
 </source>
@@ Line 337: / Line 337: @@
 try
+{
-	Window* Menu = WindowManager::getSingletonPtr()->loadWindowLayout("Menu.layout");
+	Window* Menu = WindowManager::getSingleton().loadWindowLayout("Menu.layout");
+}
 catch(CEGUI::Exception &e)
@@ Line 377: / Line 377: @@
 SchemeManager::getSingleton().loadScheme("GameGUI.scheme);
 // Or you could do this if you skip the scheme part
-//ImagesetManager::getSingletonPtr()->createImageset( "MenuBackground.imageset");
+//ImagesetManager::getSingleton().createImageset( "MenuBackground.imageset");
-//ImagesetManager::getSingletonPtr()->createImageset( "MenuButtons.imageset");
+//ImagesetManager::getSingleton().createImageset( "MenuButtons.imageset");
 </source>
@@ Line 559: / Line 559: @@
+{
      // your engine specific code to shut down
-     Root::getSingletonPtr()->queueEndRendering(); // ogre specific
+     Root::getSingleton().queueEndRendering(); // ogre specific
      return true;
+}

@@ Line 224: / Line 224: @@
 A code line is usually encapsulated in < >. To start a declare a new type you can use <Type/> or <Type> </Type>. The first way should be used to declare objects that don't have too many settings. e.g:
   <Image Name="Background" XPos="0.0" YPos="0.0" Width="800" Height="600" />
 As you've probably noticed, you can set its settings in the same line. As for the second way, it should be used to open up bigger types. e.g:
   <Window Type="TaharezLook/Button" Name="NewGame">
       <Property Name="UnifiedAreaRect" Value="{{0.2,0.0},{0.45,0.0},{0.6,0.0},{0.65,0.0}}" />
   </Window>
 You can start nesting types in other types, you should be able to pickup the rest of the basics from xml files included with CEGUI and the ones in this tutorial.
@@ Line 256: / Line 260: @@
 * MenuBackground.imageset
   <?xml version="1.0" ?>
   <Imageset Name="Background" Imagefile="MenuBackground.jpg" NativeHorzRes="800" NativeVertRes="600" AutoScaled="true" ResourceGroup="General">
   	<Image Name="Background" XPos="0.0" YPos="0.0" Width="512" Height="512" />
   </Imageset>
 * MenuButtons.imageset
    <?xml version="1.0" ?>
    <Imageset Name="Buttons" Imagefile="MenuButtons.jpg" NativeHorzRes="800" NativeVertRes="600" AutoScaled="true">
@@ Line 268: / Line 276: @@
   	<Image Name="ButtonHighlighted" XPos="0.0" YPos="384.14" Width="512" Height="128" />
   </Imageset>
 While the ResourceGroup="" line isn't necessary, I just added it so you can see where to use it.
@@ Line 278: / Line 287: @@
 * Menu.layout
   <?xml version="1.0" ?>
   <GUILayout>
@@ Line 312: / Line 322: @@
       </Window>
   </GUILayout>
 This does basicly all the stuff we did in the code portion of the tutorial. The only new term here is UnifiedAreaRect, the first pair defines where the XPos starts, the 3rd defines where it ends. Same goes for 2nd & 4th but for YPos
 To load a .layout file in code you do
   Window* Menu = WindowManager::getSingletonPtr()->loadWindowLayout("Menu.layout");
 *Note 1: There is an editor file for layouts written by scriptkid, its preferable if you get it from CVS and build it, but its possible to get the binaries from the downloads area in the cegui website. While its rather limited atm, it allows you to create and place the various widgets and export into a .layout file. It doesn't support custom images as of yet (8/12/2005).
@@ Line 343: / Line 356: @@
 * GameGUI.scheme
   <?xml version="1.0" ?>
   <GUIScheme Name="GameGUI">
@@ Line 348: / Line 362: @@
   	<Imageset Name="Buttons" Filename="MenuButtons.imageset"/>
   </GUIScheme>
 This simply just loads the 2 imagesets. To load the scheme by code you use

@@ Line 1: / Line 1: @@
 So, you've probably read all the Beginner Guide to X tutorials (if not then go back and read them !), your sitting there still feeling lost, and you can't find exactly how to bring all the stuff you've read together to make a simple GUI. I too found it specially hard to wrap everything together when starting out and hopefully this article should help address this problem for others, I'm still a beginner so there might be a few errors, but for the most part the code has been tested. This tutorial will be rather Ogre oriented since thats what I use, I'll try to keep things a little generic though.
@@ Line 554: / Line 556: @@
 If you find that something isn't clear or you want help with it you can post on the forums or join the #cegui channel on IRC (freenode server). I usually idle on IRC often, nick MandM.
-[[Category:Uncategorised]]
+[[Category:Tutorials]]

@@ Line 338: / Line 338: @@
 A 'Window Set' basically specifies the name of a loadable module or skin(.dll , .so, .looknfeel), and a set of widgets contained within that modules that you wish to register with the system. A 'Window Alias' provides a means to refer to a window / widget type by alternative names, it can also be used to 'hide' an already registered widget type with another widget type (so that other widget type gets used instead).
-This file isn't totally needed in the current approach, we're just using it here as a means of grouping imagesets for loading. However this file will be used in greater detail in the Falagard system.
+This file isn't totally needed in the current approach, we're just using it here as a means of grouping imagesets for loading. However this file will be used in greater detail in the [[Falagard]] system.
 * GameGUI.scheme
@@ Line 386: / Line 386: @@
-=== Falagard Way & the looknfeel system ===
+=== [[Falagard]] Way & the looknfeel system ===
 TO DO

@@ Line 433: / Line 433: @@
 <source lang="cpp">
 // Helper function
-ConvertOgreButtonToCegui(int ButtonID);
+ConvertOgreButtonToCEGUI(int ButtonID);
 //key listener
@@ Line 455: / Line 455: @@
 here is thier implementations
 <source lang="cpp">
-MouseButton YourInputListenerClass::ConvertOgreButtonToCegui(int ButtonID)
+MouseButton YourInputListenerClass::ConvertOgreButtonToCEGUI(int ButtonID)
+{
     switch (ButtonID)
@@ Line 489: / Line 489: @@
 void YourInputListenerClass::mousePressed (MouseEvent *e)
+{
-	mGUISystem->injectMouseButtonDown(ConvertOgreButtonToCegui(e->getButtonID()));
+	mGUISystem->injectMouseButtonDown(ConvertOgreButtonToCEGUI(e->getButtonID()));
 	e->consume();
+}
 void YourInputListenerClass::mouseReleased(MouseEvent *e)
+{
-  	mGUISystem->injectMouseButtonUp(ConvertOgreButtonToCegui(e->getButtonID()));
+  	mGUISystem->injectMouseButtonUp(ConvertOgreButtonToCEGUI(e->getButtonID()));
   	e->consume();
+}

← Older revision		Revision as of 16:56, 26 February 2011
Line 553:		Line 553:
	Now it should be easy to and clear to beginner users how to begin making use of CEGUI, you can easily extend what you've learnt here to start making more complex GUIs.		Now it should be easy to and clear to beginner users how to begin making use of CEGUI, you can easily extend what you've learnt here to start making more complex GUIs.
	If you find that something isn't clear or you want help with it you can post on the forums or join the #cegui channel on IRC (freenode server). I usually idle on IRC often, nick MandM.		If you find that something isn't clear or you want help with it you can post on the forums or join the #cegui channel on IRC (freenode server). I usually idle on IRC often, nick MandM.
		+
		+	[[Category:Uncategorised]]

@@ Line 501: / Line 501: @@
 	mouseMoved(e);
+}
 === Handling events for the layout approach ===