CEGUI In Practice - Managing input - Revision history

Thomas: /* On ward! */

2014-04-12T02:46:52Z

‎On ward!

Superpws at 08:03, 30 March 2014

2014-03-30T08:03:15Z

Ident: fixed warnings and removed something unnecessary that would make newer OIS code break with this

2011-05-08T08:46:02Z

fixed warnings and removed something unnecessary that would make newer OIS code break with this

Avengre at 17:33, 24 March 2011

2011-03-24T17:33:03Z

Capek: because references rule

2011-03-06T01:37:22Z

because references rule

Kulik: moved CEGUI InPractice 3 to CEGUI In Practice - Managing input

2011-03-02T17:18:02Z

moved CEGUI InPractice 3 to CEGUI In Practice - Managing input

Kulik at 23:55, 1 March 2011

2011-03-01T23:55:34Z

Capek: Robot: Cosmetic changes

2011-02-28T20:43:40Z

Robot: Cosmetic changes

Avengre at 19:18, 28 February 2011

2011-02-28T19:18:12Z

Avengre at 19:17, 28 February 2011

2011-02-28T19:17:54Z

@@ Line 43: / Line 43: @@
 The following will input keypresses when typing. It injects the key down and up actions (By key code) and the characters that associate with those keypresses.
 <source lang="cpp">
@@ Line 49: / Line 51: @@
 	if (bButtonDown)
+	{
-		CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyDown(inKey.key);
+		CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyDown((CEGUI::Key::Scan)inKey.key);
 		CEGUI::System::getSingleton().getDefaultGUIContext().injectChar(inKey.text);
+	}
 	else
+	{
-		CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyUp(inKey.key);
+		CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyUp((CEGUI::Key::Scan)inKey.key);
+	}
+}
@@ Line 115: / Line 117: @@
 This above function will Convert a OIS Input for the mouse and change it to CEGUI. Right now the codes match, but if they ever change it will provide an example of how to use OIS with CEGUI.
 ==== Conclusion ====

@@ Line 1: / Line 1: @@
-{{VersionBadge|0.7}}
+{{VersionBadge|0.8}}
 {{Series|CEGUI In Practice|3}}
@@ Line 13: / Line 13: @@
 <source lang="cpp">
-CEGUI::System::injectKeyDown(uint key_code); // Tells CEGUI Key has been Pressed
+CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyDown(uint key_code); // Tells CEGUI Key has been Pressed
-CEGUI::System::injectKeyUp(uint key_code); // Tells CEGUI Key has been Released
+CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyUp(uint key_code); // Tells CEGUI Key has been Released
-CEGUI::System::injectChar(utf32 code_point);
+CEGUI::System::getSingleton().getDefaultGUIContext().injectChar(utf32 code_point);
 </source>
@@ Line 22: / Line 22: @@
 Handling the mouse works in a similiar method as above. The following code shows how you would inform CEGUI about a Left Mouse Button Keypress.
-<source lang="cpp">CEGUI::System::injectMouseButtonDown(CEGUI::MouseButton::LeftButton);</source>
+<source lang="cpp">CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonDown(CEGUI::MouseButton::LeftButton);</source>
 As you can imagine, there is a injectMouseButtonUp() as well for letting CEGUI know when the mouse is released.
@@ Line 28: / Line 28: @@
 And what about when the mouse itself moves? Of course thats covered
-<source lang="cpp">CEGUI::System::injectMouseMove(float delta_x, float delta_y);</source>
+<source lang="cpp">CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseMove(float delta_x, float delta_y);</source>
 The delta is in Screen pixels that the mouse moved since the last CEGUI Update.
@@ Line 34: / Line 34: @@
 Up until know, we haven't actually given CEGUI any processor time. If we're going to be moving a mouse, or clicking buttons, we're going to want CEGUI to display these actions. So we need to let CEGUI know how much time has passed since its last render.
