Panel Toolset

From TouchDesigner Documentation
Jump to: navigation, search

Panel Components[edit]

There are 5 Panel Components used in the construction of TouchDesigner control panels. They are found under the 'COMP' section of the OP Create Menu. Press <Tab> and select 'COMP', you will see the Panel Components at the top of the list in dark gray. They are: Button, Slider, Container, Field, Select.

Panel Values[edit]

All control panel gadgets (the Panel Component types) have a list of states represented by what are called "Panel Values". See the Panel Value page for the full list of the panel values.

It is the user's interaction with the gadgets that sets all the panel values.

The panel values can be accessed in several places:

  • a Panel CHOP, which you can put inside any gadget, where you can also see the list of possible panel values for that gadget. Put a Panel CHOP in a Button component, display the viewer of the button component and watch the panel values in the Panel CHOP change.
  • panel() expression, where you can query the state of a variable.
  • Middle-click on a panel component shows the names and values of all the panel values.
  • Panel Execute DAT allows you to trigger a script based on the changes or states of any panel value. Put a Panel Execute DAT in a Button COMP and look in the Panel Value parameter menu to see the list of values. Select a Panel Value to use as a trigger to execute the script.

Panel CHOP[edit]

The Panel CHOP works in conjunction with Panel Components by grabbing all the Panel Values and outputs them as CHOP channels. Exporting these channels to parameters is the most straightforward way to connect custom UI panels to various operator parameters in the project.

The Panel CHOP only has 3 parameters:

Component - specifies the component that the Panel CHOP is retrieving values from. You can drag and drop any panel component onto this parameter. If this path is left blank, it defaults to the Parent component.

Select - selects which values to output. The default is '*', meaning 'all values'. You can select a subset by using the drop-down menu on the right, or by typing in the names of the values you are interested in. Pattern Matching can also be used to select multiple values.

Rename - Allows you to rename selected channels.

Panel Component Parameters[edit]

All Panel Components have 3 common parameter pages used to create a control panel. They are the Layout page, the Panel page, and the Color page. Additionally, the Button, Field, and Slider components have an addition parameter pages (of the respective name) to contain parameters specific to that panel type.

Panel COMP Layout Page

Panel COMP Panel Page

Panel COMP Color Page

An Operator Family that contains its own Network inside. There are twelve 3D Object Component and eight 2D Panel Component types. See also Network Path.

The Container component type is a Panel Component that holds and displays any number of Panel Components (also known as Gadgets) in Panel.

The component types (e.g. Slider, Button, Field, Container) that are used to create custom control panels, also known simply as Panel or Gadget

An Operator Family which operate on Channels (a series of numbers) which are used for animation, audio, mathematics, simulation, logic, UI construction, and many other applications.

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.

The internal states of a panel component are Panel Values, and are accessed with a Panel CHOP, a OP.panel Python expression, or a Panel Execute DAT.

An Operator Family that contains its own Network inside. There are twelve 3D Object Component and eight 2D Panel Component types. See also Network Path.

(1) The TouchDesigner window is made of a menu bar at the top, a Timeline at the bottom, plus one of a choice of Layouts in the middle. A Layout is made on one or more Panes, each Pane can contain a Network Editor, Viewer, Panel, etc. See Pane and Bookmark. (2) Nodes in a network are arranged using Layout commands in the RMB menu.