Network TUIO Receive

Receives touch surfaces and tangible objects data using the TUIO 1.1 protocol (transmitted over OSC). See https://www.tuio.org/ for more info about the protocol.

TUIO Receive

TUIO trackers (multitouch surfaces, tablets, camera trackers like reacTIVision, etc.) continuously send the state of all alive sessions (fingers, fiducial markers or blobs). This module decodes those messages and exposes them as arrays: each alive session keeps a stable index in all the output arrays as long as it is alive (as long as the finger stays on the surface, for example).

When the module is created, Usine asks for the TUIO profile to decode:

  • 2Dcur : cursors (fingers on a touch surface).
  • 2Dobj : tangible objects identified by a fiducial marker.
  • 2Dblb : untagged blobs.

The outputs of the module depend on the chosen profile.

TUIO devices generally send on the UDP port 3333. Don't forget to add this port to the OSC input ports in the setup panel of Usine.

Settings

address

Osc address of the TUIO profile to decode, /tuio/2Dcur by default. Change it only if the tracker uses a custom address.

receive

Sends 1 value when a new data is received.

nb cursors

Only for the 2Dcur profile: number of currently alive cursors (fingers on the surface). This is also the size of all the output arrays.

nb objects

Only for the 2Dobj profile: number of currently alive tangible objects. This is also the size of all the output arrays.

nb blobs

Only for the 2Dblb profile: number of currently alive blobs. This is also the size of all the output arrays.

ids

Array of the session id of each alive session. A session id is a unique number attributed by the tracker: a new touch produces a new session id, and the id disappears from the array when the touch is released.

class ids

Only for the 2Dobj profile: array of the fiducial marker id of each alive object. Unlike the session id, the class id identifies which physical object is on the surface.

x

Array of the horizontal positions, in the range [0..1] (0 is the left border of the surface).

y

Array of the vertical positions, in the range [0..1] (0 is the top border of the surface).

angle

Only for the 2Dobj and 2Dblb profiles: array of the rotation angles in radians.

width

Only for the 2Dblb profile: array of the blobs width, normalized.

height

Only for the 2Dblb profile: array of the blobs height, normalized.

area

Only for the 2Dblb profile: array of the blobs area, normalized.

speed x

Array of the horizontal movement speeds.

speed y

Array of the vertical movement speeds.

rotation speed

Only for the 2Dobj and 2Dblb profiles: array of the rotation speeds.

acceleration

Array of the movement accelerations.

rotation acceleration

Only for the 2Dobj and 2Dblb profiles: array of the rotation accelerations.

frame id

Frame number transmitted by the tracker, increases at each new frame.

ip filter

Filter apply: receives only data's from the specified IP.

Use 0.0.0.0 for no filter.

Common Settings

info

show manual

Button. Opens the manual page of the selected object (or of its parent module for a control) in the web browser. If no page exists for this object, an error is traced in the trace panel.

For more details about information/help creation, see create-help-file.

description

Free multi-line text attached to the module, saved with the patch. It is only meant as an internal note for the patch designer: it is not displayed in the interface.

ID's

visible only in god mode, see setup-panel-tab-expert.

unique ID

Read-only, not saved. Current private numeric ID of the object, used internally to identify it (for example as the target of a bind ID).

preset ID

Read-only, not saved. Private ID used to store and recall the values of this control in presets.

recreate ID

Button. Generates a new unique ID, original ID and preset ID for the object. Use it if you experience difficulties in Polyphonic mode or if two objects share the same ID. Preset values and binds referring to the old IDs are lost.

Object Remote Address

absolute

Read-only, not saved. Absolute address of the object in the Usine objects tree, built from the workspace root. This is the address to use to reach the object from scripts, the objects panel or remote messages. Only shown for objects that are registered in the objects list. See objects-address.

local

Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.

user addr

Free user-defined address for the object (empty by default). When set, the object is also registered in the objects tree under this name, so it can be reached independently of its position in the workspace (the value is also reported in the mouse-over and mouse-down chunks). Changing it rebuilds the objects list. Only available on objects that support a user address. See objects-address.

See also

version 7.0.250121

Edit All Pages