|author||Robin Burchell <firstname.lastname@example.org>||2014-11-26 22:16:16 -0800|
|committer||Robin Burchell <email@example.com>||2014-12-19 00:01:15 +0100|
Long live the TuioTouch input plugin!
This is an import of the tuio2qt plugin (https://github.com/rburchell/tuio2qt), as of sha 9b1f163ac52ea440e83f16b3906f9b55e21b87be henceforth to be developed as a part of Qt itself. This plugin offers touch events via QPA interfaces, using data offered over the TUIO protocol (http://www.tuio.org). It is useful for accepting touch input on devices which otherwise don't have touch input (such as desktops) for the purposes of development, as well as accepting input from some hardware which offers up touch events specifically over the TUIO protocol. Known "shortcomings" at this time, as documented in the README: * Multiple TUIO sources sending data at the same time will conflict. This will not cause problems, strictly speaking, but it will not work well (repeated touchpoint release/press events for the same IDs) * TCP transport is not currently supported. I don't see a need for it at this time, but I have left the capability in terms of port acceptance open for it to be made available. Change-Id: I7178f9db13c635268db8460fbe4d4ea6be654c05 Reviewed-by: Shawn Rutledge <firstname.lastname@example.org>
Diffstat (limited to 'src/plugins/generic/tuiotouch/README.md')
1 files changed, 54 insertions, 0 deletions
diff --git a/src/plugins/generic/tuiotouch/README.md b/src/plugins/generic/tuiotouch/README.md
new file mode 100644
@@ -0,0 +1,54 @@
+# TuioTouch plugin for Qt 5
+This is a QPA-using plugin (meaning, it uses Qt internals) that provides touch
+events from TUIO-based sources (such as [TUIOPad](https://code.google.com/p/tuiopad/)).
+[TUIO](http://www.tuio.org/) is a framework for providing touch events over the
+network (implemented here using a UDP transport).
+This repository also includes a simple [OSC](http://opensoundcontrol.org/spec-1_0)
+parser. OSC is the binary format that TUIO uses for over-the-wire communication.
+Run your application with -plugin TuioTouch, e.g.
+`qmlscene foo.qml -plugin TuioTouch`
+Or make sure the plugin is loaded using the QT_QPA_GENERIC_PLUGINS environment
+By default, you must direct TUIO packets to the IP of the machine the application
+is running on, protocol UDP, port 3333. If you want to customize the port, you
+may provide a port number like this:
+`qmlscene foo.qml -plugin TuioTouch:udp=3333`
+At present, UDP is the only supported transport mechanism.
+## Advanced use
+If you have the need to invert the X/Y axis, you can do so, by adding an
+additional option when loading the plugin.
+`qmlscene foo.qml -plugin TuioTouch:udp=4000:invertx:inverty`
+Would invert the X and Y coordinates of all input coming in on port 4000.
+You can also rotate the coordinates directly, using the rotate option:
+`qmlscene foo.qml -plugin TuioTouch:udp=4000:rotate=180`
+Supported rotations are 90, 180, and 270.
+## Further work
+* Support other profiles (we implement 2Dcur, we want 2Dobj, 2Dblb?)
+* Support multiple simultaneous sources, generating distinct QTouchEvents
+ * We'd need to somehow not rely on FSEQ for removing touchpoints, else our
+ currently minor memory exhaustion problem could become a real issue
+* Support TCP transports?