Difference between revisions of "COMP Generator Common Page"

From TouchDesigner Documentation
Jump to: navigation, search
(Created page with "{{ParameterPage|Pagename=Common|OPfamily=COMP |Pagesummary= |items= {{ParString|OPfamily=COMP|OPtype=window|Parname=parentshortcut|Parlabel=Parent Shortcut|Parorder=0...")
 
Line 1: Line 1:
 
{{ParameterPage|Pagename=Common|OPfamily=COMP
 
{{ParameterPage|Pagename=Common|OPfamily=COMP
  
|Pagesummary=
+
|Pagesummary=The Common parameter page sets the component's [[Node Viewer|node viewer]], [[Clone|clone]] relationships, [[Parent Shortcut]], and [[Global OP Shortcut]].
 
 
 
|items=
 
|items=
  
 
 
{{ParString|OPfamily=COMP|OPtype=window|Parname=parentshortcut|Parlabel=Parent Shortcut|Parorder=0
+
{{ParString|OPfamily=COMP|OPtype=all|Parname=parentshortcut|Parlabel=Parent Shortcut|Parorder=0
 
 
|Parsummary=
 
  
 +
|Parsummary=Specifies a name you can use anywhere inside the component as the path to that component. See [[Parent Shortcut]].
 
}}
 
}}
{{ParString|OPfamily=COMP|OPtype=window|Parname=opshortcut|Parlabel=Global OP Shortcut|Parorder=1
+
{{ParString|OPfamily=COMP|OPtype=all|Parname=opshortcut|Parlabel=Global OP Shortcut|Parorder=1
 
 
|Parsummary=
 
  
 +
|Parsummary=Specifies a name you can use anywhere at all as the path to that component. See [[Global OP Shortcut]].
 
}}
 
}}
{{ParToggle|OPfamily=COMP|OPtype=window|Parname=enablecloning|Parlabel=Enable Cloning|Parorder=2
+
{{ParToggle|OPfamily=COMP|OPtype=all|Parname=enablecloning|Parlabel=Enable Cloning|Parorder=2
 
 
|Parsummary=
 
  
 +
|Parsummary=Control if the OP should be actively cloned. The Pulse button can be used to instantaneously clone the contents.
 
}}
 
}}
{{ParButton|OPfamily=COMP|OPtype=window|Parname=enablecloningpulse|Parlabel=Enable Cloning Pulse|Parorder=3
+
{{ParButton|OPfamily=COMP|OPtype=all|Parname=enablecloningpulse|Parlabel=Enable Cloning Pulse|Parorder=3
  
 
|Parsummary=
 
|Parsummary=
 
 
}}
 
}}
{{ParCompRef|OPfamily=COMP|OPtype=window|Parname=clone|Parlabel=Clone Master|Parorder=4
+
{{ParCompRef|OPfamily=COMP|OPtype=all|Parname=clone|Parlabel=Clone Master|Parorder=4
 
 
|Parsummary=
 
  
 +
|Parsummary=Path to a component used as the Master [[Clone]].
 
}}
 
}}
{{ParToggle|OPfamily=COMP|OPtype=window|Parname=loadondemand|Parlabel=Load on Demand|Parorder=5
+
{{ParToggle|OPfamily=COMP|OPtype=all|Parname=loadondemand|Parlabel=Load on Demand|Parorder=5
 
 
|Parsummary=
 
  
 +
|Parsummary=Loads the component into memory only when required. Good to use for components that are not always used in the project.
 
}}
 
}}
{{ParFilePath|OPfamily=COMP|OPtype=window|Parname=externaltox|Parlabel=External .tox|Parorder=6
+
{{ParFilePath|OPfamily=COMP|OPtype=all|Parname=externaltox|Parlabel=External .tox|Parorder=6
 
 
|Parsummary=
 
  
 +
|Parsummary=Path to a <code>.tox</code> file on disk which will source the component's contents upon start of a <code>.toe</code>. This allows for components to contain networks that can be updated independently. If the <code>.tox</code> file can not be found, whatever the <code>.toe</code> file was saved with will be loaded.
 
}}
 
}}
{{ParToggle|OPfamily=COMP|OPtype=window|Parname=reloadtoxonstart|Parlabel=Reload .tox on Start|Parorder=7
+
{{ParToggle|OPfamily=COMP|OPtype=all|Parname=reloadtoxonstart|Parlabel=Reload .tox on Start|Parorder=7
 
 
|Parsummary=
 
  
 +
|Parsummary=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.
 
}}
 
}}
{{ParToggle|OPfamily=COMP|OPtype=window|Parname=savebackup|Parlabel=Save Backup of External|Parorder=8
+
{{ParToggle|OPfamily=COMP|OPtype=all|Parname=savebackup|Parlabel=Save Backup of External|Parorder=8
 
 
|Parsummary=
 
  
 +
|Parsummary=When this checkbox is enabled, a backup copy of the component specified by the External <code>.tox</code> parameter is saved in the <code>.toe</code> file.  This backup copy will be used if the External <code>.tox</code> can not be found. This may happen if the <code>.tox</code> was renamed, deleted, or the <code>.toe</code> file is running on another computer that is missing component media.
 
}}
 
}}
{{ParString|OPfamily=COMP|OPtype=window|Parname=subcompname|Parlabel=Sub-Component to Load|Parorder=9
+
{{ParString|OPfamily=COMP|OPtype=all|Parname=subcompname|Parlabel=Sub-Component to Load|Parorder=9
 
 
|Parsummary=
 
  
 +
|Parsummary=When loading from an External <code>.tox</code> file, this option allows you to reach into the <code>.tox</code> 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 <code>.tox</code> file named <code>project1.tox</code> contains <code>project1/geo1</code>, putting <code>geo1</code> as the Sub-Component to Load, will result in <code>geo1</code> being loaded in place of the current COMP. If this parameter is blank, it just loads the <code>.tox</code> file normally using the top level COMP in the file.
 
}}
 
}}
{{ParButton|OPfamily=COMP|OPtype=window|Parname=reinitnet|Parlabel=Re-Init Network|Parorder=10
+
{{ParButton|OPfamily=COMP|OPtype=all|Parname=reinitnet|Parlabel=Re-Init Network|Parorder=10
 
 
|Parsummary=
 
  
 +
|Parsummary=This button will re-load from the external <code>.tox</code> file (if present), followed by re-initializing itself from its master, if it's a clone.
 
}}
 
}}
  
 
}}
 
}}

Revision as of 12:19, 29 September 2017