CEGUI In Practice - User Data - Revision history

Superpws at 08:25, 30 March 2014

2014-03-30T08:25:45Z

Capek: Robot: Cosmetic changes

2011-03-13T12:38:06Z

Robot: Cosmetic changes

Avengre: moved CEGUI In Practice7 to CEGUI In Practice - User Data

2011-03-07T18:54:06Z

moved CEGUI In Practice7 to CEGUI In Practice - User Data

Avengre at 18:53, 7 March 2011

2011-03-07T18:53:32Z

Avengre at 18:52, 7 March 2011

2011-03-07T18:52:59Z

Capek: Robot: Cosmetic changes

2011-03-07T12:39:51Z

Robot: Cosmetic changes

Avengre: Created page with "== CEGUI InPractice 7 == This tutorial will be a short tutorial, as i will show how to do a small addon to the previous tutorial CEGUI_In_Practice_-_A_Game_Console showing y..."

2011-03-06T15:36:42Z

Created page with "== CEGUI InPractice 7 == This tutorial will be a short tutorial, as i will show how to do a small addon to the previous tutorial CEGUI_In_Practice_-_A_Game_Console showing y..."

New page

== CEGUI InPractice 7 ==

This tutorial will be a short tutorial, as i will show how to do a small addon to the previous tutorial [[CEGUI_In_Practice_-_A_Game_Console]] showing you how to associate the ConsoleRoot with our GameConsoleWindow class. While not terribly useful in this situation, it can demonstrate a useful feature that you likely will use in your own game.

@@ Line 1: / Line 1: @@
-{{VersionBadge|0.7}}
+{{VersionBadge|0.8}}
 {{Series|CEGUI In Practice|7}}
@@ Line 20: / Line 20: @@
 ...
-             CEGUI::System::getSingleton().getGUISheet()->addChildWindow(m_ConsoleWindow);
+             CEGUI::System::getSingleton().getDefaultGUIContext().getRootWindow()->addChild(m_ConsoleWindow);
              (this)->RegisterHandlers();
              m_ConsoleWindow->setUserData(this);    // <------ Add this line

@@ Line 10: / Line 10: @@
 ==== UserData ====
-User data in CEGUI is basically a void pointer.  This allows you to assign a custom structure or variable to each cegui window.  This is extremely useful as it allows you to greater incorporate CEGUI into your development.  For the previous example we created a Class to encompass our Console window which was great as it allowed us to easily encapsulate all the CEGUI windows and their handlers into a neat and easy to use function.  It was pretty easy to go from GameConsoleWindow to each of the classes (by accessing the m_ConsoleWindow in the class and getChild() method).  However, its not so easy to from the CEGUI::Window back up to the class level without recompiling CEGUI and creating custom widgets, unless you use userData.
+User data in CEGUI is basically a void pointer. This allows you to assign a custom structure or variable to each cegui window. This is extremely useful as it allows you to greater incorporate CEGUI into your development. For the previous example we created a Class to encompass our Console window which was great as it allowed us to easily encapsulate all the CEGUI windows and their handlers into a neat and easy to use function. It was pretty easy to go from GameConsoleWindow to each of the classes (by accessing the m_ConsoleWindow in the class and getChild() method). However, its not so easy to from the CEGUI::Window back up to the class level without recompiling CEGUI and creating custom widgets, unless you use userData.
-Its almost so easy to use that its a waste of wiki space to show this, but regardless I see alot of posts about it on the IRC channel.  Here is a line we would add to our CreateCEGUIWindow(); function.
+Its almost so easy to use that its a waste of wiki space to show this, but regardless I see alot of posts about it on the IRC channel. Here is a line we would add to our CreateCEGUIWindow(); function.
 <source lang="cpp">
@@ Line 27: / Line 27: @@
 </source>
-That adds a pointer to the class we're currently in, which is an instance of GameConsoleWindow.  Note tho, it stores this as a void* so when we go back to this pointer later, it will not know what type of data this is, so you will need to cast it back:
+That adds a pointer to the class we're currently in, which is an instance of GameConsoleWindow. Note tho, it stores this as a void* so when we go back to this pointer later, it will not know what type of data this is, so you will need to cast it back:
 <source lang="cpp">
@@ Line 35: / Line 35: @@
 </source>