-<source lang="cpp">CEGUI::System::injectTimePulse(float timeElapsed);</source>
+<source lang="cpp">CEGUI::System::getSingleton().injectTimePulse(float timeElapsed);</source>
 This allows you to inject a time pulse, based on the number of Seconds that have passed. However often you update CEGUI is up to you, but most games will want to update the GUI by injectingTime pulses during every update cycle. If you're building more of a Tool Application you might not need constant updates.
@@ Line 49: / Line 49: @@
 	if (bButtonDown)
+	{
-		CEGUI::System::getSingleton().injectKeyDown(inKey.key);
+		CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyDown(inKey.key);
-		CEGUI::System::getSingleton().injectChar(inKey.text);
+		CEGUI::System::getSingleton().getDefaultGUIContext().injectChar(inKey.text);
+	}
 	else
+	{
-		CEGUI::System::getSingleton().injectKeyUp(inKey.key);
+		CEGUI::System::getSingleton().getDefaultGUIContext().injectKeyUp(inKey.key);
+	}
+}
@@ Line 68: / Line 68: @@
+		{
 		case OIS::MB_Left:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::LeftButton);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonDown(CEGUI::LeftButton);
 			break;
 		case OIS::MB_Middle:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MiddleButton);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonDown(CEGUI::MiddleButton);
 			break;
 		case OIS::MB_Right:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::RightButton);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonDown(CEGUI::RightButton);
 			break;
 		case OIS::MB_Button3:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::X1Button);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonDown(CEGUI::X1Button);
 			break;
 		case OIS::MB_Button4:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::X2Button);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonDown(CEGUI::X2Button);
 			break;
 		default:
@@ Line 92: / Line 92: @@
+		{
 		case OIS::MB_Left:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::LeftButton);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonUp(CEGUI::LeftButton);
 			break;
 		case OIS::MB_Middle:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MiddleButton);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonUp(CEGUI::MiddleButton);
 			break;
 		case OIS::MB_Right:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::RightButton);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonUp(CEGUI::RightButton);
 			break;
 		case OIS::MB_Button3:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::X1Button);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonUp(CEGUI::X1Button);
 			break;
 		case OIS::MB_Button4:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::X2Button);
+			CEGUI::System::getSingleton().getDefaultGUIContext().injectMouseButtonUp(CEGUI::X2Button);
 			break;
 		default:

@@ Line 68: / Line 68: @@
+		{
 		case OIS::MB_Left:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::LeftButton);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::LeftButton);
 			break;
 		case OIS::MB_Middle:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::MiddleButton);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MiddleButton);
 			break;
 		case OIS::MB_Right:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::RightButton);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::RightButton);
 			break;
 		case OIS::MB_Button3:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::X1Button);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::X1Button);
 			break;
 		case OIS::MB_Button4:
-			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::X2Button);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::X2Button);
 			break;
-		case OIS::MB_NULL:
+		default:
 			break;
@@ Line 92: / Line 92: @@
+		{
 		case OIS::MB_Left:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::LeftButton);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::LeftButton);
 			break;
 		case OIS::MB_Middle:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::MiddleButton);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MiddleButton);
 			break;
 		case OIS::MB_Right:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::RightButton);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::RightButton);
 			break;
 		case OIS::MB_Button3:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::X1Button);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::X1Button);
 			break;
 		case OIS::MB_Button4:
-			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::X2Button);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::X2Button);
 			break;
-		case OIS::MB_NULL:
+		default:
 			break;
+		}

@@ Line 74: / Line 74: @@
 			break;
 		case OIS::MB_Right:
-			mSystem->injectMouseButtonDown(CEGUI::MouseButton::RightButton);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::RightButton);
 			break;
 		case OIS::MB_Button3:

@@ Line 49: / Line 49: @@
 	if (bButtonDown)
+	{
-		CEGUI::System::getSingletonPtr()->injectKeyDown(inKey.key);
+		CEGUI::System::getSingleton().injectKeyDown(inKey.key);
-		CEGUI::System::getSingletonPtr()->injectChar(inKey.text);
+		CEGUI::System::getSingleton().injectChar(inKey.text);
+	}
 	else
