Difference between revisions of "Perform Mode"

From Derivative
Jump to navigation Jump to search
m
Tag: 2021.10000
 
(20 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
|Long=
 
|Long=
 
}}
 
}}
Perform Mode is an optimized mode for live performance that only renders a specified control panel: The rest of the TouchDesigner network editing interface is not rendered while in Perform Mode. If the TouchDesigner starts in Perform mode, the extra memory the Designer interface requires will not be allocated.
+
Perform Mode is an optimized mode for live performance that only renders a specified [[Window COMP]]. The rest of the TouchDesigner network editing interface is not rendered while in Perform Mode.  
  
A default TouchDesigner starts in [[Designer Mode]], which is where you edit your [[network]], [[Node|nodes]] and [[parameters]].  
+
== Using Perform Mode ==
 +
By default, the Window COMP <code>/perform</code> is setup to render in Perform Mode.
  
Under Dialogs -> [[Window Placement Dialog|Window Placement]], you can set a flag to start TouchDesigner in Perform Mode: After you write out the <code>.toe</code>, and anyone restarts the <code>.toe</code>, it will open only a control panel in floating window, with no networks visible.  
+
'''Enter Perform Mode''' - click the [[image:PerformButton.png|20px]] button on the left side of the [[Layout]] bar or use the F1 function key to enter Perform Mode. You will now only be able to interact with the window specified in the Window COMP.
  
When you press the Esc key with the cursor over the window, it will open the full network editing window, Designer Mode, where you can view and edit the networks.
+
'''Exit Perform Mode''' - press the '''Esc'''ape key while your cursor is over perform window to leave Perform mode and go back to the full TouchDesigner network editing interface.
  
Click the [^] icon on the left of the top Layout bar to switch to Perform Mode on the fly. Then press the Esc key over the perform window to flip back to Designer Mode.
+
== Configuration Options ==
  
The function key F1 will by default, put you into Perform Mode. F1 is a [[Macro]].
+
In the [[Window Placement Dialog|Window Placement Dialog]] you can view all [[Window COMP]]s in your project and configure them.
 +
The first column in the list, called '''Perform Window''', lets you set which Window Component will be used by default for Perform Mode. This controls which will open when using the UI Perform Mode button or pressing F1.
  
If the [[Privacy]] option is set by [[TouchDesigner Pro]] users, you cannot get into Designer Mode.
+
The settings (size, location, behavior) for the window which opens are all set in [[Window COMP]]'s parameters.  
  
NOTE: In [[Window Placement]], you configure all your [[Window Component]]s. You can use any OP type in a Window Component, but it will give you the standard controls of that OP [[Viewer]].
+
== Startup Options ==
 +
A default TouchDesigner starts in [[Designer Mode]], which is where you edit your [[network]], [[Node|nodes]] and [[parameter]]s.  
  
You can go into Perform Mode using python: <code>ui.PerformMode = True</code>. See [[UI_Class]].
+
In the [[Window Placement Dialog]], you can turn on "Start in Perform Mode" to force TouchDesigner to start in Perform Mode for this project. After changing this setting, save the project file and on restart the project will open directly into Perform Mode.
  
See also [[Designer Mode]], [[Window Placement]] and [[Window COMP]].
+
When TouchDesigner starts in Perform mode, the extra memory the Designer interface requires will not be used.
 +
 
 +
== Tips ==
 +
 
 +
[[TouchPlayer]] runs exclusively in Perform Mode. Your project's perform mode settings will determine how it runs in TouchPlayer.
 +
 
 +
If the project file has [[Privacy]] option is set, you cannot exit Perform mode back into Designer Mode.
 +
 
 +
You can also enter Perform Mode using python: <syntaxhighlight lang=python inline=True>ui.performMode = True</syntaxhighlight>. See [[UI_Class]].
 +
 
 +
 
 +
 
 +
See also [[Designer Mode]], [[Window Placement Dialog|Window Placement]] and [[Window COMP]].
 
[[Category: Touch Glossary‏‎]]
 
[[Category: Touch Glossary‏‎]]

Latest revision as of 06:13, 3 November 2020


Perform Mode is an optimized mode for live performance that only renders a specified Window COMP. The rest of the TouchDesigner network editing interface is not rendered while in Perform Mode.

Using Perform Mode[edit]

By default, the Window COMP /perform is setup to render in Perform Mode.

Enter Perform Mode - click the PerformButton.png button on the left side of the Layout bar or use the F1 function key to enter Perform Mode. You will now only be able to interact with the window specified in the Window COMP.

Exit Perform Mode - press the Escape key while your cursor is over perform window to leave Perform mode and go back to the full TouchDesigner network editing interface.

Configuration Options[edit]

In the Window Placement Dialog you can view all Window COMPs in your project and configure them. The first column in the list, called Perform Window, lets you set which Window Component will be used by default for Perform Mode. This controls which will open when using the UI Perform Mode button or pressing F1.

The settings (size, location, behavior) for the window which opens are all set in Window COMP's parameters.

Startup Options[edit]

A default TouchDesigner starts in Designer Mode, which is where you edit your network, nodes and parameters.

In the Window Placement Dialog, you can turn on "Start in Perform Mode" to force TouchDesigner to start in Perform Mode for this project. After changing this setting, save the project file and on restart the project will open directly into Perform Mode.

When TouchDesigner starts in Perform mode, the extra memory the Designer interface requires will not be used.

Tips[edit]

TouchPlayer runs exclusively in Perform Mode. Your project's perform mode settings will determine how it runs in TouchPlayer.

If the project file has Privacy option is set, you cannot exit Perform mode back into Designer Mode.

You can also enter Perform Mode using python: ui.performMode = True. See UI_Class.


See also Designer Mode, Window Placement and Window COMP.