-This will convert the void* we stored above, into the ConsoleClass pointer.  You could probably use dynamic_cast but then you'd need to turn on RTT, which is not always required for performance reasons.  Regardless you can see how easily this is done.  We will use this in a later tutorial demonstrating how to implement an inventory system.
+This will convert the void* we stored above, into the ConsoleClass pointer. You could probably use dynamic_cast but then you'd need to turn on RTT, which is not always required for performance reasons. Regardless you can see how easily this is done. We will use this in a later tutorial demonstrating how to implement an inventory system.
 Until next time..
 [[Category:Tutorials]]

← Older revision		Revision as of 18:53, 7 March 2011
Line 1:		Line 1:
		+	{{VersionBadge\|0.7}}
		+	{{Series\|CEGUI In Practice\|7}}
		+
		+
	== CEGUI InPractice 7 ==		== CEGUI InPractice 7 ==

Line 34:		Line 38:

	Until next time..		Until next time..
		+
		+
		+	[[Category:Tutorials]]

← Older revision		Revision as of 18:52, 7 March 2011
Line 2:		Line 2:

	This tutorial will be a short tutorial, as i will show how to do a small addon to the previous tutorial [[CEGUI In Practice - A Game Console]] showing you how to associate the ConsoleRoot with our GameConsoleWindow class. While not terribly useful in this situation, it can demonstrate a useful feature that you likely will use in your own game.		This tutorial will be a short tutorial, as i will show how to do a small addon to the previous tutorial [[CEGUI In Practice - A Game Console]] showing you how to associate the ConsoleRoot with our GameConsoleWindow class. While not terribly useful in this situation, it can demonstrate a useful feature that you likely will use in your own game.
		+
		+
		+	==== UserData ====
		+
		+	User data in CEGUI is basically a void pointer. This allows you to assign a custom structure or variable to each cegui window. This is extremely useful as it allows you to greater incorporate CEGUI into your development. For the previous example we created a Class to encompass our Console window which was great as it allowed us to easily encapsulate all the CEGUI windows and their handlers into a neat and easy to use function. It was pretty easy to go from GameConsoleWindow to each of the classes (by accessing the m_ConsoleWindow in the class and getChild() method). However, its not so easy to from the CEGUI::Window back up to the class level without recompiling CEGUI and creating custom widgets, unless you use userData.
		+
		+	Its almost so easy to use that its a waste of wiki space to show this, but regardless I see alot of posts about it on the IRC channel. Here is a line we would add to our CreateCEGUIWindow(); function.
		+
		+	<source lang="cpp">
		+	void GameConsoleWindow::CreateCEGUIWindow()
		+	{
		+
		+	...
		+
		+	CEGUI::System::getSingleton().getGUISheet()->addChildWindow(m_ConsoleWindow);
		+	(this)->RegisterHandlers();
		+	m_ConsoleWindow->setUserData(this); // <------ Add this line
		+	...
		+	}
		+	</source>
		+
		+	That adds a pointer to the class we're currently in, which is an instance of GameConsoleWindow. Note tho, it stores this as a void* so when we go back to this pointer later, it will not know what type of data this is, so you will need to cast it back:
		+
		+	<source lang="cpp">
		+	GameConsoleWindow *ConsoleClass = NULL;
		+
		+	ConsoleClass = static_cast<GameConsoleWindow*>(m_ConsoleWindow->getUserData());
		+	</source>
		+
		+	This will convert the void* we stored above, into the ConsoleClass pointer. You could probably use dynamic_cast but then you'd need to turn on RTT, which is not always required for performance reasons. Regardless you can see how easily this is done. We will use this in a later tutorial demonstrating how to implement an inventory system.
		+
		+	Until next time..

← Older revision		Revision as of 12:39, 7 March 2011
Line 1:		Line 1:
	== CEGUI InPractice 7 ==		== CEGUI InPractice 7 ==

−	This tutorial will be a short tutorial, as i will show how to do a small addon to the previous tutorial [[~~CEGUI_In_Practice_~~-~~_A_Game_Console~~]] showing you how to associate the ConsoleRoot with our GameConsoleWindow class. While not terribly useful in this situation, it can demonstrate a useful feature that you likely will use in your own game.	+	This tutorial will be a short tutorial, as i will show how to do a small addon to the previous tutorial [[CEGUI In Practice - A Game Console]] showing you how to associate the ConsoleRoot with our GameConsoleWindow class. While not terribly useful in this situation, it can demonstrate a useful feature that you likely will use in your own game.

← Older revision	Revision as of 18:54, 7 March 2011
(No difference)