Last Updated on
Category: Media Sources
Tags: Generative, Image Processing, Image Sources, Integration, Plugin
The TouchEngine node allows the integration of TouchDesigner projects directly into a Screenberry pipeline using the TouchEngine API. Video streams obtained from TouchEngine can be used as a texture or as a composition layer. Incoming data streams can be used to provide Screenberry with information like tracking coordinates, object properties, DMX values, touch events, and any other real-time data.
TouchEngine requires an installed version of TouchDesigner along with any paid license. When TouchEngine is run, it automatically locates the TouchDesigner application on the user’s system suitable for use.
It is not required to run TouchDesigner for TouchEngine to work.
To make a TouchDesigner project available for integration:
- In the TouchDesigner project, create the needed In and Out operators of the required types.
- Save the project as a component (.tox file).
To integrate the TouchDesigner project into Screenberry:
- Add the TouchEngine node to the node graph.
- In the node settings of the TouchEngine node, select and load .tox file, and
- Add input and output parameters that correspond to the In and Out operators in the TouchDesigner project by repeating the following steps for each parameter:
- Press the Add Input Parameter / Add Output Parameter button.
- Copy-paste the name of the added parameter from TouchDesigner.
Prior to TouchDesigner version 2021.13610, the prefixes input/ and output/ had to be used in the names of In and Out operators. In versions 2021.13610 and higher, the prefix op/ has to be added for both In and Out operators.
Ensure that the Found information checkbox for the added TouchEngine parameter is selected. Otherwise, check if the parameter name matches the name of the corresponding TouchDesigner operator.
- Select the type of the added parameter — TOP, CHOP, DAT (Table), or DAT (String).
Currently, TOP, CHOP, and DAT input and output operators are supported by the TouchEngine API:
- TOP — an operator family that creates, composites, and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card’s GPU.
- CHOP — an operator family which operates on Channels (a series of numbers) that are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.
- DAT — an operator family that manipulates text strings: multi-line text or tables. Multi-line text is often a command script but can be any multi-line text. Tables are rows and columns of cells, each containing a text string.
When an input/output parameter is added in the node settings, a corresponding pin is added to the node, allowing you to connect this parameter to other nodes as needed.
Example of a node tree with the TouchEngine node. You can download these sample Screenberry and TouchDesigner projects here.