+	{
-		CEGUI::System::getSingletonPtr()->injectKeyUp(inKey.key);
+		CEGUI::System::getSingleton().injectKeyUp(inKey.key);
+	}
+}
@@ Line 68: / Line 68: @@
+		{
 		case OIS::MB_Left:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::LeftButton);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::LeftButton);
 			break;
 		case OIS::MB_Middle:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::MiddleButton);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::MiddleButton);
 			break;
 		case OIS::MB_Right:
@@ Line 77: / Line 77: @@
 			break;
 		case OIS::MB_Button3:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::X1Button);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::X1Button);
 			break;
 		case OIS::MB_Button4:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::X2Button);
+			CEGUI::System::getSingleton().injectMouseButtonDown(CEGUI::MouseButton::X2Button);
 			break;
 		case OIS::MB_NULL:
@@ Line 92: / Line 92: @@
+		{
 		case OIS::MB_Left:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::LeftButton);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::LeftButton);
 			break;
 		case OIS::MB_Middle:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::MiddleButton);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::MiddleButton);
 			break;
 		case OIS::MB_Right:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::RightButton);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::RightButton);
 			break;
 		case OIS::MB_Button3:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::X1Button);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::X1Button);
 			break;
 		case OIS::MB_Button4:
-			CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::X2Button);
+			CEGUI::System::getSingleton().injectMouseButtonUp(CEGUI::MouseButton::X2Button);
 			break;
 		case OIS::MB_NULL:

← Older revision	Revision as of 17:18, 2 March 2011
(No difference)

← Older revision		Revision as of 23:55, 1 March 2011
Line 1:		Line 1:
	{{VersionBadge\|0.7}}		{{VersionBadge\|0.7}}
		+	{{Series\|CEGUI In Practice\|3}}

	== CEGUI In-Practice ==		== CEGUI In-Practice ==

← Older revision		Revision as of 19:18, 28 February 2011
Line 119:		Line 119:

	Understandably this section is a little quicker. But it gives you information about how to start interacting with CEGUI. The next tutorial will teach us how to actually deal with keypresses and make interesting things happen. Until then!		Understandably this section is a little quicker. But it gives you information about how to start interacting with CEGUI. The next tutorial will teach us how to actually deal with keypresses and make interesting things happen. Until then!
		+
		+
		+	[[Category:Tutorials]]

