Parameter Dialog

From TouchDesigner 099 Wiki

A Parameter Dialog allows you to view and manipulate all the Parameters of an Operator. Each Operator has one or more pages (or "tabs") of parameters viewable in the dialog, some tabs are unique to individual OPs, while others are common to different OP types.

Parameter Dialog

The dialog is viewable in three different areas in the TouchDesigner user interface. The Parameter Dialog is viewable in the Network Editor pane by pressing the p key. This will also hide the dialog if it is already visible. Parameters Dialog can also be an floating window by selecting it from the right-click menu on nodes. Finally, it can be viewed as a Pane type.

All of the parameter dialogs have a similar layout with the same set of gadgets to manipulate the various parameter values. Parameter dialogs are displayed on the right side of a network. Multiple parameter dialogs can be open at once, by flipping either the Network or Pane Sticky button. The topmost visible parameter dialog is the currently selected OP.



Header

ParameterHeader.png

The header section in the parameter dialog displays the type and name of the operator and provides a number of buttons for basic operations as described below. The background color of the parameter header indicates the operator's family type.

Top Section

  • OP Type
  • OP Name

Bottom Section

  • Operator Help
  • Python Class Help
  • Operator Info
  • Comment
  • Clipboard
  • Python/Tscript Operator Language Toggle
  • Hide/Show Default Parameters

Parameter Pages

ParameterTabs.png

Each page displays a different parameter page for the operator.

Parameters

ValueLadder.png ParameterPopupMenu.png

Left click on any parameter name/label to expand the Parameter Modes (See section below). Left click in a parameter's editable field to enter a new value.

Middle click on and numeric parameter to bring up the Value Ladder to adjust the value. If the parameter is a double/triple/quadruple parameter (such as Offset in the Displace TOP or Translate in the Geometry COMP), opening the value ladder on the parameter's name/label will adjust all two/three/four at the same time. For individual parameter adjustment middle-mouse click on the numeric field itself.

Right click on any parameter to open a popup menu of options for the parameter.

Working with Parameters of Multiple Operators

When selecting multiple operators of the same type, you can quickly set the parameter value for all the selected operators at to the same value at the same time. Simply select the multiple nodes to change, then change the parameter of the current one and all selected will also be updated.

Also with multiple operators selected you can set which parameter page is first available when you go to the individual operator's parameters. This can be a time saver when going through many nodes to make individual changes on their parameters when you always need to access the same parameter page. For example, when you have 5 Text TOPs and need to change the color of each to a unique color. Instead of having to select the Color page of parameters each time, you can select all the operators and then select the Color page of the current operator. Now each time you individually select one of the other Text TOPs, the parameter page shown will already be set to the Color page, letting you change the colors more quickly.

Working with Parameter Modes

Every Parameter can be in one of three modes, Constant Mode, Expression Mode or Export Mode. The Parameter Mode lets you quickly switch modes to test new values, expressions, or export settings.

  • Constant - this is the default mode which handles number and string values as entered into the parameter.
  • Expression - this mode is for using a python or tscript expression to set the parameter's value.
  • Export - this mode is for driving the parameter by Exporting from a CHOP or DAT.

To access the parameter modes, expand the parameter by clicking on the parameter's name/label area with the LMB. This will open an editing area for the parameter as well 3 toggles to switch between modes. To close this area, simply click on the parameter name/label or "-" icon.

When the parameter is expanded, you will see the internal name of the parameter. This name is used for scripting and directly accessing the parameter.

To the right of the internal name there are 3 square buttons to switch between modes. The grey button is for constant mode, the blue button for expression mode, and the green button for export mode (must first have an exported value to the parameter to switch to export mode).

The image below show 3 parameters expanded: the Seed parameter in constant mode, the Period parameter in expression mode, and the Harmonics parameter in export mode.

ParameterModesExample.png


The values of all 3 modes are saved in the parameter. This provides an ability to setup a constant value, an expression, and an export to the same parameter and freely switch between the 3 modes. If there is an expression or export set in a parameter but that mode is not currently selected, the mode button will indicate this by displaying a small square in the lower-left corner of the mode toggle button.

The image below shows a parameter in constant mode with an expression and export set and ready to use.

ParameterModeIndicators.png


You do not need to first change the mode to add an expression or export. Simply start typing an expression in the parameter, or drag n drop a channel to the parameter, once confirmed (press enter or accept "Export CHOP" from the pop-up menu) the parameter will automatically switch to the correct mode.

The advantages of working with parameter modes are rapid prototyping and testing and debugging capabilities. If you have a parameter driven by expression or export, you can easily jump to constant mode to stop the expression/export driving the parameter. While in constant mode you can test particular values or examine the system with certain set value. At any time you can switch the parameter mode back to expression/export to reconnect the previous logic. Working in previous versions of TouchDesigner would have required deleting the expression or CHOP export completely from the parameter to test other values.

Parameter Manipulators

See also