Input Pointers - Revision history

Mtorni: Note about LaserPointer example requiring release past 2.0.700

2017-07-11T11:32:33Z

Note about LaserPointer example requiring release past 2.0.700

Bablakeluke: /* Virtual Reality */

2017-05-01T04:10:52Z

‎Virtual Reality

Bablakeluke: /* Virtual Reality */

2017-05-01T04:07:03Z

‎Virtual Reality

Bablakeluke: /* Define your own */

2017-04-23T17:54:45Z

‎Define your own

Bablakeluke: /* Define your own */

2017-04-23T17:43:52Z

‎Define your own

Bablakeluke at 17:29, 23 April 2017

2017-04-23T17:29:19Z

Bablakeluke: /* Making it click */

2017-03-22T18:59:14Z

‎Making it click

Bablakeluke at 18:57, 22 March 2017

2017-03-22T18:57:56Z

188.222.158.94 at 22:22, 7 March 2017

2017-03-07T22:22:42Z

188.222.158.94: /* Mouse Input */

2017-03-07T22:08:39Z

‎Mouse Input

← Older revision		Revision as of 11:32, 11 July 2017
Line 21:		Line 21:

	/// <summary>A laser pointer which fires an input ray from e.g. a 3D hand.</summary>		/// <summary>A laser pointer which fires an input ray from e.g. a 3D hand.</summary>
		+	/// NOTE: PowerUI.InputPointer.Raycast is defined in PowerUI git master, not in releases at least up to 2.0.700
	public class LaserPointer : PowerUI.InputPointer{		public class LaserPointer : PowerUI.InputPointer{

@@ Line 13: / Line 13: @@
 == Virtual Reality ==
-PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras|the article]] relating to virtual reality camera's. Alternatively here's a (rough!) laser pointer input example:
+PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras|the article]] relating to virtual reality camera's. Alternatively here's a (rough!) laser pointer input example. Just add it to your project and see the notes below on how to e.g. add it and make it click:
 <syntaxhighlight lang='csharp'>
@@ Line 74: / Line 74: @@
+}
 </syntaxhighlight>

@@ Line 13: / Line 13: @@
 == Virtual Reality ==
-PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras|the article]] relating to virtual reality camera's.
+PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras|the article]] relating to virtual reality camera's. Alternatively here's a (rough!) laser pointer input example:
 == Define your own ==

@@ Line 45: / Line 45: @@
 public class MyCustomPointer : InputPointer{
-     public override bool Relocate(){
+     public override bool Relocate(out Vector2 positionChange){
          // - Get your latest coordinates here -
@@ Line 51: / Line 51: @@
          // Try moving it (just returns false if your position wasn't different to the current one):
-         return TryChangePosition(newPosition);
+         return TryChangePosition(newPosition, out positionChange);
+     }

@@ Line 17: / Line 17: @@
 == Define your own ==
-If you're doing something more specialised then you can also define your own input pointer. Multiple Wii controllers, for example. This is very straight forward to do - at a minimum you must inherit from InputPointer and override Relocate:
+If you're doing something more specialised then you can also define your own input pointer. Multiple Wii controllers, for example. This is very straight forward to do - at a minimum you must inherit from InputPointer:
 <syntaxhighlight lang="csharp">
@@ Line 28: / Line 50: @@
          Vector2 newPosition = Vector2.zero;
-         if(newPosition.x == ScreenX && newPosition.y == ScreenY){
+         // Try moving it (just returns false if your position wasn't different to the current one):
-            // It's not moved anywhere - quit:
+         return TryChangePosition(newPosition);
+     }
@@ Line 43: / Line 57: @@
 </syntaxhighlight>
 == Making it click ==

@@ Line 14: / Line 14: @@
 PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras|the article]] relating to virtual reality camera's.
 == Making it click ==
