Context Menu - Revision history

Bablakeluke at 05:11, 19 April 2017

2017-04-19T05:11:07Z

2017-04-19T05:10:50Z

2017-04-19T05:10:29Z

2017-04-19T05:10:04Z

‎3D

2017-04-19T05:08:41Z

‎3D

2017-03-18T16:49:46Z

‎Setting up the appearance of context menu's

2017-03-18T16:48:11Z

2017-02-12T01:13:36Z

‎3D

2017-01-13T23:16:15Z

‎Setting up the appearance of context menu's

2017-01-13T22:52:55Z

@@ Line 5: / Line 5: @@
 Context menu's can be created for either 2D or 3D objects. The flow of both has been made as consistent as possible - essentially, you need to '''respond to the contextmenu event'''.
-== 2D ==
+=== 2D ===
 HTML elements receive a contextmenu event, which you can connect to however you like (usually with addEventListener("contextmenu",..)). Use ContextEvent.add in there too in order to build up the options. For example, you might have an inventory. Each item, when clicked on, generates a context menu with options like "use" or "drop". You'd add each of those via ContextEvent.add.
-== 3D ==
+=== 3D ===
 Tick '''Window > PowerUI > Handle 3D Input''' and attach something like this to your GameObjects:
@@ Line 42: / Line 42: @@
 If you use this approach, note that '''the event will bubble up the scene hierarchy''', in a similar way to it bubbling through the DOM. This way, if PowerUI's input ray hits a collider which is a child of an NPC or a door etc, then it will reach the root NPC object and you'll get a successful handle.
-== Advanced 3D ==
+=== Advanced 3D ===
 Advanced: If you don't want to add a script to every gameObject, then instead you can use the GameObject to EventTarget mapper and handle obtaining the event target in a custom way:

@@ Line 8: / Line 8: @@
 HTML elements receive a contextmenu event, which you can connect to however you like (usually with addEventListener("contextmenu",..)). Use ContextEvent.add in there too in order to build up the options. For example, you might have an inventory. Each item, when clicked on, generates a context menu with options like "use" or "drop". You'd add each of those via ContextEvent.add.
 == 3D ==
@@ Line 83: / Line 66: @@
 The dispatch method is, however, the same as the MonoBehaviour approach (only it would return e.g. context options specific to an NPC).
 == Menulist - the built in default ==

@@ Line 5: / Line 5: @@
 Context menu's can be created for either 2D or 3D objects. The flow of both has been made as consistent as possible - essentially, you need to '''respond to the contextmenu event'''.
 == 3D ==
@@ Line 39: / Line 59: @@
 If you use this approach, note that '''the event will bubble up the scene hierarchy''', in a similar way to it bubbling through the DOM. This way, if PowerUI's input ray hits a collider which is a child of an NPC or a door etc, then it will reach the root NPC object and you'll get a successful handle.
-== 2D ==
+== Advanced 3D ==
 <syntaxhighlight lang="csharp">
-// Get it as a context event:
+// Hook up our mapper:
-ContextEvent context=e as ContextEvent;
+PowerUI.Input.TargetResolver=delegate(GameObject go,out bool cancelEvent){
-// Set the template to use:
+</syntaxhighlight>
-</syntaxhighlight>
+For example, you might have an NPC class (and that NPC class is an IEventTarget). You'd map the given gameObject through to an NPC instance.
-By default, it's "menulist" - the name of a built in context menu. Conveniently, this approach means different objects can respond with completely different context menu styles too; for example, a 3D NPC might display a radial context menu (like in the Sims) and a 2D item in an inventory displays the default menulist.
+The dispatch method is, however, the same as the MonoBehaviour approach (only it would return e.g. context options specific to an NPC).
 == Menulist - the built in default ==

@@ Line 8: / Line 8: @@
 == 3D ==
-Attach something like this to your GameObject:
+Tick '''Window > PowerUI > Handle 3D Input''' and attach something like this to your GameObjects:
 <syntaxhighlight lang="csharp">
@@ Line 27: / Line 27: @@
 		context.add("&Open;",delegate(Option o){
-			// 'open' gameObject
+			// 'open' the door!
 		});
@@ Line 38: / Line 38: @@
 If you use this approach, note that '''the event will bubble up the scene hierarchy''', in a similar way to it bubbling through the DOM. This way, if PowerUI's input ray hits a collider which is a child of an NPC or a door etc, then it will reach the root NPC object and you'll get a successful handle.
 == 2D ==

@@ Line 18: / Line 18: @@
-public class MyEventTarget : MonoBehaviour,IEventTarget {
+public class My3DContextMenu : MonoBehaviour {
-	public bool dispatchEvent(Dom.Event e){
+	public void OnContextMenu(ContextEvent e){
-−
-		if(e.type!="contextmenu"){
+		// *this* GameObject has been asked for a context menu.
 		// E.g. if this gameObject is some kind of door, then:
 		context.add("&Open;",delegate(Option o){
@@ Line 35: / Line 30: @@
 		});
+	}
@@ Line 47: / Line 39: @@
 If you use this approach, note that '''the event will bubble up the scene hierarchy''', in a similar way to it bubbling through the DOM. This way, if PowerUI's input ray hits a collider which is a child of an NPC or a door etc, then it will reach the root NPC object and you'll get a successful handle.
-If you don't want to add a script to every gameObject, then instead you can use the GameObject to EventTarget mapper and handle obtaining the event target in a custom way:
+Advanced: If you don't want to add a script to every gameObject, then instead you can use the GameObject to EventTarget mapper and handle obtaining the event target in a custom way:
 <syntaxhighlight lang="csharp">

@@ Line 76: / Line 76: @@
 == Setting up the appearance of context menu's ==
-ContextEvent has a field called '''window''' - it's the name of a [[Window Templates|window template]]:
+ContextEvent has a field called '''template''' - it's the name of one of your [[Widget Templates|widget templates]]:
@@ Line 85: / Line 85: @@
 // Set the template to use:
-context.window="windowTemplateName";
+context.template="widgetTemplateName";
 </syntaxhighlight>

← Older revision		Revision as of 16:48, 18 March 2017
Line 1:		Line 1:
−	Context menus pop up to display one or more options to the user, depending on what it was that they interacted with. They come in a huge variety of shapes and sizes - from radial "Sims style" to ordinary lists that show up when you right click. PowerUI has a built in context menu system which sits on top of the ~~window~~ system enabling templates of context menu's to be easily created and shared.	+	Context menus pop up to display one or more options to the user, depending on what it was that they interacted with. They come in a huge variety of shapes and sizes - from radial "Sims style" to ordinary lists that show up when you right click. PowerUI has a built in context menu system which sits on top of the [[Widget Manager\|widget system]] enabling [[Widget Templates\|templates of context menu's]] to be easily created and shared.

	== 2D and 3D context menu's ==		== 2D and 3D context menu's ==

← Older revision		Revision as of 23:16, 13 January 2017
Line 76:		Line 76:
	== Setting up the appearance of context menu's ==		== Setting up the appearance of context menu's ==

−	ContextEvent has a field called '''window''':	+	ContextEvent has a field called '''window''' - it's the name of a [[Window Templates\|window template]]: