The WindowComponent allows you to create and maintain a separate floating window displaying the contents of any Panel or any other Node Viewer. You create a Window component, then point it to a panel or other Operator. You turn on the Open parameter of the Window component and adjust its settings, such as resolution, centering, and which monitor it gets displayed on. You see exactly what you would see in the Node Viewer.
Windows can be fit to a single monitor, span several monitors, or several Window components can occupy one monitor.
Press Esc over a selected window to make it close.
The Window component also is used for Perform Mode, where it is most often called /perform, the default window for Perform Mode. See also Window.
Attach an Info CHOP to the Window component - it will show you the window's current location and size, and whether the window is actually open.
Operatorwinop - Specifies the operator the window will display.
Titletitle - Specify the window's title.
Locationlocation - ⊞ - All the positioning parameters below are done relative to the 'location' that you define here. Your window can span more than the specified 'area', it's just used as the reference for positioning.
Main Monitormainmonitor - The primary monitor which is sometimes referred to as the main display in Windows control panel or the primary display in the NVIDIA control panel. The Windows TaskBar is accounted for with this option, so position and sizing will not cover it up by default.
Single Monitorsinglemonitor - Defines the location to be the monitor specified in the Monitor parameter below. The TaskBar is ignored when using this option.
All Monitorsallmonitors - Defines the location to include all monitors. The TaskBar is ignored when using this option.
Monitormonitor - Specify the monitor index when Area is set to Single Monitor.
Justify Horizontaljustifyh - ⊞ -
Leftleft - Align window so that left edge coincides with left edge of specified area.
Centercenter - Align window so that horizontal center coincides with horizontal center of specified area.
Rightright - Align window so that right edge coincides with right edge of specified area.
Mousemouse - Align window so it opens horizontally centered on the mouse cursor.
Justify Verticaljustifyv - ⊞ -
Toptop - Align window so that top edge coincides with top edge of specified area.
Centercenter - Align window so that vertical center coincides with vertical center of specified area.
Bottombottom - Align window so that bottom edge coincides with bottom edge of specified area.
Mousemouse - Align window so it opens vertically centered on the mouse cursor.
Offsetwinoffset - ⊞ - Horizontal offset applied to window after justifying.
Xwinoffsetx - Horizontal offset applied to window after justifying.
Ywinoffsety - Vertical offset applied to window after justifying.
Shift to Single Monitorsingle -
DPI Scalingdpiscaling - ⊞ -
Use DPI Scaleusedpiscale -
Opening Sizesize - ⊞ - Determines how the size of the window is specified by the Width, Height parameters below.
Automatic from COMP/TOPautomatic - Determines the size automatically from the COMP/TOP specified.
Fill Locationfill - Fills the location specified in the Location parameter above.
Customcustom - Use the Width and Height parameters below to specify a customer size.
Widthwinw - The default width of the window when not specified.
Heightwinh - The default height of the window when not specified.
Update Settings from Windowupdate -
Bordersborders - Controls whether or not the window contains borders and a title bar.
Include Borders in Sizebordersinsize -
Always on Topalwaysontop - Controls whether or not the window always sits atop other floating windows.
Cursor Visiblecursorvisible - ⊞ - Controls whether or not the cursor remains visible when over this window.
When Movingcursoronmove -
Close on Escape Keycloseescape - When selected, pressing the escape key over this window will close it.
Allow Viewer Interactioninteract - Enables interactions with scoped Operator.
V-Sync Modevsyncmode - ⊞ - Controls how the window is updated with regards to V-Sync. Enabled means it will update in sync with the monitors refresh which avoids tearing and lost frames. Disabled means it can update at any point during the refresh which can result in tearing or lost frames. FPS is Half Monitor Rate should be used when doing things such as running a 30fps file on a 60Hz display. This makes each update be shown for exactly 2 refreshes which keeps motion looking smooth.
FPS is Half Monitor Ratehalfmonitorrate -
Draw Windowdrawwindow - When disabled the window will not update it's contents at all. Useful for processes that arn't doing rendering such as Audio or networking processes, or for when using VR devices.
Hardware Frame-Lockhwframelock - Provides multi-GPU frame sync using Nvidia Gsync and AMD S400 sync cards.
OpenGL Stereoopenglstereo -
Right Eye Operatorwinrightop -
Open as Perform Windowperformance - The window specified as the Perform Window is set using the 'Window Placement' dialog. This button allows opening the WindowCOMP as the Perform Window without changing what is currently selected as the 'real' Perform Window.
Open as Separate Windowwinopen - Opens this WindowCOMP as it's own window, not as the Perform Window. Useful for things such as dialog boxes or popups, but should not be used for putting final rendered content to outputs. Use a single large Perform Window for that instead of individual windows per-monitor.
Closewinclose - Closes the window, if it's open.
Set as Perform Windowsetperform - Permanently changes the selection in the Window Placement dialog for the Perform Window to this window.
Window Placement Dialogopendialog - A shortcut to open the Window Placement dialog.
Parameters - Extensions Page
The Extensions parameter page sets the component's python extensions. Please see extensions for more information.
Re-Init Extensionsreinitextensions - Recompile all extension objects. Normally extension objects are compiled only when they are referenced and their definitions have changed.
Extension Object 1extension1 - A number of class instances that can be attached to the component.
Extension Name 1extname1 - Optional name to search by, instead of the instance class name.
Promote Extension 1promoteextension1 - Controls whether or not the extensions are visible directly at the component level, or must be accessed through the .ext member. Example: n.Somefunction vs n.ext.Somefunction
Parameters - Common Page
The Common parameter page sets the component's node viewer and clone relationships.
Node Viewnodeview - ⊞ - 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 Viewerdefault - Displays the default viewer for the component type, a 3D Viewer for Object COMPS and a Control Panel Viewer for Panel COMPs.
Operator Vieweropviewer - Displays the node viewer from any operator specified in the Operator Viewer parameter below.
Operator Vieweropviewer - Select which operator's node viewer to use when the Node View parameter above is set to Operator Viewer.
Keep in Memorykeepmemory -
Enable Cloningenablecloning - Control if the OP should be actively cloned. The Pulse button can be used to instantaneously clone the contents.
Enable Cloning Pulseenablecloningpulse -
Clone Masterclone - Path to a component used as the Master Clone.
Load on Demandloadondemand - Loads the component into memory only when required. Good to use for components that are not always used in the project.
External .toxexternaltox - 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 Startreloadtoxonstart - 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 Custom Parametersreloadcustom - When this checkbox is enabled, the values of the component's Custom Parameters are reloaded when the .tox is reloaded.
Reload Built-In Parametersreloadbuiltin - When this checkbox is enabled, the values of the component's built-in parameters are reloaded when the .tox is reloaded.
Save Backup of Externalsavebackup - 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 Loadsubcompname - 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 project1.tox contains project1/geo1, putting 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.
Re-Init Networkreinitnet - 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.
Any component can be extended with its own Python classes which contain python functions and data.
The component types that are used to render 3D scenes: Geometry Component contain the 3D shapes to render, plus Camera, Light, Ambient Light, Null, Bone, Handle and other component types.
The viewer of a node can be (1) the interior of a node (the Node Viewer), (2) a floating window (RMB->View... on node), or (3) a Pane that graphically shows the results of an operator.
A custom interactive control panel built within TouchDesigner. Panels are created using Panel Components whose look is created entirely with TOPs.
To pulse a parameter is to send it a signal from a CHOP or python or a mouse click that causes a new action to occur immediately. A pulse via python is via the .pulse() function on a pulse-type parameter, such as Reset in a Speed CHOP. A pulse from a CHOP is typically a 0 to 1 to 0 signal in a channel.
Cloning can make multiple components match the contents of a master component. A Component whose Clone parameter is set will be forced to contain the same nodes, wiring and parameters as its master component. Cloning does not create new components as does the Replicator COMP.
The location of an operator within the TouchDesigner environment, for example, /geo1/torus1, a node called torus1 in a component called geo1. The path / is called Root. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.
TouchDesigner Component file, the file type used to save a Component from TouchDesigner.
TOuch Environment file, the file type used by TouchDesigner to save your project.
Every component contains a network of operators that create and modify data. The operators are connected by wires that define where data is routed after the operator cooks its inputs and generates an output.