← Older revision		Revision as of 19:17, 28 February 2011
Line 6:		Line 6:

	CEGUI Has been designed to work on many systems, using many different renderers. As such it is tied to no particular input system. Unfortunately for us to demonstrate how to interact with CEGUI, we need to pick one and USE it don't we? So I have decided to use OIS [http://sourceforge.net/projects/wgois/]. Although I will attempt to keep OIS Specific functions and structures seperate, if they slip in, there is the reference to the system I'm using.		CEGUI Has been designed to work on many systems, using many different renderers. As such it is tied to no particular input system. Unfortunately for us to demonstrate how to interact with CEGUI, we need to pick one and USE it don't we? So I have decided to use OIS [http://sourceforge.net/projects/wgois/]. Although I will attempt to keep OIS Specific functions and structures seperate, if they slip in, there is the reference to the system I'm using.
		+
		+	==== Input Injection ====
		+
		+	The first thing to note, is that not surprisingly CEGUI has made it easy to deal with inputing user actions into CEGUI. Whenever an action happens (User typing, hitting Escape, clicking a button) CEGUI will need to be informed about it.
		+
		+	<source lang="cpp">
		+	CEGUI::System::injectKeyDown(uint key_code); // Tells CEGUI Key has been Pressed
		+	CEGUI::System::injectKeyUp(uint key_code); // Tells CEGUI Key has been Released
		+
		+	CEGUI::System::injectChar(utf32 code_point);
		+	</source>
		+
		+	The Inject keydown/up are good for sending Shift, controls, enters, etc. While the injectChar is pretty self explanatory for what it means, it injects a 'letter'.
		+
		+	Handling the mouse works in a similiar method as above. The following code shows how you would inform CEGUI about a Left Mouse Button Keypress.
		+	<source lang="cpp">CEGUI::System::injectMouseButtonDown(CEGUI::MouseButton::LeftButton);</source>
		+
		+	As you can imagine, there is a injectMouseButtonUp() as well for letting CEGUI know when the mouse is released.
		+
		+	And what about when the mouse itself moves? Of course thats covered
		+
		+	<source lang="cpp">CEGUI::System::injectMouseMove(float delta_x, float delta_y);</source>
		+
		+	The delta is in Screen pixels that the mouse moved since the last CEGUI Update.
		+
		+	Up until know, we haven't actually given CEGUI any processor time. If we're going to be moving a mouse, or clicking buttons, we're going to want CEGUI to display these actions. So we need to let CEGUI know how much time has passed since its last render.
		+
		+	<source lang="cpp">CEGUI::System::injectTimePulse(float timeElapsed);</source>
		+
		+	This allows you to inject a time pulse, based on the number of Seconds that have passed. However often you update CEGUI is up to you, but most games will want to update the GUI by injectingTime pulses during every update cycle. If you're building more of a Tool Application you might not need constant updates.
		+
		+	==== On ward! ====
		+
		+	I'm going to assume that you are using OIS and are knowledgable about its uses. Here are two functions which will allow you to interact with CEGUI
		+
		+	The following will input keypresses when typing. It injects the key down and up actions (By key code) and the characters that associate with those keypresses.
		+
		+	<source lang="cpp">
		+	void InjectOISKey(bool bButtonDown, OIS::KeyEvent inKey)
		+	{
		+	if (bButtonDown)
		+	{
		+	CEGUI::System::getSingletonPtr()->injectKeyDown(inKey.key);
		+	CEGUI::System::getSingletonPtr()->injectChar(inKey.text);
		+	}
		+	else
		+	{
		+	CEGUI::System::getSingletonPtr()->injectKeyUp(inKey.key);
		+	}
		+	}
		+	</source>
		+
		+	The following function will handle injection of OIS Mouse Button presses and releases
		+	<source lang="cpp">
		+	void InjectOISMouseButton(bool bButtonDown, OIS::MouseButtonID inButton)
		+	{
		+	if (bButtonDown == true)
		+	{
		+	switch (inButton)
		+	{
		+	case OIS::MB_Left:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::LeftButton);
		+	break;
		+	case OIS::MB_Middle:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::MiddleButton);
		+	break;
		+	case OIS::MB_Right:
		+	mSystem->injectMouseButtonDown(CEGUI::MouseButton::RightButton);
		+	break;
		+	case OIS::MB_Button3:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::X1Button);
		+	break;
		+	case OIS::MB_Button4:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonDown(CEGUI::MouseButton::X2Button);
		+	break;
		+	case OIS::MB_NULL:
		+	break;
		+
		+	}
		+	}
		+	else // bButtonDown = false
		+	{
		+	switch (inButton)
		+	{
		+	case OIS::MB_Left:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::LeftButton);
		+	break;
		+	case OIS::MB_Middle:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::MiddleButton);
		+	break;
		+	case OIS::MB_Right:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::RightButton);
		+	break;
		+	case OIS::MB_Button3:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::X1Button);
		+	break;
		+	case OIS::MB_Button4:
		+	CEGUI::System::getSingletonPtr()->injectMouseButtonUp(CEGUI::MouseButton::X2Button);
		+	break;
		+	case OIS::MB_NULL:
		+	break;
		+	}
		+	}
		+
		+	}
		+	</source>
		+
		+	This above function will Convert a OIS Input for the mouse and change it to CEGUI. Right now the codes match, but if they ever change it will provide an example of how to use OIS with CEGUI.
		+
		+
		+	==== Conclusion ====
		+
		+	Understandably this section is a little quicker. But it gives you information about how to start interacting with CEGUI. The next tutorial will teach us how to actually deal with keypresses and make interesting things happen. Until then!