Window COMP

From Derivative
Jump to: navigation, search
  • The page "window" already exists

Summary
[edit]

The Window Component 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.

PythonIcon.pngwindowCOMP_Class


Parameters - Window Page

Operator winop - Specifies the operator the window will display.

Title title - Specify the window's title.

Location location - - 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 Monitor mainmonitor - 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 Monitor singlemonitor - Defines the location to be the monitor specified in the Monitor parameter below. The TaskBar is ignored when using this option.
  • All Monitors allmonitors - Defines the location to include all monitors. The TaskBar is ignored when using this option.

Monitor monitor - Specify the monitor index when Area is set to Single Monitor.

Justify Horizontal justifyh - -

  • Left left - Align window so that left edge coincides with left edge of specified area.
  • Center center - Align window so that horizontal center coincides with horizontal center of specified area.
  • Right right - Align window so that right edge coincides with right edge of specified area.
  • Mouse mouse - Align window so it opens horizontally centered on the mouse cursor.

Justify Vertical justifyv - -

  • Top top - Align window so that top edge coincides with top edge of specified area.
  • Center center - Align window so that vertical center coincides with vertical center of specified area.
  • Bottom bottom - Align window so that bottom edge coincides with bottom edge of specified area.
  • Mouse mouse - Align window so it opens vertically centered on the mouse cursor.

Offset winoffset - Horizontal offset applied to window after justifying.

Shift to Single Monitor single -

DPI Scaling dpiscaling - -

  • Native native -
  • Use DPI Scale usedpiscale -

Opening Size size - - Determines how the size of the window is specified by the Width, Height parameters below.

  • Automatic from COMP/TOP automatic - Determines the size automatically from the COMP/TOP specified.
  • Fill Location fill - Fills the location specified in the Location parameter above.
  • Custom custom - Use the Width and Height parameters below to specify a customer size.

Width winw - The default width of the window when not specified.

Height winh - The default height of the window when not specified.

Update Settings from Window update -

Borders borders - Controls whether or not the window contains borders and a title bar.

Include Borders in Size bordersinsize -

Always on Top alwaysontop - Controls whether or not the window always sits atop other floating windows.

Cursor Visible cursorvisible - - Controls whether or not the cursor remains visible when over this window.

  • Never nocursor -
  • When Moving cursoronmove -
  • Always alwaysvisible -

Close on Escape Key closeescape - When selected, pressing the escape key over this window will close it.

Allow Viewer Interaction interact - Enables interactions with scoped Operator.

V-Sync Mode vsyncmode - - 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.

  • Disabled disabled -
  • Enabled enabled -
  • FPS is Half Monitor Rate halfmonitorrate -

Draw Window drawwindow - 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-Lock hwframelock - Provides multi-GPU frame sync using Nvidia Gsync and AMD S400 sync cards.

OpenGL Stereo openglstereo -

Right Eye Operator winrightop -

Open as Perform Window performance - The window specified as the Perform Window is set using the 'Window Placement' dialog. This button allows opening the Window COMP as the Perform Window without changing what is currently selected as the 'real' Perform Window.

Open as Separate Window winopen - Opens this Window COMP 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.

Close winclose - Closes the window, if it's open.

Set as Perform Window setperform - Permanently changes the selection in the Window Placement dialog for the Perform Window to this window.

Window Placement Dialog opendialog - 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.

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: n.Somefunction vs n.ext.Somefunction

Extension Object 2 extension2 - A number of class instances that can be attached to the component.

Extension Name 2 extname2 - Optional name to search by, instead of the instance class name.

Promote Extension 2 promoteextension2 - 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

Extension Object 3 extension3 - A number of class instances that can be attached to the component.

Extension Name 3 extname3 - Optional name to search by, instead of the instance class name.

Promote Extension 3 promoteextension3 - 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

Extension Object 4 extension4 - A number of class instances that can be attached to the component.

Extension Name 4 extname4 - Optional name to search by, instead of the instance class name.

Promote Extension 4 promoteextension4 - 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

Re-Init Extensions reinitextensions - Recompile all extension objects. Normally extension objects are compiled only when they are referenced and their definitions have changed.


Parameters - Common Page

The Common parameter page sets the component's node viewer, clone relationships, Parent Shortcut, and Global OP Shortcut.

Parent Shortcut parentshortcut - Specifies a name you can use anywhere inside the component as the path to that component. See Parent Shortcut.

Global OP Shortcut opshortcut - Specifies a name you can use anywhere at all as the path to that component. See Global OP Shortcut.

Node View 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.

Operator Viewer opviewer - Select which operator's node viewer to use when the Node View parameter above is set to Operator Viewer.

Keep in Memory keepmemory -

Enable Cloning enablecloning - Control if the OP should be actively cloned. The Pulse button can be used to instantaneously clone the contents.

Enable Cloning Pulse enablecloningpulse -

Clone Master 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.

External .tox 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.

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 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 Network 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.


COMPs
Experimental:Actor • Ambient Light • Animation • Base • Blend • Bone • Experimental:Bullet Solver • Button • Camera Blend • Camera • Component• Experimental:Constraint • Container • Environment Light • Experimental:FBX • Field • Experimental:Force • Geometry • Handle • Experimental:Impulse Force • Light • List • Null • OP Viewer • Parameter • Experimental:Process • Replicator • Select • Shared Mem In • Shared Mem Out • Slider • Table • Time • Experimental:USD • Experimental:Widget • Window

Strictly refers to a window in Microsoft Windows. User-created windows are made with Panels inside Window Components, aside from the TouchDesigner editor window and its dialogs.

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.

Any of the procedural data operators. OPs do all the work in TouchDesigner. They "cook" and output data to other OPs, which ultimately result in new images, data and audio being generated. See Node.

Mode where the network editing window is not open, your performance interface window(s) is open and you are running your application as fast as possible. See Designer Mode.

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.

An Operator Family that creates, composites and modifies images, and reads/writes images and movies to/from files and the network. TOPs run on the graphics card's GPU.

The term "Frame" is used (1) in the Timeline, (2) as a time-unit in CHOPs, (3) as a time-unit in TOPs, and (4) with movies images which are read and created with TOPs.

The Graphics Processing Unit. This is the high-speed, many-core processor of the graphics card/chip that takes geometry, images and data from the CPU and creates images and processed data.

Any floating window that is not a Pane or Viewer.

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.

A Parent Shortcut is a parameter on a component that contains a name that you can use anywhere inside the component to refer to that component using the syntax parent.Name, for example parent.Effect.width to obtain panel width.

A name for a component that is accessible from any node in a project, which can be declared in a component's Global Operator Shortcut parameter.

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 from a CHOP is typically a 0 to 1 to 0 signal in a channel, and a pulse via python is via a .pulse() call on a pulse-type parameter, such as Reset in a Speed CHOP.

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.