Difference between revisions of "Parameter"

From TouchDesigner Documentation
Jump to: navigation, search
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Parameters in TouchDesigner only exist in [[Operator]]s (OPs or "nodes"). Parameters include:
+
{{#index:Parameters}}{{Glossary
 +
|Title=Parameter
 +
|Short=Parameters in TouchDesigner are an operator's settings (numbers, menus, flags, strings, paths) which the user can alter. Parameters for any operator can be opened by right-clicking on the operator and selecting "Parameters..." A currently selected operator's parameters can be viewed in a [[Network Editor]] by pressing the keyboard shortcut 'p'.
 +
|Long=
 +
}}Parameters in TouchDesigner only exist in [[Operator]]s (OPs or "nodes"). Parameters include:
 
* numbers, both integer and floating point
 
* numbers, both integer and floating point
 
* number pairs, triples or quadruples (e.g. width and height, XYZ position, RGBA color)
 
* number pairs, triples or quadruples (e.g. width and height, XYZ position, RGBA color)
Line 10: Line 14:
 
Fields in dialogs and options to commands are not parameters.
 
Fields in dialogs and options to commands are not parameters.
  
Parameters can contain expressions and variables. The most common [[Tscript Expression]]s are the <code>tab()</code> group, which fetch from DAT tables, and the <code>chop()</code> group, which fetch from CHOP channels.
+
Parameters can be driven by expressions when in [[Parameter Mode|Expression Mode]]. For more information on expressions see also [[Introduction to Python|Python]].
  
Parameters are also controlled by [[Export]]ing channels from CHOPs. In the example Parameter Dialog below, the Y-Translate parameter is being controlled via an export. This is indicated by the green color of the parameter in the dialog.
+
'''TIP''': Pressing Ctrl-E/Cmd+E with the cursor in a parameter brings up the current parameter’s expression in the text editor, making it easier to see and edit long expressions.
  
'''TIP''': Pressing Ctrl-E/Cmd+E with the cursor in a parameter brings up the current parameter’s expression in the text editor, making it easier to see and edit long expressions.
+
Parameters can be driven by [[CHOP]]s by [[Export]]ing CHOP channels to a parameter putting it in [[Parameter Mode|Export Mode]]. In the example Parameter Dialog below, the Y-Translate parameter is being controlled via an export. This is indicated by the green color of the parameter in the dialog.
 +
 
 +
Parameters can be bi-directionally synced to other parameters and CHOP channels using [[Binding]]. The parameter will go into [[Parameter Mode|Bind Mode]].
  
 
[[image:Parameter_Dialog.png]]
 
[[image:Parameter_Dialog.png]]
  
See also: [[Par Class|Parameter Python Class]], [[Parameter Dialog]]
+
See also: [[Par Class|Parameter Python Class]], [[Parameter Dialog]], [[Parameter Mode]]
  
 
[[Category:Touch Glossary]]
 
[[Category:Touch Glossary]]
 
[[Category:Panes]]
 
[[Category:Panes]]
 
[[Category:TDPages]]
 
[[Category:TDPages]]

Revision as of 16:37, 17 January 2020

Parameters in TouchDesigner only exist in Operators (OPs or "nodes"). Parameters include:

  • numbers, both integer and floating point
  • number pairs, triples or quadruples (e.g. width and height, XYZ position, RGBA color)
  • on-off flags
  • menus
  • text strings
  • |paths to other nodes in TouchDesigner networks
  • buttons that initialize actions (uncommon)

Fields in dialogs and options to commands are not parameters.

Parameters can be driven by expressions when in Expression Mode. For more information on expressions see also Python.

TIP: Pressing Ctrl-E/Cmd+E with the cursor in a parameter brings up the current parameter’s expression in the text editor, making it easier to see and edit long expressions.

Parameters can be driven by CHOPs by Exporting CHOP channels to a parameter putting it in Export Mode. In the example Parameter Dialog below, the Y-Translate parameter is being controlled via an export. This is indicated by the green color of the parameter in the dialog.

Parameters can be bi-directionally synced to other parameters and CHOP channels using Binding. The parameter will go into Bind Mode.

Parameter Dialog.png

See also: Parameter Python Class, Parameter Dialog, Parameter Mode

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.

Any floating window that is not a Pane or Viewer.