@@ Line 25: / Line 63: @@
 void OnGUI(){
-   // Returns true if your pointer actually did something.
+   // Returns true if your pointer actually did something (it went down or up)
    // You can also directly pass a UnityEngine.Event too.
    bool didSomething = MyPointer.HandleEvent();

@@ Line 33: / Line 33: @@
 </syntaxhighlight>
-* Call the MyPointer.Down and MyPointer.Up methods (Optionally specifying a mouse button ID):
+* Call the MyPointer.Down and MyPointer.Up methods (Optionally specifying a [https://docs.unity3d.com/ScriptReference/Event-button.html mouse button ID]):
 <syntaxhighlight lang="csharp">

← Older revision		Revision as of 18:57, 22 March 2017
Line 14:		Line 14:

	PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras\|the article]] relating to virtual reality camera's.		PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras\|the article]] relating to virtual reality camera's.
		+
		+	== Making it click ==
		+
		+	If you've got an input pointer and you'd like to click it (or vary its downward pressure), you can either:
		+
		+	* Use the convenience method for mouse up/down events from OnGUI:
		+
		+	<syntaxhighlight lang="csharp">
		+
		+	void OnGUI(){
		+
		+	// Returns true if your pointer actually did something.
		+	// You can also directly pass a UnityEngine.Event too.
		+	bool didSomething = MyPointer.HandleEvent();
		+
		+	}
		+
		+	</syntaxhighlight>
		+
		+	* Call the MyPointer.Down and MyPointer.Up methods (Optionally specifying a mouse button ID):
		+
		+	<syntaxhighlight lang="csharp">
		+
		+	// Mousedown event, left button:
		+	MyPointer.Down(0);
		+
		+	// Which is also the same as:
		+	MyPointer.LeftDown();
		+
		+	// Mouseup event, left button:
		+	MyPointer.Up(0);
		+
		+	// Which is the same as:
		+	MyPointer.LeftUp();
		+
		+	</syntaxhighlight>
		+
		+	* Use SetPressure directly - this is useful if you've got some kind of stylus ''(every other option is just an abstraction of SetPressure)''
		+
		+	<syntaxhighlight lang="csharp">
		+
		+	void Update(){
		+
		+	// Update the pointer pressure:
		+	MyPointer.SetPressure(someVaryingField);
		+
		+	}
		+
		+	</syntaxhighlight>

	== Accessing all pointers ==		== Accessing all pointers ==

← Older revision		Revision as of 22:22, 7 March 2017
Line 14:		Line 14:

	PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras\|the article]] relating to virtual reality camera's.		PowerUI has a custom input pointer, a [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1CameraPointer.html CameraPointer], for virtual reality. See [[Virtual Reality Cameras\|the article]] relating to virtual reality camera's.
		+
		+	== Accessing all pointers ==
		+
		+	PowerUI implements various standard API's for accessing pointers:
		+
		+	* [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1TouchEvent.html TouchEvent].touches
		+	* TouchEvent.targetTouches
		+	* TouchEvent.changedTouches
		+	* TouchEvent.identifier
		+	* ''More!''
		+
		+	The non-standard internal ones:
		+
		+	* [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1UIEvent.html#a2daa44fbceddd8510bc2791340a432b4 UIEvent.trigger] - ''MouseEvent, TouchEvent etc; The InputPointer instance this event came from''
		+	* [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1InputPointer.html#a77189cd51fedf33c73759f641c8380ef InputPointer.All] - ''All active pointers (array created on use; Use AllRaw and PointerCount for better performance)''
		+	* [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1InputPointer.html#a731d759f87ece43622fb497b5e3d88b3 InputPointer.PointerCount] - ''The number of actual pointers in the AllRaw pointer set''
		+	* [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1InputPointer.html#aa76092f569304c8fcf6c3bea1f9612e3 InputPointer.AllRaw] - ''The raw set of pointers. Entries beyond PointerCount are random noise/ undefined.''
		+

	== Source locations ==		== Source locations ==

@@ Line 3: / Line 3: @@
 == Mouse Input ==
-PowerUI assumes that only a desktop platform will have a mouse. A MousePointer is created when it's running on a desktop and PowerUI.Input.CreateSystemMouse is true ''(the default)''. If your project doesn't use a mouse pointer on a desktop platform (it's [[Virtual Reality Cameras|virtual reality]] for example), you'd remove it by setting CreateSystemMouse to false in an Awake method.
+PowerUI assumes that only a desktop platform will have a mouse. A [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1MousePointer.html MousePointer] is created when it's running on a desktop and [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1Input.html#a7527e2574ccda7fb7cdd2d8a28fff6db PowerUI.Input.CreateSystemMouse] is true ''(the default)''. If your project doesn't use a mouse pointer on a desktop platform (it's [[Virtual Reality Cameras|virtual reality]] for example), you'd remove it by setting [http://powerui.kulestar.com/powerdocs-2_0/classPowerUI_1_1Input.html#a7527e2574ccda7fb7cdd2d8a28fff6db CreateSystemMouse] to false in an Awake method.
 == Touch and Stylus Input ==