The Parameter Component allows any operator's parameter dialog to be a panel with full interactivity. You specify which operator whose parameters you want to appear in the panel.
You can optionally have it display the header and the page names, and include built-in or Custom Parameters.
You can specify a scope of pages and individual parameters to display, for example two entire pages plus four parameters on other pages. When specifying parameters only, the order of the parameters is the order you specify them in.
You can shrink the UI so it fits into a smaller panel, using the Compress parameter.
You can control whether users can open the parameter for editing (via the + on the left of the parameter) using the Allow Expansion toggle. You can prevent users from going in and editing expressions.
You can specify page or parameter names using pattern matching:
^tx, etc, with page names that contain spaces specified in quotes.
'Cue 1' 'Cue 2', or specified as a python list.
Parameters - Parameter Page
op - Path to the operator whose parameters will be used.
header - Include the header of the parameter dialog. This is the section with OP type, name, and help buttons.
pagenames - Include the tabs for the parameter pages in the display.
separators - Display the separating lines between sections of parameters.
allowexpend - Controls whether or not parameters can be expanded to reveal parameter modes and expression fields.
builtin - Include the operator's built-in parameters.
custom - Include the operator's Custom Parameters.
combinescopes - ⊞ - Specify the how to combine the scope parameters below to make the parameter selection.
- Any (Or)
- All (And)
pagescope - Selects with pages of parameters to include. Use * for Pattern Matching all.
parscope - Selects which parameters to include. Use * for Pattern Matching all.
Order by Scope
scopeorder - Displays the parameters in the order they are defined in the Parameter Scope parameter above. Only available when Page Name parameter is Off.
compress - When you change the Compress value, the panel stays exactly the same width and height as specified by the Width and Height parameters, but it renders more or less of the parameter dialog in it. Hence when increasing Compress the text is smaller and you see more parameters at a time.
Parameters - Layout Page
The Layout parameter page controls the size and position of the panel.
x - Specify the horizontal position in pixels relative to its parent.
y - Specify the vertical position in pixels relative to its parent.
w - Specify the panel's width in pixels.
h - Specify the Panel's height in pixels.
fixedaspect - ⊞ - Allows easy creation of panels with a specific aspect set in the Aspect Ratio parameter below. Only requires setting the width or height of the panel and the other dimension is calculated based on the Aspect Ratio parameter.
- Use Horizontal
- Use Vertical
aspect - Specify the ratio when using Fixed Aspect parameter above, the ratio is width/height.
layer - Specifies the order the panel components are drawn in, similar to layers in Photoshop. Higher values will be drawn over any other panel with a lower value (that is at the same level of hierarchy). If two panel components have the same Depth Layer value then they are ordered based on the operator's name.
hmode - ⊞ - Select one of 3 modes to determine the horizontal width of the panel.
- Fixed Width
fixed- Uses the Width parameter above to set this panel's width in pixels.
fill- The width of this panel will match (fill) the width of the parent panel.
anchors- The width of this panel is set by the Left Anchor and Right Anchor parameters below which will maintain a relative width to the parent panel as the parent panel changes size. This allows for stretchy panels. These anchor parameters are normalized 0-1 like uv coordinates where 0 is the left edge and 1 is the right edge of the parent panel. For example, Left Anchor = 0.2 and Right Anchor = 0.8 will maintain the width proportionally to the parent panel such that the left edge is 20% (0.2) in from the left and the right edge is 20% (0.8) in from the right.
leftanchor - Position of the left anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the left edge of the parent and 1 is the right edge of the parent.
leftoffset - An offset for the left anchor in pixels.
rightanchor - Position of the right anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the left edge of the parent and 1 is the right edge of the parent.
rightoffset - An offset for the right anchor in pixels.
horigin - Sets the position of the panel's origin horizontally. The default origin (0,0) is the bottom-left corner of the panel.
Horizontal Fill Weight
hfillweight - When multiple panels are using Horizontal Mode = Fill and being aligned by the parent either Left to Right or Right to Left, this fill weight parameter can be used to bias the fill width of the panels.
vmode - ⊞ - Select one of 3 modes to determine the vertical height of the panel.
- Fixed Height
fixed- Uses the Height parameter above to set this panel's height in pixels.
fill- The height of this panel will match (fill) the height of the parent panel.
anchors- The height of this panel is set by the Bottom Anchor and Top Anchor parameters below which will maintain a relative and proportionally height to the parent panel as the parent panel changes size. This allows for stretchy panels. These anchor parameters are normalized 0-1 like uv coordinates where 0 is the bottom edge and 1 is the top edge of the parent panel. For example, Bottom Anchor = 0.3 and Right Anchor = 0.5 will maintain the height proportionally to the parent panel such that the bottom edge is 30% (0.3) up from the bottom and the top edge is 50% (0.5) down from the top.
bottomanchor - Position of the bottom anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the bottom edge of the parent and 1 is the top edge of the parent.
bottomoffset - An offset for the bottom anchor in pixels.
topanchor - Position of the top anchor of the panel with respect to the parent. This value is normalized 0-1, 0 is the bottom edge of the parent and 1 is the top edge of the parent.
topoffset - An offset for the top anchor in pixels.
vorigin - Sets the position of the panel's origin vertically. The default origin (0,0) is the bottom-left corner of the panel.
Vertical Fill Weight
vfillweight - When multiple panels are using Vertical Mode = Fill and being aligned by the parent either Top to Bottom or Bottom to Top, this fill weight parameter can be used to bias the fill height of the panels.
alignallow - ⊞ - When set to Ignore, the Panel will ignore any Align parameter settings from its parent.
allow- Aligns the panel based on settings in parent.
ignore- Does not align the panel but respects margins.
- Ignore and Ignore Margins
ignoremargin- Does not align the panel and disregards margins.
alignorder - This parameter allows you to specify the align position when its parent's Align parameter is set to something other then None or Match Network Nodes. Lower numbers are first.
postoffset - ⊞ - Adds an offset after all other postions and alignment options have been applied to the panel.
Size from Window
sizefromwindow - When enabled the panel component's width and height are set by resizing its floating viewer window.
Parameters - Panel Page
The Panel parameter page controls panel attributes such as display on/off, enable on/off, panel help, and interactions with the cursor.
display - Specifies if the panel is displayed or hidden. Changing this parameter may incur some layout processing costs. For simple cases, such as overlays it is more performant to adjust the opacity parameter instead.
enable - Allows you to prevent all interaction with this panel.
helpdat - Lets you specify the path to a Text DAT whose content will be displayed as a rollover pop-up help for the control panel.
Floating Viewer Aspect
vieweraspect - ⊞ - Controls whether the aspect ratio is proportional or unconstrained when resizing a floating viewer ie. dragging the edges of the viewer to resize it.
cursor - ⊞ - Changes the cursor displayed when cursor is over the panel.
- Normal Select
- Link Select
- Text Select
- Precision Select
multitouch - ⊞ - When enabled, this panel will process the first touch it gets in a similar manner to how it processes a mouse click, with updates to u, v, state etc. The touch event must be initiated from the panel. Subsequent touches are ignored. If this panel handles multi-touch events via the Multi Touch In DAT, you may want to disable Built-in Multi-Touch so it won't interfere with script processing.
- Use Parent's Multi-Touch Settings
mtouchparent- Use the parent's Multi-Touch setting. This defaults to enabled in the root component.
- Use Built-in Multi-Touch
mtouchyes- Enable use of first touch as mouse.
- Do Not Use Built-in Multi-Touch
mtouchno- Disable use of first touch as mouse.
constraincursor - Constrains the cursor to this panel, keeping it inside once it enters.
clickthrough - When enabled all mouse clicks are ignored by this Panel Component.
Use Mouse Wheel
mousewheel - Turn on to capture events when the mouse wheel is used over the panel.
Mouse UV Buttons
uvbuttons - - Allows you to specify which mouse buttons update the uv Panel Values.
mouserel - When enabled the uv Panel Values will reflect relative mouse movement.
Drag Edges to Resize
resize - ⊞ - Four checkboxes allow you to enable resizing a panel by grabbing the corresponding edge or corner: Resize Left, Right, Bottom, Top.
resizew - ⊞ - Limits the left-right (width) resizing range.
resizeh - ⊞ - Limits the bottom-top (height) resizing range.
Drag to Reposition
reposition - ⊞ - Enables repositioning of the panel or window by dragging with the mouse.
repocomp - Enabled by choosing the Component option from the Reposition parameter. Specify the path to the panel component you would like to reposition by mouse.
repositionx - ⊞ - Enabled by choosing the Component option from the Reposition parameter. Sets the maximum range for repositioning the panel component horizontally.
repositiony - ⊞ - Enabled by choosing the Component option from the Reposition parameter. Sets the maximum range for repositioning the panel component vertically.
anchordrag - ⊞ - When Drag To Reposition parameter is set to Component, and the panel's Horizontal Mode and/or Vertical Mode is set to Anchors, this menu determines whether drag-to-reposition actions change Anchor values or Offset values.
anchors- Drag-to-reposition actions change Anchor parameter values
offsets- Drag-to-reposition actions change Offset parameter values
scrolloverlay - ⊞ - Controls whether the panel is affected by scrollbar position. This allows the creation of panel overlays that aren't affected by the panel's scrollbars.
off- Scrollbar affects panel normally.
ignore- Panel will not move when scrollbar is moved. Panel depth is determined by Depth Layer parameter normally.
- Ignore and Draw Over
ignoreover- Panel will not move when scrollbar is moved. Panel is drawn over scrollbars and sibling panels.
Parameters - Look Page
The Color parameter page sets the panel's background, border, and disabled colors.
bgcolor - ⊞ - RGB values for the background. (default: black (0,0,0))
bgalpha - Set the alpha value for the background.
top - Allows you to specify a TOP as the background for the panel.
topfill - ⊞ - This menu specifies the way the Background TOP will fill the panel's background.
- Fill Width
- Fill Height
- Fill Best
- Native Resolution
topsmoothness - ⊞ - This menu controls background TOP's viewer smoothness settings. In previous builds of TouchDesigner, this was always 'Mipmap Pixels', so old files will load with this setting whereas the default for new Panel COMP's is 'Interpolate Pixels'.
- Nearest Pixel
nearest- Uses nearest pixel or accurate image representation. Images will look jaggy when viewing at any zoom level other than Native Resolution.
- Interpolate Pixels
linear- Uses linear filtering between pixels. Use this to get TOP images in viewers to look good at various zoom levels, especially useful when using any Fill Viewer setting other than Native Resolution.
- Mipmap Pixels
mipmap- Uses mipmap filtering when scaling images. This can be used to reduce artifacts and sparkling in moving/scaling images that have lots of detail. When the input is 32-bit float format, only nearest filtering will be used (regardless of what is selected).
bordera - ⊞ - RGB values for border A color.
Border A Alpha
borderaalpha - Alpha value for border A color.
borderb - ⊞ - RGBA values for border B color.
Border B Alpha
borderbalpha - Alpha value for border B color.
leftborder - What color the 2 left-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
Left Border Inside
leftborderi - Same as above parameter but used for an inside border.
rightborder - What color the 2 right-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
Right Border Inside
rightborderi - Same as above parameter but used for an inside border.
bottomborder - What color the 2 bottom-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
Bottom Border Inside
bottomborderi - Same as above parameter but used for an inside border.
topborder - What color the 2 top-most pixels are. Options are 0 (no change), Border A (uses color defined in Border A), or Border B (uses color defined in Border B).
Top Border Inside
topborderi - Same as above parameter but used for an inside border.
Border Over Children
borderover - Draws the panel's borders on top of all children panels.
dodisablecolor - Enable the use of a unique disable color below when the panel's Enable = Off.
disablecolor - ⊞ - RGB values for the disable color. (default: black (0,0,0))
disablealpha - Set the alpha value for the disable color.
Multiply RGB by Alpha
multrgb - Multiplies the RGB channels by the alpha channel.
composite - ⊞ - Selects how the panel is composited with its siblings panels. See the Composite TOP for a description of the various composite methods.
opacity - Allows you to control the transparency of the panel.
Parameters - Children Page
The Children parameter page controls aspects of the Panel's children alignment, size, and position.
align - ⊞ - This menu allows you to specify how the children inside the Panel Component will be laid out. The options Layout Grid Rows, Layout Grid Columns and Match Network Nodes will scale the Panel Component's children to fit the Component. They use the Align Order of each of the children to determine the ordering of the children.
- Left to Right
- Right to Left
- Top to Bottom
- Bottom to Top
- Grid Rows
- Grid Columns
- Match Network Nodes
spacing - This is enabled by choosing any Align option other than None or Match Network Nodes. It defines the space between the children when they are being aligned.
Max per Line
alignmax - This is enabled by choosing any Align option other than None, Layout Grid Horizontal, Layout Grid Vertical, or Match Network Nodes, and defines the maximum number of children placed in one row or column.
margin - ⊞ - The four fields allow you to specify the space that surrounds the Panel Component. The margin is the space between the Panel Component's border and the outer edge.
The Margin is defined in absolute pixels and does not stretch with the window, as a result margin is not reflected in the node's panel viewer but only when the parent is drawn in a floating window.
justifymethod - ⊞ - This menu specifies if the panel's children are being justified as a group or individually using the Jusitfy Horizontal / Vertical parameters below.
individual- Align all children individually, separately from each other.
group- Align all children as a group. First group all children into a bounding box, then align that box.
justifyh - ⊞ - This menu specifies if the panel's children are being justified horizontally.
justifyv - ⊞ - This menu specifies if the panel's children are being justified vertically.
fit - ⊞ - This menu allows you to scale the panel's children. It overrides the Justify Horizontal and Justify Vertical parameters.
- Fit Width
- Fit Height
- Fit Best
scale - ⊞ - Allows you to uniformly scale the Panel's children.
offset - ⊞ - Allows you to offset the Panel's children. This parameter is overwritten by the Align, Justify Horizontal, and Justify Vertical parameters above.
crop - ⊞ - This menu determines if any children panels which are positioned partially or completely outside the panel component's dimensions get cropped.
- Off (Use Parent)
phscrollbar - ⊞ - Setting for horizontal scrollbar on this panel.
off- No scrollbar.
on- Always include scrollbar.
auto- Include scrollbar only when child width is greater than this panel's width.
pvscrollbar - ⊞ - Setting for vertical scrollbar on this panel.
off- No scrollbar.
on- Always include scrollbar.
auto- Include scrollbar only when child height is greater than this panel's height.
scrollbarthickness - Set the thickness of the scrollbars in pixels.
Parameters - Drag/Drop Page
Please refer to Drag-and-Drop for a full explanation on how Drag and Drop between Panel Components functions.
When Dragging This
drag - ⊞ - Specify if this Panel Component can be dragged.
- Use Parent's Drag Settings
dragparent- Follow the parent Panel Components Drag setting.
- Legacy Drag System
legacy- Allow Dragging for this Panel Component. Use the Paramters
Drop Destination Scriptand
Dropped Operatorto control the behaviour.
- Do Not Allow Drag
dragno- Disallows Dragging for this Panel Component.
dragscript - Specify a script that will be executed when starting to drag a Panel Component. Please refer to the Drag Script section of the Drag and Drop page.
Drop Destination Script
dropdestscript - Specify a script that will be executed when the dragged Panel Component is dropped. A temporary network is created and the component (or the alternative operator specified in Dropped Component) is copied to this network. You can add or modify operators in this network. Please refer to the Drop Destination Script section of the Drag and Drop page.
droptypescript - If a drop destination script is specified, you can also add a DAT table with a list of return types that the drop destination script will provide. Return types can be one of the op types (COMP,TOP,CHOP,SOP,MAT,DAT), channel, or supported filetypes. Please refer to the Drop Types section of the Drag and Drop page.
paneldragop - The Dropped Component parameter is the easiest way to specify an alternative operator to drop. Note that this alternative operator must exist, otherwise the component itself will be dropped. The alternative is only used when dropping onto a network or control panel. Text pasted via dragging and dropping, or files saved via dropping onto the desktop, will still use the original.
On Dropping Into
drop - ⊞ - Specify if this Panel Component accepts items that are dropped onto it.
- Use Parent's Drop Settings
dropparent- Follow the parent Panel Components Drop setting.
- Legacy Drop System
legacy- Allow Dropping onto this Panel Component. Use the Paramter
Drop Scriptto control the behaviour.
- Do Not Allow Drop
dropno- Disallows Dropping onto this Panel Component.
dropscript - A component's Drop Script is run when you drop another component or an external file into that component. Please refer to the Drop Scripts - Text section of the Drag and Drop page.
Alternatively specify a Table DAT in the drop script field. TouchDesigner will automatically look for 2 columns in the table. The first column should indicate the data type and the second should indicate the Text DAT that holds the script to process that data type. Please refer to the Drop Script - Tables section of the Drag and Drop page.
Parameters - Extensions Page
The Extensions parameter page sets the component's python extensions. Please see extensions for more information.
reinitextensions - Recompile all extension objects. Normally extension objects are compiled only when they are referenced and their definitions have changed.
Extension Object 1
extension1 - A number of class instances that can be attached to the component.
Extension Name 1
extname1 - Optional name to search by, instead of the instance class name.
Promote Extension 1
promoteextension1 - Controls whether or not the extensions are visible directly at the component level, or must be accessed through the
.ext member. Example:
Parameters - Common Page
parentshortcut - Specifies a name you can use anywhere inside the component as the path to that component. See Parent Shortcut.
opshortcut - Specifies a name you can use anywhere at all as the path to that component. See Global OP Shortcut.
Internal OP Shortcut 1
iopshortcut1 - Specifies a name you can use anywhere inside the component as a path to "Internal OP" below. See Internal Operators.
iop1 - The path to the Internal OP inside this component. See Internal Operators.
nodeview - ⊞ - Determines what is displayed in the node viewer, also known as the Node Viewer. Some options will not be available depending on the Component type (Object Component, Panel Component, Misc.)
- Default Viewer
default- Displays the default viewer for the component type, a 3D Viewer for Object COMPS and a Control Panel Viewer for Panel COMPs.
- Operator Viewer
opviewer- Displays the node viewer from any operator specified in the Operator Viewer parameter below.
opviewer - Select which operator's node viewer to use when the Node View parameter above is set to Operator Viewer.
Keep in Memory
keepmemory - Used only for Panel Components this keeps the panel in memory to it doesn't reload every time it is displayed.
enablecloning - Control if the OP should be actively cloned.
Enable Cloning Pulse
enablecloningpulse - Instantaneously clone the contents.
clone - Path to a component used as the Master Clone.
Load on Demand
loadondemand - Loads the component into memory only when required. Good to use for components that are not always used in the project.
externaltox - Path to a
.tox file on disk which will source the component's contents upon start of a
.toe. This allows for components to contain networks that can be updated independently. If the
.tox file can not be found, whatever the
.toe file was saved with will be loaded.
Reload .tox on Start
reloadtoxonstart - When on (default), the external .tox file will be loaded when the .toe starts and the contents of the COMP will match that of the external .tox. This can be turned off to avoid loading from the referenced external .tox on startup if desired (the contents of the COMP are instead loaded from the .toe file). Useful if you wish to have a COMP reference an external .tox but not always load from it unless you specifically push the Re-Init Network parameter button.
Reload Built-In Parameters
reloadbuiltin - When this checkbox is enabled, the values of the component's built-in parameters are reloaded when the .tox is reloaded.
Save Backup of External
savebackup - When this checkbox is enabled, a backup copy of the component specified by the External
.tox parameter is saved in the
.toe file. This backup copy will be used if the External
.tox can not be found. This may happen if the
.tox was renamed, deleted, or the
.toe file is running on another computer that is missing component media.
Sub-Component to Load
subcompname - When loading from an External
.tox file, this option allows you to reach into the
.tox and pull out a COMP and make that the top-level COMP, ignoring everything else in the file (except for the contents of that COMP). For example if a
.tox file named
geo1 as the Sub-Component to Load, will result in
geo1 being loaded in place of the current COMP. If this parameter is blank, it just loads the
.tox file normally using the top level COMP in the file.
reinitnet - This button will re-load from the external
.tox file (if present), followed by re-initializing itself from its master, if it's a clone.
Info CHOP Channels
Extra Information for the Parameter COMP can be accessed via an Info CHOP.
Specific Parameter COMP Info Channels
- select -
- lselect -
- mselect -
- rselect -
- reposition -
- resize -
- dragout -
- ldragout -
- mdragout -
- rdragout -
- ctrl -
- alt -
- shift -
- cmd -
- u -
- v -
- trueu -
- truev -
- rollu -
- rollv -
- dragrollu -
- dragrollv -
- dragrollover -
- rollover -
- inside -
- insideu -
- insidev -
- radio -
- lradio -
- mradio -
- rradio -
- radioname -
- lradioname -
- mradioname -
- rradioname -
- children -
- display -
- enable -
- key -
- character -
- focusselect -
- click -
- winopen -
- wheel -
- drag -
- drop -
- screenw -
- screenh -
- screenwm -
- screenhm -
Common COMP Info Channels
- num_children - Number of children in this component.
Common Operator Info Channels
- total_cooks - Number of times the operator has cooked since the process started.
- cook_time - Duration of the last cook in milliseconds.
- cook_frame - Frame number when this operator was last cooked relative to the component timeline.
- cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
- cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
- cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
- cooked_this_frame - 1 if operator was cooked this frame.
- warnings - Number of warnings in this operator if any.
- errors - Number of errors in this operator if any.